Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

...

GET /extension_group/{ext_group_id}/

...

Add new user extension group

Параметры URL

...

Имя

...

Тип

...

call_status/stats/history_by_extension/

Get extension call status history by extension

Path parameters

Name

Type

Description

ext_group_id

string

Обязательный. Ext group idinteger

Required.

...

Query parameters

ИмяName

ТипType

ОписаниеDescription

commentstart_datetime

string

User emailRequired.

nameend_datetime

string

Обязательный. User name.

language_id

integer

User language id.

extension_group_id

integer

Обязательный. User extension id.

login

string

Обязательный. Логин пользователя.

password

string

Обязательный. Пароль пользователя.

email

string

Обязательный. User email.

Поля ответа

Имя

Тип

Описание

comment

string

Комментарий псевдонима для домена.

name

string

Имя псевдонима для домена.

language_id

integer

Id языка пользователя администратора.

email

string

Электронная почта.

extension_group_id

integer

Id группы добавочных.

login

string

Логин пользователя.

id

integer

Id администратора. Required.

Resource fields

Name

Type

Description

change_list

array [call_status_change]

extension_id

integer

Resource call_status_change

Name

Type

Description

action

string

duration

integer

change_dt

string

status_id

integer

...

GET /extension_group/{ext_group_id}/

...

cdr/

...

Get user extension group cdr list

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

ext_group_id

string

Required.

Query parameters

Name

Type

Description

Имя

Тип

Описание

comment

array [string]

start_datetime

string

Обязательный. Ext group id.

Параметры запроса

nameRequired.

end_datetime

string

Required.

start_duration

integer

end_duration

integer

extension_id

array [integer]

flow

array [string]language_id

One of 'in', 'out', 'transfer'.

to_username

array [integerstring]

emailfrom_username

array [string]

loginextension_type

array [string]

id

array [integer]

Id группы.

Поля ответа

Имя

Тип

Описание

comment

string

Комментарий псевдонима для домена.

name

string

Имя псевдонима для домена.

language_id

integer

Id языка пользователя администратора.

email

string

Электронная почта.

extension_group_id

integer

Id группы добавочных.

login

string

Логин пользователя.

id

integer

Id администратора.

GET /extension_group/{ext_group_id}/extension/

Get extension list

Параметры URL

Имя

Тип

Описание

ext_group_id

string

Обязательный. Ext group id.

Параметры запроса

Имя

Тип

Описание

status

array [string]

type

array [string]

id

array [string]

Id группы.

name

array [string]

Поля ответа

Имя

Тип

Описание

status

string

Agent status.

name

string

Имя псевдонима для домена.

label

string

client_id

integer

Id клиента.

extension_group_id

integer

Id группы добавочных.

type

string

Rule type.

id

integer

Id администратора.

page

integer

Result page. Default: 1

per_page

integer

Items per page. Default: 100000

order

string

Datetime sorting order. One of 'desc', 'asc'. Default: desc

Resource fields

Name

Type

Description

per_page

integer

Items per page.

order

string

Datetime sorting order.

cdr

array [cdr_response]

page

integer

Result page.

Resource cdr_response

Name

Type

Description

to_username

string

source_number

string

result

string

duration

integer

subcall_uuid

string

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

transfer_reason

string

bundle_info

string

remote_call_sign

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

...

GET /extension_group/{ext_group_id}/cdr/

...

stats/

Get extension

Параметры URL

...

Имя

...

Тип

...

calls statistics

Path parameters

Name

Type

Description

ext_group_id

string

ОбязательныйRequired. Ext group id.

Поля ответа

Имя

Тип

Описание

id

integer

Id администратора.

client_id

integer

Id клиента.

name

string

Имя псевдонима для домена.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

extension_id

array [integer]

...

GET /extension_group/{ext_group_id}/fax/

...

in/

Get record incoming fax messages list

...

Path parameters

ИмяName

ТипType

ОписаниеDescription

ext_group_id

string

Обязательный. Ext group id.

Параметры запроса

Описание

Имя

Тип

Required.

Query parameters

Name

Type

Description

uuid

array [string]

Fax uuid.

extension_id

integer

Extension id.

start_datetime

string

Start datetime.

uuidend_datetime

array [string]

Record uuidEnd datetime.

destination

array [string]

Destination number.

caller_id

array [string]

Caller id number. extension_id

order

integer

Extension id.

end_datetime

string

End datetime.

Поля ответа

