Add a dialer campaign

post https://api.servetel.in/v1/dialer/campaign

This API allows you to add a new campaign

Body Params

name

string

required

Name of the Dialer Campaign.

description

string

Description of the Campaign.

dial_method

string

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_duration

string

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

outbound_caller_id

string

required

Caller ID for the dialer campaign.

agent_wise_caller_id

boolean

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

lead_list_map

array of objects

Select lead lists and their status, can select upto 3 active lead lists in the format [{list_id:1234,list_status:1},{list_id:1235,list_status:0},...]

lead_list_map

agent_wise_lead_list

boolean

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

list_traversal_order

string

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_script

string

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

disposition_list

string

required

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

number_of_retry

string

required

Refresh Count.

retry_after_minutes

string

required

Refresh Interval duration in minutes.

auto_disposition_cancel_duration

string

required

Wrap up time for agent in seconds.

dial_status

array of strings

required

Dial Status of the campaign.

dial_status*

time_group

string

Id of Campaign Active Time which will reflect for all agents

time_group_recording

string

Id of Campaign Active Time Recording.

ring_timeout

string

required

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

quick_transfer_list

string

Id of Quick Transfer List of the campaign.

account_dnd_list

string

Id of DND list set up of the campaign.

hide_lead_details

boolean

required

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

update_lead_details

boolean

required

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

automatic_schedule_call_enabled

boolean

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

enable_hangup

boolean

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

enable_external_transfer

boolean

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

after_call_work_duration

string

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

enable_web_form

boolean

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

webform_url

string

URL of web-form in the dialer campaign.

music_on_hold

string

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

ring_strategy

string

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_ratio

string

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

enable_transfer

boolean

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

manual_lead_list

array of strings

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

manual_lead_list

break_list

string

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

map_agent_caller_id

string

Individual mapping of each agent with caller id.

map_agent_caller_list

string

Individual mapping of each agent with lead list.

connect_agent_through

string

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_type

string

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_callback

boolean

required

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

agent_dial_in_number

string

Agent number in case of dial in.

agent

array of strings

required

Agent who gets connected and picks the inbound call.

agent*

enforce_agent_pause_code

string

Option while showing break codes of a list.

manual_dial_method

boolean

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

enable_inbound

boolean

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

inbound_queue

string

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

enable_agent_opt_out

boolean

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

inbound_lead_list

string

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

enable_auto_answer

boolean

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

call_qualification_duration

string

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

announcement_recording

string

Id of Welcome tune recording.

Headers

Authorization

string

required

Responses

Language


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.servetel.in/v1/dialer/campaign \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "hide_lead_details": true,
8
  "update_lead_details": true,
9
  "agent_only_callback": true
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400