API for managing call queue agents.
Call Queue Agents are used to assign operators to one or more Call Queues to service calls into the Find Me Module, such that the caller can be transferred to the first available Call Agent or wait in a holding queue until the next one becomes available
GET /accounts/{AccountId}/services/callqueueagents
Return a list of call queue agent entries for the specified account.
GET /accounts/services/callqueueagents/{LookupValue}
Return a specific call queue agent entry by Id.
POST /accounts/services/callqueueagents
Create a new call queue agent entry.
PUT /accounts/services/callqueueagents
Update an existing call queue agent entry.
DELETE /accounts/services/callqueueagents/{Id}
Delete the specified call queue agent entry.
Call Queues API
Call Queue Members API
Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
{
"CallQueueAgentId": 0,
"Description": "",
"Account": "",
"Enabled": false,
"Destination": "",
"CallTimeout": 0,
"EndpointType": "etNone",
"Realm": "",
"Status": "",
"MinutesToDate": 0,
"CallsToDate": 0,
"LastCallDateTime": "",
"NodeName": ""
}
Call Agents are used to assign operators to one or more Call Queues to service calls into the Find Me Module, such that the caller can be transferred to the first available Call Agent or wait in a holding queue until the next one becomes available
Field Name | Type | Size | Description |
---|---|---|---|
CALL_QUEUE_AGENT_ID | bigint | 8 | Primary key. |
DESCRIPTION | varchar | 40 | Description |
ACCOUNT | varchar | 40 | Account associated with this agent. |
ENABLED | bit | 1 | Specifies whether or not this entry is active. 0 - Disabled 1 - Enabled |
DESTINATION | varchar | 40 | Destination number used to reach this agent. |
CALL_TIMEOUT | smallint | 2 | The number of seconds to allow the destination to ring before timing out with a no answer condition. |
ENDPOINT_TYPE | tinyint | 1 | See ENDPOINT_TYPES. |
REALM | varchar | 255 | When the 'Registered Endpoint' setting is checked the system will use this REALM setting when trying to find the DESTINATION in the LOCATION_SERVICE and LOCATION_SERVICE_DETAILS table so that you can filter the lookup to one or more realms when searching for a matching entry for the DESTINATION when trying to determine if it is registered or not. Note: This entry may be set to an asterisk (*) so that the system will not filter matching registration entries to a particular realm, it may be set to a specific realm, or it may be set to a comma delimited list of realms (e.g. proxy.abc.com,proxy.acme.com,proxy.xyz.com). |
STATUS | varchar | 20 | This setting is used to determine the call agent's current status and may contain the following possible values: IDLE - Logged in and available BUSY - Logged in but not available AWAY - Logged out and not available |
NODE_NAME | varchar | 25 | For Internal Use Only when the agent has been assigned to a caller, this column will contain the node name of the Talking SIP instance the CALL_SESSION belongs to. |
INSTANCE_ID | varchar | 100 | Instance ID of the Talking SIP node associated with this entry. See ACTIVE_NODES table. |
CALL_SESSION | int | 4 | For Internal Use Only when the agent has been assigned to a caller, this column will contain the ID of the call session of that caller. |
MINUTES_TO_DATE | decimal | (15,4) | This column is used to show the number of minutes this call agent has been connected to callers from the call queue. |
CALLS_TO_DATE | int | 4 | This column is used to show the number of calls this call agent has taken from callers from the call queue. |
LAST_CALL_DATE_TIME | datetime | 4 | This column is used to show the last date and time this call agent took a call from a caller from the call queue. |