Client

`PUT /client/client_info/{client_id}/`

Update client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`hold_music`	`integer`	Music on hold sound id.
`call_interactive_out_call`	`boolean`	Default: False
`call_interactive_url`	`string`	Call interactive url.
`sip_network_permission_id`	`integer`
`timezone`	`string`
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`call_interactive_method`	`string`	Call interactive method. One of 'GET', 'POST'. Default: GET
`dial_rule_id`	`integer`
`call_interactive_timeout`	`integer`	Call interactive timout.
`geo_list`	`string`

Resource fields

Name	Type	Description
`domain`	`string`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`sip_network_permission_id`	`integer`
`disk_space_notify_threshold`	`integer`
`prefix`	`string`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`id`	`integer`	Resource id.
`domain_prefix`	`string`
`contact_phones`	`string`
`name`	`string`
`timezone`	`string`	Default: Europe/Moscow
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`reg_status_log`	`boolean`
`fact_address`	`string`
`call_interactive_url`	`string`
`extension_len`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`jur_address`	`string`
`language`	`string`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`extra_params`	`string`
`call_interactive_timeout`	`integer`

`GET /client/client_info/{client_id}/`

Get client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`domain`	`string`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`sip_network_permission_id`	`integer`
`disk_space_notify_threshold`	`integer`
`prefix`	`string`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`id`	`integer`	Resource id.
`domain_prefix`	`string`
`contact_phones`	`string`
`name`	`string`
`timezone`	`string`	Default: Europe/Moscow
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`reg_status_log`	`boolean`
`fact_address`	`string`
`call_interactive_url`	`string`
`extension_len`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`jur_address`	`string`
`language`	`string`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`extra_params`	`string`
`call_interactive_timeout`	`integer`

`POST /client/{client_id}/agent/local/`

Add new agent

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	Agent status. One of 'logged_out', 'available'. Default: available
`agent_sound_id`	`integer`
`name`	`string`	Required. Agent name.
`busy_delay_time`	`integer`	If the agent is on do not disturb, we wait this defined time before trying him again. Default: 10
`no_answer_delay_time`	`integer`	If the agent does not answer the call, we wait this defined time before trying him again. Default: 10
`call_timeout`	`integer`	Agent call timeout.
`wrap_up_time`	`integer`	Allow an agent to have a delay when finishing a call before receiving another one. Default: 0
`extension_id`	`integer`	Required. Agent extension id.
`reject_delay_time`	`integer`	If the agent press the reject on their phone, we wait this defined time amount. Default: 10
`extra_params`	`string`

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/local/`

Get agents list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`extension_id`	`array [integer]`

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/agent/local/{agent_id`}

Update agent

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	Agent status. One of 'logged_out', 'available'.
`agent_sound_id`	`integer`
`name`	`string`	Agent name.
`busy_delay_time`	`integer`	If the agent is on do not disturb, we wait this defined time before trying him again.
`no_answer_delay_time`	`integer`	If the agent does not answer the call, we wait this defined time before trying him again.
`call_timeout`	`integer`	Agent call timeout.
`wrap_up_time`	`integer`	Allow an agent to have a delay when finishing a call before receiving another one.
`reject_delay_time`	`integer`	If the agent press the reject on their phone, we wait this defined time amount.
`extra_params`	`string`

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/local/{agent_id`}

Get agent by id

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/agent/local/{agent_id`}

Delete agent

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

Query parameters

Name	Type	Description
`remove_from_queues`	`boolean`	Default: True

`POST /client/{client_id}/agent/local/{agent_id}/event/`

Add agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`url`	`string`	Required. Request url.
`event_type`	`string`	Required. Call event type. One of 'agent-login', 'agent-logout'.
`method`	`string`	Required. Http request method. One of 'GET', 'POST'.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/local/{agent_id}/event/`

Get agent http events

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/agent/local/{agent_id}/event/{event_id`}

Update agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.
`event_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`url`	`string`	Request url.
`event_type`	`string`	Call event type. One of 'agent-login', 'agent-logout'.
`method`	`string`	Http request method. One of 'GET', 'POST'.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/local/{agent_id}/event/{event_id`}