Описание

Имя

Тип

string

Datetime sorting order. One of 'desc', 'asc'. Default: desc

Resource fields

Name

Type

Description

uuid

string

Record Fax uuid.

destination

string

Destination number.

caller_id

string

Caller id.

datetime

string

Record datetime.

extensionfile_group_idsize

integer

Id группы добавочныхFax file size.

extension_id

integer

Extension id.

client_id

integer

Id клиентаClient id.

fileextension_group_sizeid

integer

Record file size.

duration

integer

Record duration.

record_url

object

Record url.

...

Extension group id.

...

GET /extension_group/{ext_group_id}/

...

Update user extension group

Параметры URL

...

Имя

...

Тип

...

reg_status_log/

Get logs change registration for all extension in group

Path parameters

...

Name

Type

Description

ext_group_id

string

ОбязательныйRequired. Ext group id.

user_id

integer

Обязательный. User id.

Параметры JSON

Имя

Тип

Описание

comment

string

User email.

name

string

User name.

language_id

integer

User language id.

extension_group_id

integer

User extension id.

password

string

Пароль пользователя.

email

string

User email.

Поля ответа

Имя

Тип

Описание

comment

string

Комментарий псевдонима для домена.

name

string

Имя псевдонима для домена.

language_id

integer

Id языка пользователя администратора.

email

string

Электронная почта.

extension_group_id

integer

Id группы добавочных.

login

string

Логин пользователя.

id

integer

Id администратора.

Query parameters

Name

Type

Description

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

status

string

date_gmt

string

short_ext_name

string

...

GET /extension_group/{ext_group_id}/

...

Delete user extension group

Параметры URL

...

Имя

...

Тип

...

voicemail/

Get voice mail messages list

Path parameters

Name

Type

Description

ext_group_id

string

Обязательный. Ext group id.

user_id

integer

Обязательный. User id.

GET /extension_group/{ext_group_id}/user/extension_group/{user_id}

Get user extension group

Параметры URL

Имя

Тип

Описание

ext_group_id

string

Обязательный. Ext group id.

user_id

integer

Обязательный. User id.

Поля ответа

Имя

Тип

Описание

comment

string

Комментарий псевдонима для домена.

name

string

Имя псевдонима для домена.

language_id

integer

Id языка пользователя администратора.

email

string

Электронная почта.

extension_group_id

integer

Id группы добавочных.

login

string

Логин пользователя.

id

integer

Id администратора.

GET /extension_group/{ext_group_id}/record/{record_uuid}

Get record

Параметры URL

Имя

Тип

Описание

record_uuid

string

Обязательный. Record uuid.

ext_group_id

string

Обязательный. Ext group id.

PUT /extension_group/{ext_group_id}/extension/{extension_id}

Update extension

Параметры URL

Имя

Тип

Описание

ext_group_id

string

Обязательный. Ext group id.

extension_id

integer

Обязательный. Extension id.

Параметры JSON

Имя

Тип

Описание

status

string

Принимает одно из значений: 'active', 'blocked'.

password

string

label

string

Поля ответа

Имя

Тип

Описание

status

string

Agent status.

name

string

Имя псевдонима для домена.

label

string

client_id

integer

Id клиента.

extension_group_id

integer

Id группы добавочных.

type

string

Rule type.

id

integer

Id администратора.

GET /extension_group/{ext_group_id}/extension/{extension_id}

Get extension

Параметры URL

Имя

Тип

Описание

ext_group_id

string

Обязательный. Ext group id.

extension_id

integer

Обязательный. Extension id.

Поля ответа

Имя

Тип

Описание

status

string

Agent status.

name

string

Имя псевдонима для домена.

label

string

client_id

integer

Id клиента.

extension_group_id

integer

Id группы добавочных.

type

string

Rule type.

id

integer

Id администратора. Required.

Query parameters

Name

Type

Description

start_datetime

string

Required. Start datetime.

end_datetime

string

Required. End datetime.

order

string

Datetime sorting order. One of 'desc', 'asc'. Default: desc

extension_id

integer

Extension id.

Resource fields

Name

Type

Description

to_username

string

source_number

string

result

string

duration

integer

subcall_uuid

string

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

transfer_reason

string

bundle_info

string

remote_call_sign

string

did_domain

string

from_screen_name

string

extension_name

string

flow

string

dest_number

string

extension_id

integer

Extension id.

did_number

string

client_owner_id

integer

...