Sample Request

curl --request POST \
     --url https://api-smartflo.tatateleservices.com/v1/dialer/campaign \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Body Params)

The following parameter is required to add a dialer campaign:

Variable Name	Description	Data Type
name*	Name of the Dialer Campaign.	string
description	Description of the Campaign	string
dial_method*	Method with which leads get connected, valid value is 1 or 2 with the following convention ['id' => '1', 'name' => 'Preview'], ['id' => '2', 'name' => 'Ratio'],	string
auto_dial_duration	Preview duration before dialing, mandatory field if dial method is 1	string
outbound_caller_id*	Caller ID for the dialer campaign	string
agent_wise_caller_id	Valid value 1 or 0 for enabling or disabling setting caller id for each agent	integer
lead_list_map	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},...]	array of object
agent_wise_lead_list	Valid value 0 or 1 to select lead list individually for each agent	integer
list_traversal_order	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'],	string
agent_script	Id of script where content will be visible to only agent while dialing lead	string
disposition_list*	Id of list containing short codes that describe the outcome of calls	string
number_of_retry*	Refresh Count	string
retry_after_minutes*	Refresh Interval duration in minutes	string
auto_disposition_cancel_duration*	Wrap up time for agent in seconds	string
dial_status*	Dial Status of the campaign	array of strings
time_group	Id of Campaign Active Time which will reflect for all agents	string
time_group_recording	Id of Campaign Active Time Recording	string
ring_timeout*	The call will ring on each agent for the defined seconds before trying any other agent	string
quick_transfer_list	Id of Quick Transfer List of the campaign	string
account_dnd_list	Id of DND list set up of the campaign	string
hide_lead_details*	Valid value 0 or 1,enabling this will hide customer's details	integer
update_lead_details*	Valid value 0 or 1, enabling this will update customer's details	integer
automatic_schedule_call_enabled	Valid value 0 or 1, enabling this will allow adding automatic schedule call for the campaign	integer
enable_hangup	Valid value 0 or 1, enabling this will cause hangup call for agent	integer
enable_external_transfer	Valid value 0 or 1, enabling this will allow external transfer	integer
after_call_work_duration	Time given to the agent after a call ends in seconds	string
enable_web_form	Valid value 0 or 1, enabling this will allow to add web form	integer
webform_url	URL of web-form in the dialer campaign	string
music_on_hold	Id of music to be played while the calls is connecting to the agents	string
ring_strategy	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'],	string
dial_ratio	Ratio in which agents will be called, mandatory field if dial method is 2	string
enable_transfer	Valid value 0 or 1, enabling this will allow transfering calls	integer
manual_lead_list	Lead List for Manual Dial, mandatory field if manual_dial_enabled is 1	array of strings
break_list	Id of Pause code List containing break code and name, if agent takes break specifying purpose/reason	string
map_agent_caller_id	Individual mapping of each agent with caller id	string
map_agent_lead_list	Individual mapping of each agent with lead list	string
connect_agent_through	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)']	string
dial_in_type*	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)']	string
agent_only_callback*	Valid value 0 or 1, enabling this will allow callback for agent in agent panel	integer
agent_dial_in_number	Agent number in case of dial in	string
agent*	Agent who gets connected and picks the inbound call	array of int32s
enforce_agent_pause_code	Option while showing break codes of a list	int32
manual_dial_enabled	Valid value 0 or 1, enabling will allow manual dial for agent in agent panel	integer
enable_inbound	Valid value 0 or 1, enabling will set inbound queue for the dialer campaign	integer
inbound_queue	Id of queue to receive incoming calls from customer, mandatory field if enable_inbound is 1.	string
enable_agent_opt_out	Valid value 0 or 1, enabling this will remove self from inbound queue in agent panel	integer
inbound_lead_list	Lead List for inbound queue, mandatory field if enable_inbound is 1.	string
enable_auto_answer	Valid value 0 or 1, enabling will make agent get connected to the call	integer
call_qualification_duration	This duration in seconds will be used to qualify the call as a successful call	string
announcement_recording	Id of Welcome tune recording	string
queue_timeout	The maximum time a caller can wait in the queue before the call is redirected or disconnected.	string

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
Success	The request success status, the possible values are: True (default) for success. False for failure.	Boolean
Message	The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.	String