Callgear

Getting a list of statuses

Method	`get.statuses`
Description	Getting a list of statuses
Available to	Agent, Client

Request parameters

Title	Type	Required	Description
`access_token`	string	yes	Authentication session key
`user_id`	number	no	Unique user identifier of the client agent on behalf of which the request is made Is required for the agent To obtain a list of client users, you must use the method "get.customer_users"
`limit`	number	no	Number of records returned. See section "Paging"
`offset`	number	no	Shift determines from which record number to return `"limit"` records. Default is "0". See section "Paging"
`filter`	object	no	See section "Filtering criteria"
`fields`	array	no	See section "View of returned data"
`sort`	array	no	See section "Sorting data"
`is_deleted`	boolean	no	Sign of status deletion. Default "false"

Response parameters

Name	Type	Valid values	Filtering	Sorting	Description
`id`	number		yes		Unique status identifier
`name`	string		yes	yes	Status name
`mnemonic`	enum	available - Available break - Break do_not_disturb - Do not disturb not_at_workplace - Out of office not_at_work - Not at work auto_out_call - Outgoing call unknown - Unknown	yes		Status mnemonic. Filled in for standard statuses only
`description`	string			yes	Status description
`color`	string				The color of the icon and other interface elements related to the status. The value is the HEX code of the color
`is_deleted`	boolean	`true`, `false`		yes	Status deletion sign
`in_external_allowed_call_directions`	array	in out			Which call directions are allowed for incoming external calls? in - incoming calls out - outgoing calls
`in_internal_allowed_call_directions`	array	in out			What call directions are allowed for incoming internal calls? in - incoming calls out - outgoing calls
`out_external_allowed_call_directions`	array	in out			Which call directions are allowed for outgoing external calls? in - incoming calls out - outgoing calls
`out_internal_allowed_call_directions`	array	in out			What call directions are allowed for outgoing internal calls? in - incoming calls out - outgoing calls
`allowed_phone_protocols`	array	PSTN SIP SIP_TRUNK FMC			Types of numbers allowed for calls
`is_select_allowed`	boolean	`true`, `false`		yes	Attribute "Ability to select status"
`is_worktime`	boolean	`true`, `false`		yes	Attribute "Working hours"
`is_auto_out_calls_ready`	boolean	`true`, `false`		yes	Sign "Ready for outgoing calls"

JSON request structure```json

{ "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" ] } }

### JSON response structure```json
{
  "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"
      }
    ]
  }
}

List of returned errors

See the section "List of errors for methods with the verb get"

Getting a list of statuses

Request parameters

Response parameters

JSON request structure```json

List of returned errors

CallGear online demo

Thank you, we've got your request!

Choose the number of employees who will use telephony

Choose the industry in which your company operates

Choose your CRM

Thanks!

Choose your region for a better connection

Account recovery