name

string

Client name

Yes

dealer_id

integer

Client dealer ID. The dealer defines general settings for all his clients, such as routing rules, various limits, dial rules, preferred media servers, and others.

Yes

domain_id

integer

Client domain ID. All client extensions have numbers in the format client_prefix*extension_name@client_domain.

Yes

email

string

Client email address

Yes

prefix

string

Client prefix. All client extensions have numbers in the format. client_prefix*extension_name@client_domain. Read only.

-

-

id

integer

Unique client id. Read only.

-

-

create_date

string

Creation date of the client in the format: YYYY-MM-DD HH:MM:SS. Read only.

-

-

extension_len

integer(2,3,4)

The length of client extension numbers. Can be 2, 3, or 4. Cannot be changed after the client has been created.

No

3

status

string("active", "blocked")

Client status. Can take the values active and blocked. If the blocked status is set, the client cannot receive and make calls, register, and use the REST API.

No

active

timezone

string

Client Time Zone

No

Time Zone of the system

presence

string("yes","no")

Enable (value yes) or disable (value no) the presence service for the client. If the service is enabled, сlient extensions can subscribe to the events of the presence and dialog.

No

no

sbc_mode

string("yes","no")

Enable (value yes) or disable (value no) sbc mode for the client. If SBC mode is enabled, media data for the client extensions will go through the same address as SIP messages. SBC mode can be used when the client's firewall only allows connection to one address. If the field value is null, the dealer setting is used.

No

null

routing_list_id

integer

Id of the list of routing rules for outgoing client calls. If value is null, the dealer's routing list will be used.

No

null

short_local_caller_id

string("yes","no")

Using a short caller ID number for calls between client extensions. If the setting is enabled (value yes), then when making calls from an extension client to another extension of the same client, the From field will contain the short name of the extension without the client prefix (100@sip.ringme.ru) instead of full extension name (000*100@sip.ringme.ru).

No

no

language

string("ru","en")

Client language. Sound files of voicemail greetings, translation, conference control sounds are played in the client's language. If value is null, the PBX's global installation language is used.

No

null

disk_quota

integer

Disk quota in bytes for storing conversation records, voicemail messages, and incoming fax messages. When the quota is exhausted, conversations will not be recorded, voice messages will be saved, and faxes will not be received.

No

0

reg_limit

integer

The limit on the number of simultaneous registrations of one client extension. A value of 0 means that each new registration will cancel the previous one, with values ​​greater than zero, when the registration limit is reached, new ones will be rejected.

No

0

calls_limit

integer

The limit on the number of simultaneous client calls. If null, the dealer's limit will be used.

No

null

extension_limit

integer

The limit on the number of client extensions. If null, the global limit is used.

No

null

extension_group_limit

integer

The limit on the number of extension groups. If null, the global limit is used.

No

null

sound_limit

integer

The limit on the number of sound files uploaded by the client. If null, the global limit is used.

No

null

extension_agent_limit

integer

The limit on the number of queue agents per client extension. If null, the global limit is used.

No

null

remote_agent_limit

integer

The limit on the number of external queue agents. If null, the global limit is used.

No

null

ivr_rule_limit

integer

The limit on the number of rules in one IVR context option. If null, the global limit is used.

No

null

ivr_option_limit

integer

The limit on the number of options in one IVR context option. If null, the global limit is used.

No

null

ivr_context_limit

integer

The limit on the number of contexts in one extension of type IVR. If null, the global limit is used.

No

null

incom_rule_limit

integer

The limit on the number of incoming call rules per extension. If null, the global limit is used.

No

null

dial_rule_limit

integer

The limit on the number of client dial rules. If null, the global limit is used.

No

null

user_extension_limit

integer

The limit on the number of users of type "extension". If null, the global limit is used.

No

null

user_extension_group_limit

integer

The limit on the number of users of type "extension group". If null, the global limit is used.

No

null

user_client_limit

integer

The limit on the number of users of type "client". If null, the global limit is used.

No

null

interval_limit

integer

The limit on the number of client time intervals. If null, the global limit is used.

No

null

event_limit

integer

The limit on the number of event handlers per extension. If null, the global limit is used.

No

null

application_limit

integer

The limit on the number of client API applications. If null, the global limit is used.

No

null

network_permission_limit

integer

The limit on the number of network permission lists, which are used for authorization and registration of extensions with network and both authorization types. If null, the global limit is used.

No

null

hidden_json

string

A string field where any information about the client can be stored, for example, about the services connected to him. The field is not available to the client.

No

null

hidden_comment

string

Comment about the client. Can be used to save any information about the client. The field is not available to the client.

No

null

extra_params

string

A string field for any additional information about the client. This field is read-only for the client.

No

null

type

string("J","F")

Client type, information field. The F value means an individual, the J value means a legal entity.

No

F

ambassadors

string

Contact persons of the client, information field.

No

null

contact_phones

string

Contact phone numbers of the client, information field.

No

null

jur_address

string

Legal address of the client, information field.

No

null

geo_list

string

Specifies a list of countries whose IP addresses are allowed to use a SIP account. Countries are listed in ISO 3166 Codes A2 format, for example: "RU US BY". If the list is not specified, then the value defined by the service provider is used. If the list has the value "*", then all countries are allowed and the service provider parameter is ignored

No

null

fact_address

string

The actual address of the client, information field.

No

null

blind_transfer_return

boolean

It is used to avoid call loss during “blind transfer”. Works only for calls within one PBX. All "blind transfers" within the PBX between the phone terminal will be returned if this parameter is set to true and in case of failure. However, for the best user experience, it is recommended to use "attended transfer" instead of “blind transfer”.

If the specified bl_xfer_return_timeout parameter is missing, the call will return by the timeout (hangup_timeout) of the phone terminal to which the “blind transfer” was made.

No

null

bl_xfer_return_timeout

long

Only if blink_transfer_return is set to true this timeout will be parsed, otherwise this parameter will be ignored. If blink_transfer_return is set to true and bl_xfer_return_timeout is specified in seconds - when blindly transferring to a phone terminal, its timeout (hangup_timeout) will be ignored, instead it the value bl_xfer_return_timeout will be used.

No

null

outg_call_VR_on_fail

boolean

It is used for voice notification of the result of a call during an outgoing call. If there are no specified codes in outg_call_VR_code_list, nothing will be played.

No

null

outg_call_VR_code_list

string

This list will only be used when outg_call_VR_on_fail is set to true. The list must contain comma-separated error interpretations (Enumiration).

Example: “USER_BUSY,NO_USER_RESPONSE,NO_ANSWER”

No

null

extension_len

array [integer]

dealer_id

array [integer]

name

array [string]

domain_id

array [integer]

routing_list_id

array [integer]

id

array [integer]

prefix

array [string]

order_by

string

per_page

integer

type

array [string]

order

string

page

integer

client_id

integer

client_id

integer

client_id

integer

delete_dids

boolean

false