v1

latestOpenAPI 3.1.02026-07-241360148.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

Name of the Dialer Campaign

descriptionstring

Description of the Campaign

dial_methodstring

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

Caller ID for the dialer campaign

agent_wise_caller_idboolean

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

agent_wise_lead_listboolean

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

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

number_of_retrystring

Refresh Count

retry_after_minutesstring

Refresh Interval duration in minutes

auto_disposition_cancel_durationstring

Wrap up time for agent in seconds

dial_statusstring[]

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

time_groupstring

Id of Campaign Active Time which will reflect for all agents

time_group_recordingstring

Id of Campaign Active Time Recording

ring_timeoutstring

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_detailsboolean

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

update_lead_detailsboolean

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

automatic_schedule_call_enabledboolean

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

enable_hangupboolean

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

enable_external_transferboolean

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_formboolean

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_transferboolean

Valid value 0 or 1, enabling this will allow transfering 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_lead_liststring

Individual mapping of each agent with lead list

connect_agent_throughstring

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

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_callbackboolean

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

agentinteger[]

Agent who gets connected and picks the inbound call

enforce_agent_pause_codeinteger

Option while showing break codes of a list

manual_dial_enabledboolean

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

enable_inboundboolean

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_outboolean

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_answerboolean

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

Response

200

object required