Availabilities

Availability JSON Format

Availability has the following keys:

Name Type Read-only Mandatory Comment
available* boolean no no The current availability status of the agent.
via string no no The channel (client/phone) the agent is registered on
status* string yes no The status of the agent. Possible values: "available", "on_call", "wrap_up", "not_available"
agent_state string no no The availability state of the agent. Possible values: "online", "offline", "away"
call_status string yes no The call status of the agent. Possible values: "on_call", "wrap_up", null

*This property will be deprecated soon.

Example
{
  "availability": {
    "via":          "phone",
    "agent_state":  "online",
    "call_status":  "wrap_up"
  }
}

Show Availability

GET /api/v2/channels/voice/availabilities/{id}.json

Allowed For
  • Agents
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/availabilities/{id}.json \
  -v -u {email_address}:{password} -X GET
Example Response
Status: 200 OK

{
  "availability": {
    "via":          "client",
    "agent_state":  "online",
    "call_status":  null
  }
}

Update Availability

PUT /api/v2/channels/voice/availabilities/{id}.json

Allowed For
  • Agents
Example Request
{
  "availability": {
    "via":          "client",
    "agent_state":  "online"
  }
}
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/availabilities/{id}.json \
  -H "Content-Type: application/json" -d '{"availability": {"via": "client", "agent_state":  "online"}}' \
  -v -u {email_address}:{password} -X PUT
Example Response
Status: 200 OK

{
  "availability": {
    "via":          "client",
    "agent_state":  "online",
    "call_status":  null
  }
}