Welcome to the RingCentral Community

Make sure to review our Terms of Use and Community Guidelines.

Please note the community is currently under maintenance and is read-only.

Home » Developers

Manual Pass API Parameters

Tags: Engage Digital and Engage Voice

Jul 28, 2023 at 7:50am • 4 replies • 0 likes

Tad Schilke (P)

Our organization is trying to create an API call which, when called, will locate an alternate lead in a campaign and perform a manual pass. Details on the MANUAL_LEADS leadAction are sparse on the developer page. Can anyone provide the available elements of the paramMap for the MANUAL_LEADS action? We have the below but are looking to include the agent performing the manual pass as well as agent notes.

  "leadActionParams"
  :{
   

   "paramMap"
  :{
   

   "PASS_DISPOSITION"
  :
  "Sample Disposition"
  ,

   "REQUEUE"
  :
  "false"
  ,

   "DO_NOT_CALL"
  :
  "false"
  ,

   "PASS_DELAY"
  :
  0
  ,

   "MERGE_ORIGINAL"
  :
  "true"
  

   }
}
 

4 Answers

Da Kong answered on Aug 28, 2023 at 6:23pm

@Tad Schilke (P)

Sorry for the delayed response. Here's what I get from the dev:

MANUAL_LEADS doesn't support AGENT_NOTES.

However, another endpoint is used to perform it:

PUT [https://engage.ringcentral.com/voice/api/](https://engage.ringcentral.com/voice/api/v1/admin/accounts/accountId/campaignLeads/actions)v1/admin/accounts/{accountId:[0-9]+}/dialGroups/{dialGroupId:[0-9]+}/campaigns/{campaignId}/leads/{leadId}/passes/{passUii}/agentNotesAndDisposition

which takes agentDisposition and agentNotes as query params or form data params.

Da Kong answered on Aug 9, 2023 at 6:57pm

@Tad Schilke (P) Let me double check with the corresponding dev. He's on holidays at the moment. I'll get back to you in a few days.

Tad Schilke (P) answered on Aug 9, 2023 at 9:05am

The UI is able to do a manual pass with agent notes; is this done outside of an API call?

Da Kong answered on Aug 7, 2023 at 8:42pm

Hi @Tad Schilke (P),

That's all the params for current paramMap under MANUAL_LEADS.

A new Community is coming to RingCentral!

Posts are currently read-only as we transition into our new platform.

We thank you for your patience
during this downtime.

Try Workflow Builder

Did you know you can easily automate tasks like responding to SMS, team messages, and more? Plus it's included with RingCentral Video and RingEX plans!

Try RingCentral Workflow Builder

PRODUCTS
RingEX
Message
Video
Phone

OPEN ECOSYSTEM
Developer Platform
APIs
Integrated Apps
App Gallery
Developer support
Games and rewards

RESOURCES
Resource center
Blog
Product Releases
Accessibility

QUICK LINKS
App Download
RingCentral App login
Admin Portal Login
Contact Sales