Get agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.
`event_id`	`integer`	Required.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/agent/local/{agent_id}/event/{event_id`}

Delete agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.
`event_id`	`integer`	Required.

`POST /client/{client_id}/agent/remote/`

Add new agent

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	Agent status. One of 'logged_out', 'available'. Default: available
`agent_sound_id`	`integer`
`name`	`string`	Required. Agent name.
`busy_delay_time`	`integer`	If the agent is on do not disturb, we wait this defined time before trying him again. Default: 10
`no_answer_delay_time`	`integer`	If the agent does not answer the call, we wait this defined time before trying him again. Default: 10
`call_timeout`	`integer`	Agent call timeout.
`number`	`string`	Required. Agent number.
`wrap_up_time`	`integer`	Allow an agent to have a delay when finishing a call before receiving another one. Default: 0
`reject_delay_time`	`integer`	If the agent press the reject on their phone, we wait this defined time amount. Default: 10
`extra_params`	`string`

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`number`	`string`
`wrap_up_time`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/remote/`

Get agents list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`number`	`string`
`wrap_up_time`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/agent/remote/{agent_id`}

Update agent

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	Agent status. One of 'logged_out', 'available'.
`agent_sound_id`	`integer`
`name`	`string`	Agent name.
`busy_delay_time`	`integer`	If the agent is on do not disturb, we wait this defined time before trying him again.
`no_answer_delay_time`	`integer`	If the agent does not answer the call, we wait this defined time before trying him again.
`call_timeout`	`integer`	Agent call timeout.
`number`	`string`	Agent number.
`wrap_up_time`	`integer`	Allow an agent to have a delay when finishing a call before receiving another one.
`reject_delay_time`	`integer`	If the agent press the reject on their phone, we wait this defined time amount.
`extra_params`	`string`

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`number`	`string`
`wrap_up_time`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/remote/{agent_id`}

Get agent by id

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`number`	`string`
`wrap_up_time`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/agent/remote/{agent_id`}

Delete agent

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

Query parameters

Name	Type	Description
`remove_from_queues`	`boolean`	Default: True

`POST /client/{client_id}/agent/remote/{agent_id}/event/`

Add agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`url`	`string`	Required. Request url.
`event_type`	`string`	Required. Call event type. One of 'agent-login', 'agent-logout'.
`method`	`string`	Required. Http request method. One of 'GET', 'POST'.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/remote/{agent_id}/event/`

Get agent http events

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/agent/remote/{agent_id}/event/{event_id`}

Update agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.
`event_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`url`	`string`	Request url.
`event_type`	`string`	Call event type. One of 'agent-login', 'agent-logout'.
`method`	`string`	Http request method. One of 'GET', 'POST'.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/agent/remote/{agent_id}/event/{event_id`}

Get agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.
`event_id`	`integer`	Required.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/agent/remote/{agent_id}/event/{event_id`}

Delete agent http event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`agent_id`	`integer`	Required.
`event_id`	`integer`	Required.

`GET /client/{client_id}/alias/`

Get alias list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`name`	`array [string]`
`domain`	`array [string]`
`extension_id`	`array [integer]`

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`create_date`	`string`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/alias/{alias_id`}

Update alias

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`alias_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`extension_id`	`integer`

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`create_date`	`string`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`id`	`integer`	Resource id.

`GET /client/{client_id}/alias/{alias_id`}

Get alias

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`alias_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`create_date`	`string`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/ani/`

Update client ani

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`ani_number`	`string`	Required. Client ani.

Resource fields

Name	Type	Description
`default`	`string`

`GET /client/{client_id}/ani/`

Get client ani

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

Resource fields

Name	Type	Description
`default`	`string`

`POST /client/{client_id}/call_center/report/`

Create report

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`start_datetime`	`string`	Required. Start datetime.
`queue_id`	`array [integer]`
`emails`	`string`	Required.
`end_datetime`	`string`	Required. End datetime.

Resource fields

Name	Type	Description
`start_datetime`	`string`
`queue_id`	`array [integer]`
`emails`	`string`
`end_datetime`	`string`

`PUT /client/{client_id}/client/`

Update client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`hold_music`	`integer`	Music on hold sound id.
`call_interactive_out_call`	`boolean`	Default: False
`call_interactive_url`	`string`	Call interactive url.
`sip_network_permission_id`	`integer`
`timezone`	`string`
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`call_interactive_method`	`string`	Call interactive method. One of 'GET', 'POST'. Default: GET
`dial_rule_id`	`integer`
`call_interactive_timeout`	`integer`	Call interactive timout.
`geo_list`	`string`

Resource fields

Name	Type	Description
`domain`	`string`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`sip_network_permission_id`	`integer`
`disk_space_notify_threshold`	`integer`
`prefix`	`string`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`id`	`integer`	Resource id.
`domain_prefix`	`string`
`contact_phones`	`string`
`name`	`string`
`timezone`	`string`	Default: Europe/Moscow
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`reg_status_log`	`boolean`
`fact_address`	`string`
`call_interactive_url`	`string`
`extension_len`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`jur_address`	`string`
`language`	`string`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`extra_params`	`string`
`call_interactive_timeout`	`integer`

`GET /client/{client_id}/client/`

Get client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`domain`	`string`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`sip_network_permission_id`	`integer`
`disk_space_notify_threshold`	`integer`
`prefix`	`string`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`id`	`integer`	Resource id.
`domain_prefix`	`string`
`contact_phones`	`string`
`name`	`string`
`timezone`	`string`	Default: Europe/Moscow
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`reg_status_log`	`boolean`
`fact_address`	`string`
`call_interactive_url`	`string`
`extension_len`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`jur_address`	`string`
`language`	`string`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`extra_params`	`string`
`call_interactive_timeout`	`integer`

`GET /client/{client_id}/current_calls/`

Get active calls for extension type phone

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`call_list`	`array [call_mdl]`

Resource call_mdl

Name	Type	Description
`called_number`	`string`
`record_uuid`	`string`
`init_time_gmt`	`string`
`real_call`	`boolean`	Default: True
`call_flow`	`string`
`called_did`	`string`
`callback_id`	`string`
`caller_id_name`	`string`
`call_api_id`	`string`
`extension_id`	`integer`
`answer_time_gmt`	`string`
`caller_id_number`	`string`

`POST /client/{client_id}/dial_rule/`

Add client dial rule list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`dial_rules`	`array [dial_rule]`	Required.
`name`	`string`	Required.

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`name`	`string`

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`GET /client/{client_id}/dial_rule/`

Get client dial rule lists list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`name`	`string`

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`PUT /client/{client_id}/dial_rule/{dial_rules_id`}

Update client dial rule list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`dial_rules_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`name`	`string`

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`name`	`string`

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`GET /client/{client_id}/dial_rule/{dial_rules_id`}

Get client dial rule list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`dial_rules_id`	`integer`	Required.

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`name`	`string`

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`DELETE /client/{client_id}/dial_rule/{dial_rules_id`}

Delete client dial rule list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`dial_rules_id`	`integer`	Required.

`GET /client/{client_id}/did/`

Get did list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`name`	`array [string]`
`domain`	`array [string]`
`extension_id`	`array [integer]`
`message_extension_id`	`array [integer]`

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`create_date`	`string`
`message_extension_id`	`integer`
`extension_id`	`integer`
`client_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`PUT /client/{client_id}/did/{did_id`}

Update did

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`did_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`extension_id`	`integer`
`message_extension_id`	`integer`

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`create_date`	`string`
`message_extension_id`	`integer`
`extension_id`	`integer`
`client_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`GET /client/{client_id}/did/{did_id`}

Get did

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`did_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`create_date`	`string`
`message_extension_id`	`integer`
`extension_id`	`integer`
`client_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`POST /client/{client_id}/extension/`

Add extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	One of 'active', 'blocked'. Default: blocked
`dial_rule_limit`	`integer`
`name`	`string`	Required.
`extra_params`	`string`
`label`	`string`
`caller_id_name`	`string`
`extension_group_id`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`type`	`string`	Required. One of 'phone', 'queue', 'ivr', 'fax', 'conference'.
`did_as_transfer_caller_id`	`string`	One of 'None', 'default', 'from', 'diversion'.

Resource fields

Name	Type	Description
`status`	`string`
`domain`	`string`
`create_date`	`string`
`name`	`string`
`extra_params`	`string`
`extension_group_id`	`integer`
`ani`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_limit`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`type`	`string`
`id`	`integer`	Resource id.
`did_as_transfer_caller_id`	`string`

`GET /client/{client_id}/extension/`

Get extension list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [string]`
`name`	`array [string]`
`type`	`array [string]`
`status`	`array [string]`
`extension_group_id`	`array [string]`

Resource fields

Name	Type	Description
`status`	`string`
`domain`	`string`
`create_date`	`string`
`name`	`string`
`extra_params`	`string`
`extension_group_id`	`integer`
`ani`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_limit`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`type`	`string`
`id`	`integer`	Resource id.
`did_as_transfer_caller_id`	`string`

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

Post client extension call status

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`property_list`	`array [string]`	Required.
`name`	`string`	Required.

Resource fields

Name	Type	Description
`create_dt`	`string`
`dealer_id`	`integer`
`name`	`string`
`property_list`	`array [string]`
`extra_params`	`object`
`id`	`integer`	Resource id.

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

Get client extension call status list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`create_dt`	`string`
`dealer_id`	`integer`
`name`	`string`
`property_list`	`array [string]`
`extra_params`	`object`
`id`	`integer`	Resource id.

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

Update client extension call status

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

JSON parameters

Name	Type	Description
`property_list`	`array [string]`
`name`	`string`

Resource fields

Name	Type	Description
`create_dt`	`string`
`dealer_id`	`integer`
`name`	`string`
`property_list`	`array [string]`
`extra_params`	`object`
`id`	`integer`	Resource id.

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

Get client extension call status

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

Resource fields

Name	Type	Description
`create_dt`	`string`
`dealer_id`	`integer`
`name`	`string`
`property_list`	`array [string]`
`extra_params`	`object`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/extension/call_status/{id`}

Delete client extension call status

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

`PUT /client/{client_id}/extension/{extension_id`}

