Extension call statuses (/call_status/)

The "statuses" resource allows you to create and edit statuses that can later be assigned to extensions of the phone type.

You can set a set of properties for each status, on which permissions for various types of calls depend.

Status is just a name

Properties - a fixed (by PBX developers) list of possible status properties

A list of properties can be obtained from the Status Properties resource

When analyzing properties, the broadest is taken. For example, if you create the status “Strange” with the properties “all calls” and “outgoing external”, then all calls will work.

There are predefined statuses with a predefined set of properties (created by the administrator), and it is possible for the client to create his own status by adding properties from the list of properties to it. Extension can use client statuses + global statuses

Description of data structures

Name

Type

Description

Name

Type

Description

id

long

Unique status identifier

property_list

array[string]

List of status properties. Consists of unique mnemo property identifiers that can be obtained from the Status Properties resource. Example: ["li", "lo"]

name

string

Status name

create_dt

string

Status creation time in UTC

extra_params

string

Additional information parameters in JSON format

Resources in the "Client" section

POST /client/{client_id}/extension/call_status/

Create status

URL parameters

Name

Type

Name

Type

client_id

string

Параметры JSON

Name

Type

Required

Name

Type

Required

property_list

array [string]

yes

name

string

yes

Response fields

Name

Type

Name

Type

create_dt

string

dealer_id

integer

name

string

property_list

array [string]

extra_params

object

id

integer

GET /client/{client_id}/extension/call_status/

Get a list of statuses

URL parameters

Name

Type

Name

Type

client_id

string

Response fields

Name

Type

Name

Type

create_dt

string

dealer_id

integer

name

string

property_list

array [string]

extra_params

object

id

integer

PUT /client/{client_id}/extension/call_status/{id}

Update Status

URL parameters

Name

Type

Name

Type

client_id

string

id

integer

JSON parameters

Name

Type

Required

Name

Type

Required

property_list

array [string]

no

name

string

no

Response fields

Name

Type

Name

Type

create_dt

string

dealer_id

integer

name

string

property_list

array [string]

extra_params

object

id

integer

GET /client/{client_id}/extension/call_status/{id}

Get status

URL parameters

Name

Type

Name

Type

client_id

string

id

integer

Response fields

Name

Type

Name

Type

create_dt

string

dealer_id

integer

name

string

property_list

array [string]

extra_params

object

id

integer

Resources in the "Extension" section