Availabilities

Represents the availability state of an agent and call status.

JSON Format

Availabilities are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
agent_state string false false The availability state of the agent. Allowed values are "online", "offline" or "away".
call_status string false false The call status of the agent. Allowed values are "on_call", "wrap_up" or "null".
via string false false The channel (client/phone) the agent is registered to
Example
{
  "agent_state": "online",
  "call_status": "wrap_up",
  "via": "phone"
}

Show Availability

  • GET /api/v2/channels/voice/availabilities/{agent_id}
Allowed For
  • Agents
Parameters
Name Type In Required Description
agent_id integer Path true ID of an agent
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/availabilities/{agent_id}.json \
-v -u {email_address}:{password} -X GET
Example Response
Status 200 OK

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

Update Availability

  • PUT /api/v2/channels/voice/availabilities/{agent_id}
Allowed For
  • Agents
Parameters
Name Type In Required Description
agent_id integer Path true ID of an agent
Example Body
{
  "availability": {
    "agent_state": "online",
    "via": "client"
  }
}
Using curl
curl https://{subdomain}.zendesk.com/api/v2/channels/voice/availabilities/{agent_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": {
    "agent_state": "online",
    "via": "client"
  }
}