Update extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`extension_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	One of 'active', 'blocked'.
`dial_rule_limit`	`integer`
`extra_params`	`string`
`label`	`string`
`caller_id_name`	`string`
`extension_group_id`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`did_as_transfer_caller_id`	`string`	One of 'None', 'default', 'from', 'diversion'.

Resource fields

Name	Type	Description
`status`	`string`
`domain`	`string`
`create_date`	`string`
`name`	`string`
`extra_params`	`string`
`extension_group_id`	`integer`
`ani`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_limit`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`type`	`string`
`id`	`integer`	Resource id.
`did_as_transfer_caller_id`	`string`

`GET /client/{client_id}/extension/{extension_id`}

Get extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`extension_id`	`integer`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`domain`	`string`
`create_date`	`string`
`name`	`string`
`extra_params`	`string`
`extension_group_id`	`integer`
`ani`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_limit`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`type`	`string`
`id`	`integer`	Resource id.
`did_as_transfer_caller_id`	`string`

`DELETE /client/{client_id}/extension/{extension_id`}

Delete extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`extension_id`	`integer`	Required.

`POST /client/{client_id}/extension_group/`

Add extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`name`	`string`	Required.
`extra_params`	`string`

Resource fields

Name	Type	Description
`name`	`string`
`id`	`integer`	Resource id.
`client_id`	`integer`
`extra_params`	`string`

`GET /client/{client_id}/extension_group/`

Get extension group list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`id`	`array [string]`
`name`	`array [string]`

Resource fields

Name	Type	Description
`name`	`string`
`id`	`integer`	Resource id.
`client_id`	`integer`
`extra_params`	`string`

`PUT /client/{client_id}/extension_group/{ext_group_id`}

Update extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`ext_group_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`name`	`string`
`extra_params`	`string`

Resource fields

Name	Type	Description
`name`	`string`
`id`	`integer`	Resource id.
`client_id`	`integer`
`extra_params`	`string`

`GET /client/{client_id}/extension_group/{ext_group_id`}

Get extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`ext_group_id`	`integer`	Required.

Resource fields

Name	Type	Description
`name`	`string`
`id`	`integer`	Resource id.
`client_id`	`integer`
`extra_params`	`string`

`DELETE /client/{client_id}/extension_group/{ext_group_id`}

