Add an Inbound Queue

Sample Request

curl --request POST \
     --url https://api-smartflo.tatateleservices.com/v1/dialer/inbound_queue \
     --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 new inbound queue:

Variable Name	Description	Data Type
name*	Name of the Inbound Queue	string
description	“What is this inbound queue for” message	string
ring_strategy*	Ring Strategy of Inbound Queue, valid values are 1,2 or 3 with the following convention: ,['id' => '1', 'name' => 'Random'],['id' => '2', 'name' => 'Fewest Calls'],['id' => '3', 'name' => 'Longest Wait Time'],	string
queue_timeout*	Time for which the queue will run	string
failover_destination*	Destination in case call is not picked, valid format is 'type\|id'. For example: hangup\|\|1, dialer_queue\|\|id, voicemail\|\|id	string
music_on_hold	To be played while the calls is connecting to the agents, should be a valid id	string
failover_music	It will play if no one picks up the call, leave blank for default message, else should be a valid id	string
agent_ring_timeout*	The call will ring on each agent for the defined seconds before trying any other agent	string
sla_duration	This duration will be used to identify if the call was connected to the agent within the specified SLA or outside it	string
agent*	Agent who gets connected and picks the inbound call	string
sticky_agent*	Functionality to choose if same agent gets connected	boolean
sticky_time_format	Days or hours, mandatory field if sticky_time_format is 1. Valid values are 1 and 2. ['id' => '1', 'name' => 'HOURS', 'max' => 24], ['id' => '2', 'name' => 'DAYS', 'max' => 10]	string
sticky_time_period	Duration of sticky_agent time in days, mandatory field if sticky_time_format is 1	string
callback_customer	Enabling this will callback customer at the same queue position if customer has pressed the selected dtmf before call hangup	boolean
callback_threshold_time	Time after which the callback can be activated, mandatory field if callback_customer is 1.	string
callback_dtmf	DTMF for enabling queue callback, mandatory field if callback_customer is 1, valid values are 0-9	string
callback_threshold_recording	Id of recording to be played to customer after callback threshold is reached,mandatory field if callback_customer is 1	string
call_hangup_recording	Recording to be played to customer on hangup after activating callback	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