Page Comparison

_{Протестировать методы API можно на странице}_{интерактивного обозревателя API}_{и без написания кода}
_{Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см.}_{Создание и авторизация приложений}₎

Описание структур данных

Expand

title	Развернуть

Имя

Тип

Описание

ambassadors

string

Контактные лица

contact_phones

string

Контактные телефоны

create_date

string

Дата создания

dial_rule_id

long

Идентификатор правила исходящих вызовов

did_as_transfer_caller_id

string

Внешний номер АТС, на который изначально пришел вызов, отображаемый при дальнейшей переадресации номера. Возможные варианты:

default: вызов после переадресации уходит в том же виде, как и пришел (внешний номер АТС, на который изначально пришел вызов, не отображается)
from: внешний номер АТС, на который изначально пришел вызов, после переадресации появляется в SIP поле “From” и “P-Asserted-Identity“
diversion: аналогично “default”, но внешний номер АТС, на который изначально пришел вызов, после переадресации появляется в SIP поле “Diversion“

Note
Важно: настройка может быть переопределена другими настройками платформы, сделанными провайдером.

disk_space_notify_email

string

Адрес e-mail, на который будет отправлено письмо при достижении порогового значения дискового пространства (disk_space_notify_threshold)

disk_space_notify_threshold

long

Порог уведомления (в %) о достижении порогового значения размера дискового пространства, при котором сработает отправка письма на адрес e-mail, указанный в disk_space_notify_email

domain

string

Домен

domain_prefix

string

Префикс домена. Используется для полного набора внутреннего номера. Например, при префиксе "12345", внутренний номер 000*000@domain.zone может быть вызван по номеру "12345*000*000"

email

string

Адрес электронной почты

extension_len

string

Длина внутренних номеров

extra_params

string

Дополнительные параметры

fact_address

string

Фактический адрес

geo_list

string

Задает список стран, с IP-адресов которых разрешено использование SIP-аккаунта. Страны перечисляются в формате ISO 3166 Codes A2, например: "RU US BY". Если список не задан, то используется значение, определенное сервис-провайдером. Если список имеет значение "*", то все страны разрешены и параметр сервис провайдера игнорируется

hold_music

long

Идентификатор звукового файла, проигрываемого при удержании вызова

id

long

Идентификатор клиента

jur_address

string

Юридический адрес

language

string

Язык

name

string

Имя клиента

prefix

string

Префикс клиента

presence

string

yes/no: контроль доступности внутренних номеров АТС без звонка на них (зеленые - свободные, можно перевести вызов; красные - занятые)

record_format

string

Формат записи разговоров, по умолчанию mp3

record_stereo

boolean

true/false: определяет, ведется ли запись разговоров в формате “стерео”, по умолчанию false

reg_status_log

boolean

true/false: определяет, ведется ли статистика регистраций внутренних номеров. Параметр задается сервис-провайдером.

short_local_caller_id

string

Короткий внутренний идентификатор вызывающего абонента (отображение внутреннего номера без префикса АТС)

sip_network_permission_id

long

Идентификатор доверенной сети SIP. Телефоны могут авторизовываться по IP-адресам; если задан этот параметр, то это список IP-адресов, с которых в данной организации могут совершаться вызовы

timezone

string

Временная зона клиента

type

string

Тип клиента: J – юридическое лицо, F – физическое лицо

Пример

Получим информацию о текущем авторизованном клиенте. Для этого необходимо отправить следующий запрос:

Tabs

[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication","marks":[{"type":"strong"}]},{"type":"text","text":" в поля "},{"type":"text","text":"client_id","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"client_secret","marks":[{"type":"strong"}]},{"type":"text","text":"  необходимо ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку \""},{"type":"text","text":"Try it out!","marks":[{"type":"strong"}]},{"type":"text","text":"\". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки \""},{"type":"text","text":"Set Token","marks":[{"type":"strong"}]},{"type":"text","text":"\"."}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/"},{"type":"text","text":"client/@me/client/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"7bb5eaad-6b60-4552-bb5f-2f46dc8229d5","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\r\n-H \"Authorization: Bearer ${access_token}\" \\\r\n-X GET ${url}/client/@me/client/"}]}]},"id":"b2626d6e-84ff-4ff1-9124-16d4f2a61e59","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\n\nimport requests\n\nurl = f\"{URL}/client/@me/client/\"\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\n}\nresponse = requests.request(\"GET\", url, headers=headers)\nprint(response.text)"}]}]},"id":"7cbfb053-7968-4e4b-8762-6d0a2eb273e4","label":"На языке Python3    ","type":"tab"}]

Expand

title	Ответ системы:

Code Block

language	json

{
  "domain": "sip.ringme.ru",
  "create_date": "2020-03-16 09:29:57",
  "hold_music": null,
  "presence": "no",
  "sip_network_permission_id": null,
  "prefix": "0001",
  "record_stereo": false,
  "ambassadors": null,
  "id": 12,
  "domain_prefix": "00001",
  "contact_phones": null,
  "name": "ringme_test",
  "timezone": "Europe/Moscow",
  "dial_rule_id": 19,
  "type": "J",
  "email": "admin@domain.com",
  "reg_status_log": false,
  "fact_address": null,
  "extra_params": null,
  "extension_len": 3,
  "geo_list": null,
  "did_as_transfer_caller_id": "default",
  "jur_address": null,
  "language": null,
  "record_format": "mp3",
  "short_local_caller_id": "yes",
  "disk_space_notify_email": null,
  "disk_space_notify_threshold": null
}

Ресурсы раздела "Клиент"

Expand

title	GET /client/{client_id}/client/ , либо GET /client/client_info/{client_id}/

GET /client/{client_id}/client/,

либо GET /client/client_info/{client_id}/

Получить информацию о клиенте

Параметры URL

Имя	Тип
client_id	string

Поля ответа

Имя	Тип
ambassadors	string
contact_phones	string
create_date	string
dial_rule_id	long
did_as_transfer_caller_id	string
disk_space_notify_email	string
disk_space_notify_threshold	long
domain	string
domain_prefix	string
email	string
extension_len	string
extra_params	string
fact_address	string
geo_list	string
hold_music	long
id	long
jur_address	string
language	string
name	string
prefix	string
presence	string
record_format	string
record_stereo	boolean
reg_status_log	boolean
short_local_caller_id	string
sip_network_permission_id	long
timezone	string
type	string

Expand

title	PUT /client/{client_id}/client/, либо PUT /client/client_info/{client_id}/

PUT /client/{client_id}/client/,

либо PUT /client/client_info/{client_id}/

Обновить настройки клиента (клиенту доступны не все параметры для обновления)

Параметры URL

Имя	Тип
client_id	string

Параметры JSON

Имя	Тип
dial_rule_id	long
disk_space_notify_email	string
disk_space_notify_threshold	long
geo_list	string
hold_music	long
sip_network_permission_id	long
timezone	string

Поля ответа

Имя	Тип
ambassadors	string
contact_phones	string
create_date	string
dial_rule_id	long
did_as_transfer_caller_id	string
disk_space_notify_email	string
disk_space_notify_threshold	long
domain	string
domain_prefix	string
email	string
extension_len	string
extra_params	string
fact_address	string
geo_list	string
hold_music	long
id	long
jur_address	string
language	string
name	string
prefix	string
presence	string
record_format	string
record_stereo	boolean
reg_status_log	boolean
short_local_caller_id	string
sip_network_permission_id	long
timezone	string
type	string

Versions Compared

Old Version 2

New Version Current

Key

Описание структур данных

Пример

Ресурсы раздела "Клиент"