Delete extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`ext_group_id`	`integer`	Required.

`DELETE /client/{client_id}/fax/in/`

Delete incoming fax messages in interval

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Start datetime.
`end_datetime`	`string`	End datetime.

`GET /client/{client_id}/fax/in/{fax_uuid`}

Get incoming fax message

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`fax_uuid`	`string`	Required.

`DELETE /client/{client_id}/fax/in/{fax_uuid`}

Delete record

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`fax_uuid`	`string`	Required.

`POST /client/{client_id}/interval/`

Add interval

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`timezone`	`string`	Required. Interval timezone.
`conditions`	`array [condition]`	Required. Datetime conditions.
`name`	`string`	Required. Interval name.

Resource condition

Name	Type	Description
`start_datetime`	`string`	Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.
`start_dow`	`integer`	Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.
`sched_skip_days`	`integer`	Min: 1.
`sched_start_date`	`string`	Start datetime formatted as yyyy-mm-dd.
`month`	`integer`	Month. Min: 1. Max: 12.
`end_dow`	`integer`	End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.
`sched_active_days`	`integer`	Min: 1.
`end_mday`	`integer`	End month day. Min: 1. Max: 31.
`start_mday`	`integer`	Start month day. Min: 1. Max: 31.
`end_time`	`string`	End time of day.
`start_time`	`string`	Start time of day.
`end_datetime`	`string`	End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

Resource fields

Name	Type	Description
`dealer_id`	`integer`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`timezone`	`string`
`conditions`	`array [interval_condition]`
`id`	`integer`	Resource id.

Resource interval_condition

Name	Type	Description
`start_datetime`	`string`
`start_dow`	`integer`	Start day of week sun = 1, mon = 2, etc.
`sched_skip_days`	`integer`	Min: 1.
`sched_start_date`	`string`	Start datetime formatted as yyyy-mm-dd.
`month`	`integer`
`end_dow`	`integer`	End day of week sun = 1, mon = 2, etc.
`sched_active_days`	`integer`	Min: 1.
`end_mday`	`integer`
`start_mday`	`integer`
`end_time`	`string`
`type`	`string`
`start_time`	`string`
`end_datetime`	`string`

`GET /client/{client_id}/interval/`

Get interval list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`dealer_id`	`integer`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`timezone`	`string`
`conditions`	`array [interval_condition]`
`id`	`integer`	Resource id.

Resource interval_condition

Name	Type	Description
`start_datetime`	`string`
`start_dow`	`integer`	Start day of week sun = 1, mon = 2, etc.
`sched_skip_days`	`integer`	Min: 1.
`sched_start_date`	`string`	Start datetime formatted as yyyy-mm-dd.
`month`	`integer`
`end_dow`	`integer`	End day of week sun = 1, mon = 2, etc.
`sched_active_days`	`integer`	Min: 1.
`end_mday`	`integer`
`start_mday`	`integer`
`end_time`	`string`
`type`	`string`
`start_time`	`string`
`end_datetime`	`string`

`PUT /client/{client_id}/interval/{interval_id`}

