v1
latestOpenAPI 3.1.02026-07-241370148.9 KBAdd a dialer campaign
This API allows you to add a new campaign
Headers
Request body
Name of the Dialer Campaign.
Description of the Campaign.
Method with which leads get connected, valid value is 1 or 2 with the following convention ['id' => '1', 'name' => 'Preview'], ['id' => '2', 'name' => 'Ratio'],
Preview duration before dialing, mandatory field if dial method is 1.
Caller ID for the dialer campaign.
Valid value 1 or 0 for enabling or disabling setting caller id for each agent
Valid value 0 or 1 to select lead list individually for each agent
Traversal order method for lead list while dialing, value should be 1,2 or 3 with the following meaning: ['id' => '1', 'name' => 'Oldest First'], ['id' => '2', 'name' => 'Newest First'],['id' => '3', 'name' => 'Random'],
Id of script where content will be visible to only agent while dialing lead.
Id of list containing short codes that describe the outcome of calls.
Refresh Count.
Refresh Interval duration in minutes.
Wrap up time for agent in seconds.
New = 0, Undisposed = -1, Number in Account DND List = -2, Number in Public DND List = -3, Emergency = -4, Call Drop = -5, Channel Limit Reached = -6, Number in Account Block List = -7Missed By Agent = -8, Queue Missed = -9
Id of Campaign Active Time which will reflect for all agents
Id of Campaign Active Time Recording.
The call will ring on each agent for the defined seconds before trying any other agent.
Id of Quick Transfer List of the campaign.
Id of DND list set up of the campaign.
Valid value 0 or 1, enabling this will hide customer's details.
Valid value 0 or 1, enabling this will update customer's details.
Valid value 0 or 1, enabling this will allow adding automatic schedule call for the campaign.
Valid value 0 or 1, enabling this will cause hangup call for agent.
Valid value 0 or 1, enabling this will allow external transfer.
Time given to the agent after a call ends in seconds.
Valid value 0 or 1, enabling this will allow to add web form.
URL of web-form in the dialer campaign.
Id of music to be played while the calls is connecting to the agents.
Ring Strategy of Dialer Campaign, valid value is 1,2 or 3 with the following convention: ,['id' => '1', 'name' => 'Random'],['id' => '2', 'name' => 'Fewest Calls'],['id' => '3', 'name' => 'Longest Wait Time'],
Ratio in which agents will be called, mandatory field if dial method is 2.
Valid value 0 or 1, enabling this will allow transferring calls.
Lead List for Manual Dial, mandatory field if manual_dial_enabled is 1.
Id of Pause code List containing break code and name, if agent takes break specifying purpose/reason.
Individual mapping of each agent with caller id.
Individual mapping of each agent with lead list.
Agent Connection method, valid value is 1,2 or 3 with following convention: ['id' => '1', 'name' => 'Agent Mobile'], ['id' => '2', 'name' => 'Agent Extension'], ['id' => '3', 'name' => 'Both (Extension first, otherwise mobile)']
Agent Call Method, valid value is 1,2 or 3 with following convention: ['id' => '1', 'name' => 'Dial In (Session)'], ['id' => '3', 'name' => 'Dial Out (Session)'], ['id' => '2', 'name' => 'Dial Out (Each Call)']
Valid value 0 or 1, enabling this will allow callback for agent in agent panel.
Agent number in case of dial in.
Agent who gets connected and picks the inbound call.
Option while showing break codes of a list.
Valid value 0 or 1, enabling will allow manual dial for agent in agent panel.
Valid value 0 or 1, enabling will set inbound queue for the dialer campaign.
Id of queue to receive incoming calls from customer, mandatory field if enable_inbound is 1.
Valid value 0 or 1, enabling this will remove self from inbound queue in agent panel.
Lead List for inbound queue, mandatory field if enable_inbound is 1.
Valid value 0 or 1, enabling will make agent get connected to the call.
This duration in seconds will be used to qualify the call as a successful call.
Id of Welcome tune recording.
The maximum time a caller can wait in the queue before the call is redirected or disconnected.
Response
200