Retrieves employee statuses.

Retrieves employee statuses

Method	`get.statuses`
API version	—
Description	Retrieves employee statuses.

Available to: Agents and clients

Request parameters

Name	Type	Required	Description
`access_token`	string	yes	Access token used to authenticate the request.
`user_id`	number	no	Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use "get.customer_users".
`limit`	number	no	Maximum number of records to return. See the "Paging" section.
`offset`	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
`filter`	object	no	Filtering criteria. See the "Filters" section.
`fields`	array	no	Fields to include in the response. See the "Viewing returned data" section.
`sort`	array	no	Sorting criteria. See the "Data sorting" section.
`is_deleted`	boolean	no	Whether to return deleted statuses. Default: false.

Response parameters

Name	Type	Valid values	Filtering	Sorting	Description
`id`	number		yes		Unique status ID.
`name`	string		yes	yes	Status name.
`mnemonic`	enum	available - available; break - on break; do_not_disturb - do not disturb; not_at_workplace - out of the office; not_at_work - not working; auto_out_call - on an outbound call; unknown - unknown	yes		Status mnemonic. Returned for standard statuses only.
`description`	string			yes	Status description.
`color`	string				HEX color code used for the status icon and related interface elements.
`is_deleted`	boolean	true, false		yes	Whether the status has been deleted.
`in_external_allowed_call_directions`	array	in - inbound; out - outbound			Allowed directions for incoming external calls.
`in_internal_allowed_call_directions`	array	in - inbound; out - outbound			Allowed directions for incoming internal calls.
`out_external_allowed_call_directions`	array	in - inbound; out - outbound			Allowed directions for outgoing external calls.
`out_internal_allowed_call_directions`	array	in - inbound; out - outbound			Allowed directions for outgoing internal calls.
`allowed_phone_protocols`	array	PSTN / SIP / SIP_TRUNK / FMC			Phone protocols allowed for calls.
`is_select_allowed`	boolean	true, false		yes	Whether users can manually select the status.
`is_worktime`	boolean	true, false		yes	Whether time in this status counts as working time.
`is_auto_out_calls_ready`	boolean	true, false		yes	Whether employees in this status are ready for automatic outbound calls.

Example request

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "get.statuses",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "offset": "number",
    "limit": "number",
    "is_deleted": "boolean",
    "filter": {},
    "sort": [
      {
        "field": "string",
        "order": "string"
      }
    ],
    "fields": [
      "string"
    ]
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {},
    "data": [
      {
        "id": "number",
        "name": "string",
        "mnemonic": "string",
        "description": "string",
        "color": "string",
        "is_deleted": "boolean",
        "in_external_allowed_call_directions": "array",
        "in_internal_allowed_call_directions": "array",
        "out_external_allowed_call_directions": "array",
        "out_internal_allowed_call_directions": "array",
        "allowed_phone_protocols": "array",
        "is_select_allowed": "boolean",
        "is_worktime": "boolean",
        "is_auto_out_calls_ready": "boolean"
      }
    ]
  }
}

Possible errors

See the "Errors for get methods" section.