| (6 intermediate revisions by 4 users not shown) | |||
| Line 6: | Line 6: | ||
{| | {| | ||
! Request URL | ! Request URL | ||
| − | | /api/v2/me/ | + | | /api/v2/me/channels/voice |
|- | |- | ||
| − | ! HTTP | + | ! HTTP method |
| POST | | POST | ||
|- | |- | ||
| − | ! Required | + | ! Required features |
| api-voice | | api-voice | ||
|} | |} | ||
| Line 22: | Line 22: | ||
| operationName | | operationName | ||
| NotReady | | NotReady | ||
| + | |- | ||
|} | |} | ||
==Sample== | ==Sample== | ||
===Request=== | ===Request=== | ||
| − | < | + | <source lang="text"> |
POST api/v2/me/channels/voice | POST api/v2/me/channels/voice | ||
{ | { | ||
"operationName": "NotReady" | "operationName": "NotReady" | ||
} | } | ||
| − | </ | + | </source> |
| − | === | + | ===HTTP response=== |
| − | < | + | <source lang="text"> |
{ | { | ||
"statusCode": 0 | "statusCode": 0 | ||
| + | |||
} | } | ||
| − | </ | + | </source> |
| − | === | + | ===CometD notification=== |
| − | < | + | <source lang="text"> |
{ | { | ||
"data": { | "data": { | ||
| Line 65: | Line 67: | ||
"channel": "/v2/me/devices" | "channel": "/v2/me/devices" | ||
} | } | ||
| − | </ | + | </source> |
[[Category:V:HTCC:8.5.2DRAFT]] | [[Category:V:HTCC:8.5.2DRAFT]] | ||
Latest revision as of 19:14, July 12, 2017
Not Ready
This operation is part of the Voice API section of the Web Services API.
Overview
Sets the current user to the NotReady state. NotReady 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 | NotReady |
Sample
Request
POST api/v2/me/channels/voice
{
"operationName": "NotReady"
}HTTP response
{
"statusCode": 0
}CometD notification
{
"data": {
"messageType": "DeviceStateChangeMessage",
"devices": [
{
"id": "74152ed8-858f-4a33-9e96-36213a678d30",
"deviceState": "Active",
"userState": {
"id": "900D55CC-2BB0-431F-8BF9-D3525B383BE6",
"displayName": "Not Ready",
"state": "NotReady"
},
"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 July 12, 2017, at 19:14.
Comments or questions about this documentation? Contact us for support!