Skip to main content
The First Step
July 28, 2023
Question

Manual Pass API Parameters

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 replies

dakong
Community Manager
Community Manager
August 8, 2023

Hi @Tad Schilke (P),

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

The First Step
August 9, 2023

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

dakong
Community Manager
Community Manager
August 10, 2023

@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.

dakong
Community Manager
Community Manager
August 29, 2023

@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.