Update interval

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`interval_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`timezone`	`string`	Required. Interval timezone.
`conditions`	`array [condition]`	Required. Datetime conditions.
`name`	`string`	Required. Interval name.

Resource condition

Name	Type	Description
`start_datetime`	`string`	Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.
`start_dow`	`integer`	Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.
`sched_skip_days`	`integer`	Min: 1.
`sched_start_date`	`string`	Start datetime formatted as yyyy-mm-dd.
`month`	`integer`	Month. Min: 1. Max: 12.
`end_dow`	`integer`	End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.
`sched_active_days`	`integer`	Min: 1.
`end_mday`	`integer`	End month day. Min: 1. Max: 31.
`start_mday`	`integer`	Start month day. Min: 1. Max: 31.
`end_time`	`string`	End time of day.
`start_time`	`string`	Start time of day.
`end_datetime`	`string`	End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

Resource fields

Name	Type	Description
`dealer_id`	`integer`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`timezone`	`string`
`conditions`	`array [interval_condition]`
`id`	`integer`	Resource id.

Resource interval_condition

Name	Type	Description
`start_datetime`	`string`
`start_dow`	`integer`	Start day of week sun = 1, mon = 2, etc.
`sched_skip_days`	`integer`	Min: 1.
`sched_start_date`	`string`	Start datetime formatted as yyyy-mm-dd.
`month`	`integer`
`end_dow`	`integer`	End day of week sun = 1, mon = 2, etc.
`sched_active_days`	`integer`	Min: 1.
`end_mday`	`integer`
`start_mday`	`integer`
`end_time`	`string`
`type`	`string`
`start_time`	`string`
`end_datetime`	`string`

`GET /client/{client_id}/interval/{interval_id`}

Get interval

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`interval_id`	`integer`	Required.

Resource fields

Name	Type	Description
`dealer_id`	`integer`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`timezone`	`string`
`conditions`	`array [interval_condition]`
`id`	`integer`	Resource id.

Resource interval_condition

Name	Type	Description
`start_datetime`	`string`
`start_dow`	`integer`	Start day of week sun = 1, mon = 2, etc.
`sched_skip_days`	`integer`	Min: 1.
`sched_start_date`	`string`	Start datetime formatted as yyyy-mm-dd.
`month`	`integer`
`end_dow`	`integer`	End day of week sun = 1, mon = 2, etc.
`sched_active_days`	`integer`	Min: 1.
`end_mday`	`integer`
`start_mday`	`integer`
`end_time`	`string`
`type`	`string`
`start_time`	`string`
`end_datetime`	`string`

`DELETE /client/{client_id}/interval/{interval_id`}

Delete interval

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`interval_id`	`integer`	Required.

`GET /client/{client_id}/limit/`

Get client limits

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`disk_quota`	`integer`	Default: 0
`ivr_option_limit`	`integer`
`dial_rule_limit`	`integer`
`user_extension_group_limit`	`integer`
`extension_agent_limit`	`integer`
`ivr_rule_limit`	`integer`
`sound_limit`	`integer`
`application_limit`	`integer`
`user_client_limit`	`integer`
`extension_group_limit`	`integer`
`user_extension_limit`	`integer`
`calls_limit`	`integer`
`network_permission_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`event_limit`	`integer`
`extension_limit`	`integer`
`incom_rule_limit`	`integer`
`ivr_context_limit`	`integer`
`reg_limit`	`integer`	Default: 0

`POST /client/{client_id}/network_permission/`

Add network permission group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`network_address`	`array [string]`	Network_address/mask list.
`name`	`string`	Required.

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

`GET /client/{client_id}/network_permission/`

Get network permission group list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

`PUT /client/{client_id}/network_permission/{group_id`}

Update network permission group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`group_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`network_address`	`array [string]`	Network_address/mask list.
`name`	`string`

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

`GET /client/{client_id}/network_permission/{group_id`}

Get network permission group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`group_id`	`integer`	Required.

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

`DELETE /client/{client_id}/network_permission/{group_id`}

Delete network permission group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`group_id`	`integer`	Required.

`GET /client/{client_id}/oauth/session/`

Get active oauth sessions

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`user_id`	`array [integer]`

Resource fields

Name	Type	Description
`expires`	`string`
`user_id`	`integer`
`app_id`	`string`
`id`	`string`	Resource id.

`DELETE /client/{client_id}/oauth/session/{session_id`}

Delete session

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`session_id`	`string`	Required.

`PUT /client/{client_id}/phone_event/{id`}

Update client event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

JSON parameters

Name	Type	Description
`url`	`string`	Request url.
`event_type`	`string`	Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'voicemail'.
`method`	`string`	Http request method. One of 'GET', 'POST'.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/phone_event/{id`}

Get client event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/phone_event/{id`}

Delete client event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

`POST /client/{client_id}/phone_events/`

Add client phone event

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`url`	`string`	Required. Request url.
`event_type`	`string`	Required. Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'voicemail'.
`method`	`string`	Required. Http request method. One of 'GET', 'POST'.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/phone_events/`

Get client event list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/phone_events/`

Delete all client events

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

`GET /client/{client_id}/record/`

Get record list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`start_datetime`	`string`	Required. Start datetime.
`end_datetime`	`string`	Required. End datetime.
`order`	`string`	Datetime sorting order. One of 'desc', 'asc'. Default: desc

Resource fields

Name	Type	Description
`to_username`	`string`
`source_number`	`string`
`result`	`string`
`duration`	`integer`
`hangup_time_gmt`	`string`
`to_domain`	`string`
`record_file_size`	`integer`
`calls_result`	`string`
`from_username`	`string`
`calls_hangup_disposition`	`string`
`ani_number`	`string`
`application`	`string`
`start_time_gmt`	`string`
`ext_number_reg`	`string`
`hangup_cause`	`string`
`hangup_disposition`	`string`
`extension_group_owner_id`	`integer`
`init_time_gmt`	`string`
`source_domain`	`string`
`dest_domain`	`string`
`record_uuid`	`string`
`from_domain`	`string`
`call_uuid`	`string`
`extension_type`	`string`
`did_domain`	`string`
`from_screen_name`	`string`
`extension_name`	`string`
`flow`	`string`
`dest_number`	`string`
`extension_id`	`integer`
`did_number`	`string`
`client_owner_id`	`integer`

`DELETE /client/{client_id}/record/`

Delete records in interval

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Required. Start datetime.
`end_datetime`	`string`	Required. End datetime.
`extension_id`	`array [integer]`	Extension id.

`POST /client/{client_id}/record/archive/`

Get record archive

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`start_datetime`	`string`	Required. Start datetime.
`extension_id`	`array [integer]`
`email`	`string`	Required.
`end_datetime`	`string`	Required. End datetime.

Resource fields

Name	Type	Description
`start_datetime`	`string`
`extension_id`	`array [integer]`
`archive_uuid`	`string`
`email`	`string`
`end_datetime`	`string`

`GET /client/{client_id}/record/stats/`

Get record statistics list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Required. Start datetime.
`end_datetime`	`string`	Required. End datetime.

Resource fields

Name	Type	Description
`files_size`	`integer`
`records_count`	`integer`

`GET /client/{client_id}/record/{record_uuid`}

Get record

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`record_uuid`	`string`	Required.

`DELETE /client/{client_id}/record/{record_uuid`}

Delete record

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`record_uuid`	`string`	Required.

`GET /client/{client_id}/record/{record_uuid}/download/`

Get record with basic http authentication

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`record_uuid`	`string`	Required.

`GET /client/{client_id}/record/{record_uuid}/path/`

Get ftp record path

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`record_uuid`	`string`	Required.

`GET /client/{client_id}/record/{record_uuid}/storage_url/`

Get record storage url

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`record_uuid`	`string`	Required.

`POST /client/{client_id}/sound/`

Add sound

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Form parameters

Name	Type	Description
`title`	`string`	Required. Sound title.
`file`	`file`	Required.

Resource fields

Name	Type	Description
`title`	`string`	Sound title.
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`filename`	`string`

`GET /client/{client_id}/sound/`

Get sound list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`title`	`array [string]`
`own_only`	`boolean`

Resource fields

Name	Type	Description
`title`	`string`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`filename`	`string`

`GET /client/{client_id}/sound/search/`

Client sounds search

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`title`	`array [string]`
`own_only`	`boolean`
`q`	`string`

Resource fields

Name	Type	Description
`total_count`	`integer`

`PUT /client/{client_id}/sound/{sound_id`}

Update sound

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`sound_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`title`	`string`	Sound title.

Resource fields

Name	Type	Description
`title`	`string`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`filename`	`string`

`POST /client/{client_id}/sound/{sound_id`}

Update sound file

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`sound_id`	`integer`	Required.

Form parameters

Name	Type	Description
`title`	`string`	Sound title.
`file`	`file`	Required.

Resource fields

Name	Type	Description
`title`	`string`	Sound title.
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`filename`	`string`

`GET /client/{client_id}/sound/{sound_id`}

Get sound

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`sound_id`	`integer`	Required.

Resource fields

Name	Type	Description
`title`	`string`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`filename`	`string`

`DELETE /client/{client_id}/sound/{sound_id`}

Delete sound

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`sound_id`	`integer`	Required.

`GET /client/{client_id}/sound/{sound_id}/download/`

Get sound file

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`sound_id`	`integer`	Required.

`POST /client/{client_id}/task_scheduler/`

Add task scheduler

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`
`status`	`string`	One of 'on', 'off'. Default: off
`concurrent_task_limit`	`integer`
`name`	`string`	Required.
`interval_id`	`integer`

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`	One of 'off', 'on'. Default: off
`name`	`string`
`concurrent_task_limit`	`integer`
`interval_id`	`integer`
`create_date_utc`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/task_scheduler/{scheduler_id`}

Update scheduler

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`scheduler_id`	`string`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`
`status`	`string`	One of 'on', 'off'. Default: off
`concurrent_task_limit`	`integer`
`interval_id`	`integer`

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`	One of 'off', 'on'. Default: off
`name`	`string`
`concurrent_task_limit`	`integer`
`interval_id`	`integer`
`create_date_utc`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/task_scheduler/{scheduler_id`}

Get task scheduler by id for

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`scheduler_id`	`string`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`	One of 'off', 'on'. Default: off
`sched_task_count`	`integer`
`name`	`string`
`concurrent_task_limit`	`integer`
`interval_id`	`integer`
`last_call_date`	`string`
`task_count`	`integer`
`create_date_utc`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id`}

Get client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`scheduler_id`	`string`	Required.
`task_id`	`integer`	Required.

Resource fields

Name	Type	Description
`status`	`string`	One of 'scheduled', 'executed', 'delayed', 'finished'. Default: scheduled
`try_again_pause`	`integer`
`url_success`	`string`
`b_number`	`string`
`url_before_again`	`string`
`scheduler_id`	`integer`
`start_time_utc`	`string`
`variables`	`object`
`url_before`	`string`
`finish_result`	`string`	One of 'success', 'failed'.
`a_number`	`string`
`callback_params`	`object`
`try_count`	`integer`	Default: 1
`extension_id`	`integer`
`cdr`	`string`
`url_after`	`string`
`finish_comment`	`string`
`global_expires`	`integer`	Default: 86400
`create_date_utc`	`string`
`id`	`integer`	Resource id.
`name`	`string`

`POST /client/{client_id}/task_scheduler/{scheduler_id}/tasks/`

Add list of tasks

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`scheduler_id`	`string`	Required.

JSON parameters

Name	Type	Description
`tasks`	`array [task_args]`	Required.

Resource task_args

Name	Type	Description
`try_again_pause`	`integer`
`url_success`	`string`
`name`	`string`
`start_time_utc`	`string`
`variables`	`object`
`url_before`	`string`
`a_number`	`string`
`callback_params`	`object`
`url_before_again`	`string`
`extension_id`	`integer`
`b_number`	`string`
`url_after`	`string`
`global_expires`	`integer`	Default: 86400
`try_count`	`integer`	Default: 1

Resource fields

Name	Type	Description
`tasks`	`array [task_res]`

Resource task_res

Name	Type	Description
`status`	`string`	One of 'scheduled', 'executed', 'delayed', 'finished'. Default: scheduled
`try_again_pause`	`integer`
`url_success`	`string`
`b_number`	`string`
`url_before_again`	`string`
`scheduler_id`	`integer`
`start_time_utc`	`string`
`variables`	`object`
`url_before`	`string`
`finish_result`	`string`	One of 'success', 'failed'.
`a_number`	`string`
`callback_params`	`object`
`try_count`	`integer`	Default: 1
`extension_id`	`integer`
`cdr`	`string`
`url_after`	`string`
`finish_comment`	`string`
`global_expires`	`integer`	Default: 86400
`create_date_utc`	`string`
`id`	`integer`	Resource id.
`name`	`string`

`POST /client/{client_id}/user/client/`

Add new user client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`	User email.
`status`	`string`	User status. One of 'active', 'blocked'.
`name`	`string`	Required. User name.
`email_notify`	`boolean`	Send email with access data for new user. Default: False
`access`	`string`	User access type. One of 'full', 'read_only'.
`extra_params`	`string`	User extra params.
`timezone`	`string`	User timezone.
`login`	`string`	Required. User login.
`password`	`string`	Required. User password.
`email_for_notify`	`string`	User email.
`email`	`string`	Required. User email.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`client_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/user/client/`

Get user client list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`id`	`array [integer]`
`login`	`array [string]`

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`client_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/user/client/{user_id`}

Update user client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`	User email.
`status`	`string`	User status. One of 'active', 'blocked'.
`name`	`string`	User name.
`access`	`string`	User access type. One of 'full', 'read_only'.
`extra_params`	`string`	User extra params.
`timezone`	`string`	User timezone.
`password`	`string`	User password.
`email`	`string`	User email.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`client_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/user/client/{user_id`}

Get user client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`client_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/user/client/{user_id`}

Delete user client

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

`POST /client/{client_id}/user/extension/`

Add new user extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`	User email.
`status`	`string`	User status. One of 'active', 'blocked'.
`name`	`string`	Required. User name.
`email_notify`	`boolean`	Send email with access data for new user. Default: False
`access`	`string`	User access type. One of 'full', 'read_only'.
`extension_id`	`integer`	Required. User extension id.
`extra_params`	`string`	User extra params.
`timezone`	`string`	User timezone.
`login`	`string`	Required. User login.
`password`	`string`	Required. User password.
`email_for_notify`	`string`	User email.
`email`	`string`	Required. User email.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/user/extension/`

Get user extension list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`id`	`array [integer]`
`login`	`array [string]`
`name`	`array [string]`
`email`	`array [string]`
`comment`	`array [string]`
`status`	`array [string]`
`timezone`	`array [string]`
`access`	`array [string]`
`extension_id`	`array [integer]`

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/user/extension/{user_id`}

Update user extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`	User email.
`status`	`string`	User status. One of 'active', 'blocked'.
`name`	`string`	User name.
`access`	`string`	User access type. One of 'full', 'read_only'.
`extension_id`	`integer`	User extension id.
`extra_params`	`string`	User extra params.
`timezone`	`string`	User timezone.
`password`	`string`	User password.
`email`	`string`	User email.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/user/extension/{user_id`}

Get user extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/user/extension/{user_id`}

Delete user extension

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

`POST /client/{client_id}/user/extension_group/`

Add new user extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`	User email.
`status`	`string`	User status. One of 'active', 'blocked'.
`name`	`string`	Required. User name.
`email_notify`	`boolean`	Send email with access data for new user. Default: False
`extra_params`	`string`	User extra params.
`access`	`string`	User access type. One of 'full', 'read_only'.
`extension_group_id`	`integer`	Required. User extension id.
`timezone`	`string`	User timezone.
`login`	`string`	Required. User login.
`password`	`string`	Required. User password.
`email_for_notify`	`string`	User email.
`email`	`string`	Required. User email.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`extension_group_id`	`integer`
`email`	`string`
`access`	`string`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/user/extension_group/`

Get user extension group list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`id`	`array [integer]`
`login`	`array [string]`
`name`	`array [string]`
`email`	`array [string]`
`comment`	`array [string]`
`status`	`array [string]`
`timezone`	`array [string]`
`access`	`array [string]`
`extension_group_id`	`array [integer]`

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`extension_group_id`	`integer`
`email`	`string`
`access`	`string`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`PUT /client/{client_id}/user/extension_group/{user_id`}

Update user extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`	User email.
`status`	`string`	User status. One of 'active', 'blocked'.
`name`	`string`	User name.
`extension_group_id`	`integer`	User extension id.
`access`	`string`	User access type. One of 'full', 'read_only'.
`extra_params`	`string`	User extra params.
`timezone`	`string`	User timezone.
`password`	`string`	User password.
`email`	`string`	User email.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`extension_group_id`	`integer`
`email`	`string`
`access`	`string`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /client/{client_id}/user/extension_group/{user_id`}

Get user extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`extension_group_id`	`integer`
`email`	`string`
`access`	`string`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`DELETE /client/{client_id}/user/extension_group/{user_id`}

Delete user extension group

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`user_id`	`integer`	Required.

`POST /client/{client_id}/variables/`

Post client variables

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

JSON parameters

Name	Type	Description
`variables`	`array [client_vars]`	Required.

Resource client_vars

Name	Type	Description
`var`	`string`
`value`	`string`

`GET /client/{client_id}/variables/`

Get client variables

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`variable`	`string`

`DELETE /client/{client_id}/voicemail/`

Delete voice mail messages in interval

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Required. Start datetime.
`end_datetime`	`string`	Required. End datetime.
`extension_id`	`array [integer]`	Extension id.

`GET /client/{client_id}/voicemail/{record_uuid`}

