Sign in

v1

latestOpenAPI 3.1.02026-07-241370148.9 KB

Update a particular dialer campaign

This API allows you to update the dialer campaign details

put/v1/dialer/campaign/{id}

Path parameters

idstring required

Headers

Authorizationstring required

Request body

namestring required

Name of the Dialer Campaign.

descriptionstring

Description of the Campaign.

dial_methodstring required

Method with which leads get connected, valid value is 1 or 2 with the following convention ['id' => '1', 'name' => 'Preview'], ['id' => '2', 'name' => 'Ratio'],

auto_dial_durationstring

Preview duration before dialing, mandatory field if dial method is 1.

outbound_caller_idstring required

Caller ID for the dialer campaign. It should accept the unique ID of the DID, which the customer can obtain using the "Fetch My Number Details" API.

agent_wise_caller_idinteger

Valid value 1 or 0 for enabling or disabling setting caller id for each agent

agent_wise_lead_listinteger

Valid value 0 or 1 to select lead list individually for each agent

list_traversal_orderstring

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'],

agent_scriptstring

Id of script where content will be visible to only agent while dialing lead.

disposition_liststring required

Id of list containing short codes that describe the outcome of calls.

number_of_retrystring required

Refresh Count.

retry_after_minutesstring required

Refresh Interval duration in minutes.

auto_disposition_cancel_durationstring required

Wrap up time for agent in seconds.

dial_statusstring[] required

Dial Status of the campaign. "New" is indicated by "0" in dial status. For Example: "dial_status": ["0"] will set the dial status as "NEW"

time_groupstring

Id of Campaign Active Time which will reflect for all agents

time_group_recordingstring

Id of Campaign Active Time Recording.

ring_timeoutstring required

The call will ring on each agent for the defined seconds before trying any other agent.

quick_transfer_liststring

Id of Quick Transfer List of the campaign.

account_dnd_liststring

Id of DND list set up of the campaign.

hide_lead_detailsinteger required

Valid value 0 or 1, enabling this will hide customer's details.

update_lead_detailsinteger required

Valid value 0 or 1, enabling this will update customer's details.

automatic_schedule_call_enabledinteger

Valid value 0 or 1, enabling this will allow adding automatic schedule call for the campaign.

enable_hangupinteger

Valid value 0 or 1, enabling this will cause hangup call for agent.

enable_external_transferinteger

Valid value 0 or 1, enabling this will allow external transfer.

after_call_work_durationstring

Time given to the agent after a call ends in seconds.

enable_web_forminteger

Valid value 0 or 1, enabling this will allow to add web form.

webform_urlstring

URL of web-form in the dialer campaign.

music_on_holdstring

Id of music to be played while the calls is connecting to the agents.

ring_strategystring

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'],

dial_ratiostring

Ratio in which agents will be called, mandatory field if dial method is 2.

enable_transferinteger

Valid value 0 or 1, enabling this will allow transferring calls.

manual_lead_liststring[]

Lead List for Manual Dial, mandatory field if manual_dial_enabled is 1.

break_liststring

Id of Pause code List containing break code and name, if agent takes break specifying purpose/reason.

map_agent_caller_idstring

Individual mapping of each agent with caller id.

map_agent_caller_liststring

Individual mapping of each agent with lead list.

connect_agent_throughstring required

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)']

dial_in_typestring required

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)']

agent_only_callbackinteger required

Valid value 0 or 1, enabling this will allow callback for agent in agent panel.

agent_dial_in_numberstring

Agent number in case of dial in.

agentstring[] required

Agent who gets connected and picks the inbound call. It is required to add the User ID.

enforce_agent_pause_codestring

Option while showing break codes of a list.

manual_dial_methodinteger

Valid value 0 or 1, enabling will allow manual dial for agent in agent panel.

enable_inboundinteger

Valid value 0 or 1, enabling will set inbound queue for the dialer campaign.

inbound_queuestring

Id of queue to receive incoming calls from customer, mandatory field if enable_inbound is 1.

enable_agent_opt_outinteger

Valid value 0 or 1, enabling this will remove self from inbound queue in agent panel.

inbound_lead_liststring

Lead List for inbound queue, mandatory field if enable_inbound is 1.

enable_auto_answerinteger

Valid value 0 or 1, enabling will make agent get connected to the call.

call_qualification_durationstring

This duration in seconds will be used to qualify the call as a successful call.

announcement_recordingstring

Id of Welcome tune recording.

queue_timeoutstring

The maximum time a caller can wait in the queue before the call is redirected or disconnected.

Response

200

object required