Aux Work
This operation is part of the Voice API section of the Web Services API.
Overview
Sets the current user to the NotReady state with a workmode of AuxWork. AuxWork is a system-defined agent state operation and is always available for use.
Request URL | /api/v2/me/channels/voice |
---|---|
HTTP method | POST |
Required features | api-voice |
Parameters
Parameter | Value |
---|---|
operationName | AuxWork |
Sample
Request
POST api/v2/me/channels/voice
{
"operationName": "AuxWork"
}
HTTP response
{
"statusCode": 0
}
CometD notification
{
"data": {
"messageType": "DeviceStateChangeMessage",
"devices": [
{
"id": "74152ed8-858f-4a33-9e96-36213a678d30",
"deviceState": "Active",
"userState": {
"id": "2B36138D-C564-4562-A8CB-3C32D564F296",
"displayName": "AuxWork",
"state": "NotReady",
"workMode": "AuxWork"
},
"phoneNumber": "5000",
"e164Number": "5000",
"telephonyNetwork": "Private",
"doNotDisturb": "Off",
"voiceEnvironmentUri": "http://127.0.0.1:8080/api/v2/voice-environments/370ef5e6-9e3c-4d91-9588-7f4dfe67e011",
"capabilities": [
"ForwardCallsOn"
]
}
]
},
"channel": "/v2/me/devices"
}
This page was last edited on May 19, 2017, at 17:15.
Comments or questions about this documentation? Contact us for support!