Get voicemail message file

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`record_uuid`	`string`	Required.

`DELETE /client/{client_id}/voicemail/{record_uuid`}

Delete voice message

Path parameters

Name	Type	Description
`client_id`	`string`	Required.
`record_uuid`	`string`	Required.

Client

PUT /client/client_info/{client_id}/

Path parameters

JSON parameters

Resource fields

GET /client/client_info/{client_id}/

Path parameters

Resource fields

POST /client/{client_id}/agent/local/

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/local/

Path parameters

Query parameters

Resource fields

PUT /client/{client_id}/agent/local/{agent_id}

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/local/{agent_id}

Path parameters

Resource fields

DELETE /client/{client_id}/agent/local/{agent_id}

Path parameters

Query parameters

POST /client/{client_id}/agent/local/{agent_id}/event/

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/local/{agent_id}/event/

Path parameters

Resource fields

PUT /client/{client_id}/agent/local/{agent_id}/event/{event_id}

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/local/{agent_id}/event/{event_id}

Path parameters

Resource fields

DELETE /client/{client_id}/agent/local/{agent_id}/event/{event_id}

Path parameters

POST /client/{client_id}/agent/remote/

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/remote/

Path parameters

Resource fields

PUT /client/{client_id}/agent/remote/{agent_id}

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/remote/{agent_id}

