Update Agent in Call Queue

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

domain

string

required

Example:

callqueue

string

required

Example:

2032

callqueue-agent-id

string

required

Body Params application/json

callqueue-agent-availability-type

enum<string>

optional

This is the main toggle for the agents status in the queue. "automatic" is logged in, which manual is logged out with the option for one call. From a angent perspective and the actions of logging in and out the recomention would be to use the specific "agent actions" api instead of the basic agent update request.

Allowed values:

automaticmanualdisabledoffnet-automatic

callqueue-agent-wrap-up-allowance-seconds

integer

optional

This is the number of seconds that the system will hold the agent offline before logging them back in automatically. This time allows the agent to comolete needed notes and conclusions to previous calls and prepare for next call.

Default:

auto-answer-enabled

enum<string>

optional

When enabled it will send the calls to this agent with the auto answer request headers in place.

Allowed values:

yesno

Default:

callqueue-agent-dispatch-order-ordinal

integer

optional

For use in callqueues that have a linear order, this value would be to the order of the agent in that list, the lower the number the higher agent in the order.

callqueue-agent-dispatch-queue-priority-ordinal

integer

optional

This setting is a priority value for this agent's entry with respect to the other callqueues they are in. Lower number is higher priority. This means that when the agent comes back available after a call the priority would be used to determine which queue its attempted first.

limits-max-active-calls-total

integer

optional

This is the maximum number of calls an agent will be given at at time. Default and ideal is 1, but if needed it can be higher

callqueue-agent-answer-confirmation-enabled

enum<string>

optional

When enabled the system will require the agent to press a DTMF kwy to accept the call. This is important when ringing offner where call might go to remove voicemail boxes.

Allowed values:

yesno

Default:

callqueue-agent-availability-for-dispatch

string

optional

This is the status for the agent generated by the system using all available informaion.

callqueue-agent-max-concurrent-sms-conversations

integer

optional

This is the maximum number of SMS queue sessions the agent will be requested to handle before queing up future requests.

Example

{
  "callqueue-agent-answer-confirmation-enabled": "no",
  "callqueue-agent-availability-type": "manual",
  "callqueue-agent-wrap-up-allowance-seconds": 10,
  "auto-answer-enabled": "yes"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request samples

Responses