v1

latestOpenAPI 3.1.02026-07-241370148.9 KB

Update Inbound Queue

This API allows you to update a particular inbound queue.

put/v1/dialer/inbound_queue/{id}

Path parameters

idstring required

Headers

Authorizationstring required

Request body

namestring required

Name of the Inbound Queue.

descriptionstring

“What is this inbound queue for” message.

ring_strategystring required

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

queue_timeoutstring required

Time for which the queue will run.

failover_destinationstring required

Destination in case call is not picked, valid format is 'type|id'. For example: hangup||1, dialer_queue||id, voicemail||id

music_on_holdstring

To be played while the calls is connecting to the agents, should be a valid id.

failover_musicstring

It will play if no one picks up the call, leave blank for default message, else should be a valid id.

agent_ring_timeoutstring required

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

sla_durationstring

This duration will be used to identify if the call was connected to the agent within the specified SLA or outside it.

agentstring required

Agent who gets connected and picks the inbound call.

sticky_agentboolean required

Functionality to choose if same agent gets connected.

sticky_time_formatstring

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]

sticky_time_periodstring

Duration of sticky_agent time in days, mandatory field if sticky_time_format is 1.

callback_customerboolean

Enabling this will callback customer at the same queue position if customer. has pressed the selected dtmf before call hangup

callback_threshold_timestring

Time after which the callback can be activated, mandatory field if callback_customer is 1.

callback_dtmfstring

DTMF for enabling queue callback, mandatory field if callback_customer is 1, valid values are 0-9

callback_threshold_recordingstring

Id of recording to be played to customer after callback threshold is reached,mandatory field if callback_customer is 1

call_hangup_recordingstring

Recording to be played to customer on hangup after activating callback.

Response

200

object required