Path parameters

Resource fields

DELETE /client/{client_id}/agent/remote/{agent_id}

Path parameters

Query parameters

POST /client/{client_id}/agent/remote/{agent_id}/event/

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/remote/{agent_id}/event/

Path parameters

Resource fields

PUT /client/{client_id}/agent/remote/{agent_id}/event/{event_id}

Path parameters

JSON parameters

Resource fields

GET /client/{client_id}/agent/remote/{agent_id}/event/{event_id}

Path parameters

Resource fields

DELETE /client/{client_id}/agent/remote/{agent_id}/event/{event_id}

Path parameters

GET /client/{client_id}/alias/

Path parameters

Query parameters

Resource fields

PUT /client/{client_id}/alias/{alias_id}

`PUT /client/client_info/{client_id}/`

`GET /client/client_info/{client_id}/`

`POST /client/{client_id}/agent/local/`

`GET /client/{client_id}/agent/local/`

`PUT /client/{client_id}/agent/local/{agent_id`}

`GET /client/{client_id}/agent/local/{agent_id`}

`DELETE /client/{client_id}/agent/local/{agent_id`}

`POST /client/{client_id}/agent/local/{agent_id}/event/`

`GET /client/{client_id}/agent/local/{agent_id}/event/`

`PUT /client/{client_id}/agent/local/{agent_id}/event/{event_id`}

