Ready

This operation is part of the Voice API section of the Web Services API.

Overview

Sets the current user to the Ready state. Ready 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	Ready
workmode	This optional parameter specifies which workmode is applied to the Ready operation. Valid values are ManualIn and AutoIn.
wrapUpTime	This parameter specifies the amount of wrap-up time (in seconds) allocated to the agent at the end of a business call.

Sample

Request

POST /api/v2/me/channels/voice
{
  "operationName": "Ready"
  "wrapUpTime": "0"
}

HTTP response

{
  "statusCode": 0
}

CometD notification

{
  "data": {
    "messageType": "DeviceStateChangeMessage",
    "devices": [
      {
        "id": "74152ed8-858f-4a33-9e96-36213a678d30",
        "deviceState": "Active",
        "userState": {
          "id": "9430250E-0A1B-421F-B372-F29E69366DED",
          "displayName": "Ready",
          "state": "Ready"
        },
        "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"
}