Read Agents in Domain

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200OK

application/json

Body

array of:

callqueue-agent-id

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.

Examples:

1000@domainsip:1001@domain.com

callqueue

string

optional

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.

Example:

3000

domain

string

optional

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

<= 64 characters

Examples:

example.commyDomaintest.12123

Match pattern:

^[A-Za-z0-9._-]+|\*

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-has-registered-devices

enum<string>

read-onlyoptional

This read only status will show the agents registration infor and if the system believes the device is registered.

Allowed values:

yesnopush-enabledoffnet

callqueue-agent-availability-for-dispatch

string

optional

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

active-calls-total-current

integer

read-onlyoptional

This is the total number of calls on the agent's account across all their queues

last-modified-datetime

string <date-time>

read-onlyoptional

This timestamp is the datetime of the last change to the agent's configuration and status

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.

last-callqueue-dispatch-datetime

string <date-time> | null

read-onlyoptional

This timestamp is the datetime of the last dispatch to the agent.

callqueue-agent-entry-type

enum<string>

read-onlyoptional

This is a read only field that will tell you the type of agent config that is setup, this might include device or user based agents or "offnet"

Allowed values:

deviceuseroffnet

string

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's login if needed.

name-full-name

string

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's full name.

agent-name-first-name

string

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's first name.

agent-name-last-name

string

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's last name.

agent-department

string

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's depeartment.

agent-site

string

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's site

agent-user-scope

string

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's scope.

agent-status-message

string | null

read-onlyoptional

This value read only from the user that is linked to this agent. Its the user's status message.

Example

[
  {
    "callqueue-agent-id": "1000@domain",
    "callqueue": "3000",
    "domain": "example.com",
    "callqueue-agent-availability-type": "automatic",
    "callqueue-agent-wrap-up-allowance-seconds": 0,
    "auto-answer-enabled": "no",
    "callqueue-agent-dispatch-order-ordinal": 0,
    "callqueue-agent-dispatch-queue-priority-ordinal": 0,
    "limits-max-active-calls-total": 0,
    "callqueue-agent-answer-confirmation-enabled": "no",
    "callqueue-agent-has-registered-devices": "yes",
    "callqueue-agent-availability-for-dispatch": "string",
    "active-calls-total-current": 0,
    "last-modified-datetime": "2019-08-24T14:15:22Z",
    "callqueue-agent-max-concurrent-sms-conversations": 0,
    "last-callqueue-dispatch-datetime": "2019-08-24T14:15:22Z",
    "callqueue-agent-entry-type": "device",
    "login-username": "string",
    "name-full-name": "string",
    "agent-name-first-name": "string",
    "agent-name-last-name": "string",
    "agent-department": "string",
    "agent-site": "string",
    "agent-user-scope": "string",
    "agent-status-message": "string"
  }
]

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Request

Request samples

Responses