`GET /client/{client_id}/agent/local/{agent_id}/event/{event_id`}

`DELETE /client/{client_id}/agent/local/{agent_id}/event/{event_id`}

`POST /client/{client_id}/agent/remote/`

`GET /client/{client_id}/agent/remote/`

`PUT /client/{client_id}/agent/remote/{agent_id`}

`GET /client/{client_id}/agent/remote/{agent_id`}

`DELETE /client/{client_id}/agent/remote/{agent_id`}

`POST /client/{client_id}/agent/remote/{agent_id}/event/`

`GET /client/{client_id}/agent/remote/{agent_id}/event/`

`PUT /client/{client_id}/agent/remote/{agent_id}/event/{event_id`}

`GET /client/{client_id}/agent/remote/{agent_id}/event/{event_id`}

`DELETE /client/{client_id}/agent/remote/{agent_id}/event/{event_id`}

`GET /client/{client_id}/alias/`

`PUT /client/{client_id}/alias/{alias_id`}

`GET /client/{client_id}/alias/{alias_id`}

`PUT /client/{client_id}/ani/`

`GET /client/{client_id}/ani/`

`POST /client/{client_id}/call_center/report/`

`PUT /client/{client_id}/client/`

`GET /client/{client_id}/client/`

`GET /client/{client_id}/current_calls/`

`POST /client/{client_id}/dial_rule/`

`GET /client/{client_id}/dial_rule/`

`PUT /client/{client_id}/dial_rule/{dial_rules_id`}

`GET /client/{client_id}/dial_rule/{dial_rules_id`}

`DELETE /client/{client_id}/dial_rule/{dial_rules_id`}

`GET /client/{client_id}/did/`

`PUT /client/{client_id}/did/{did_id`}

`GET /client/{client_id}/did/{did_id`}

`POST /client/{client_id}/extension/`

`GET /client/{client_id}/extension/`

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