API Reference
Start typing to search…

Add Agent to Call Queue

post
https://{server}/ns-api/v2/domains//callqueues//agents
Path Params
string
required
length ≤ 64
Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

string
required

When used in path the callqueue value will link to a extension id for a preconfigured callqueue. If using agent actions like "login" you can use "all" to change action for all of the queues the agent is in currently, it can not be used for agent update requests.

Body Params
string
enum
Defaults to no

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

Allowed:
string
required

This is the main identifier for a "agent" in a queue. There are two format supported here, either a user based option which will look like user@domain or a device based method like sip:device@domain.

string

This is the callqueue id for which the agent is in. The agent may be in multiple callqueus, but this value is a single entry.

string
length ≤ 64

This is the domain that the token will be limited to.

string
enum

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:
integer
Defaults to 0

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.

string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
integer

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.

integer

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.

integer

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

string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string

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

integer

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

Responses

Updated 11 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago