Это старая версия документа!
API реализуемое на стороне CRM приложения или web-сервиса.
Возвращает данные абонента, которому принадлежит заданный номер телефона.
{ "number":string }
Наименование поля | Описание |
---|---|
number string | Номер телефона абонента (внутренний или мобильный). |
{ "result":string, "data":object(Contact) }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
data object(Contact) | В случае успеха содержит информацию о контакте, которому принадлежит номер телефона. |
Содержит информацию о контакте, занесенном в CRM-систему.
{ "number":string, "contact":string, "client":string, "link":string, "responsible":array[object(Responsible)] }
Наименование поля | Описание |
---|---|
number string | Номер телефона контакта. |
contact string | Имя контакта (контактного лица). |
client string | Наименование контрагента. |
link string | Ссылка на карточку контакта в CRM-системе. |
responsible array[object(Employee)] | Сотрудники установленные в роли ответственных по этому контакту (контрагенту или контактному лицу) в CRM-системе. |
Содержит информацию о сотруднике.
{ "name":string, "extension":string }
Наименование поля | Описание |
---|---|
name string | Имя сотрудника. |
extension string | Добавочный номер телефона сотрудника. |
Подготавливает историю вызовов. Команда проверяет корректность указанных параметров и тут же возвращает ответ. История вызовов возвращается отдельным потоком сообщений публикуемых в очереди с заданным названием. Уникальность названия очереди контролирует клиентское приложение, которое должно предварительно подписаться на получение записей истории из этой очереди.
{ "start_date":string, "end_date":string, "numbers":array[string], "place_to":string }
Наименование поля | Описание |
---|---|
start_date string | Дата и время начальной границы отбора записей истории в формате RFC3339. |
end_date string | Дата и время конечной границы отбора записей истории в формате RFC3339. |
numbers array[string] | Номера телефонов, по которым запрашивается история. |
string | Название очереди, в которую будет отправлен результат запроса истории. |
{ "result":string, "no":integer, "total":integer, "data":{ "call_id":string, "started":string, "finished":string, "status":string, "caller":object(Сontact), "callee":object(Сontact), "conversation":integer, "duration":integer, "record_file":string } }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
no integer | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. |
total integer | Общее количество сообщений с записями истории звонков, которые будут отправлены. |
data.call_id string | Глобальный идентификатор вызова (в формате провайдера). |
data.started string | Дата и время начала вызова в формате RFC3339. |
data.finished string | Дата и время завершения вызова в формате RFC3339. |
data.status string | Статус завершения вызова (в формате провайдера). |
data.caller object(Сontact) | Данные инициатора вызова. |
data.callee object(Сontact) | Данные вызываемого. |
data.conversation integer | Продолжительность разговора в секундах (время от начала разговора и до его завершения). Если вызов находился на удержании (hold), то время удержания будет вычтено. |
data.duration integer | Продолжительность вызова в секундах. |
data.record_file string | Ссылка на файл записи разговора. |
Возвращает список сотрудников и краткую информацию по каждому из них.
Не имеет параметров.
{ "result":string, "no":integer, "total":integer, "data":object(User) }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
no integer | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. |
total integer | Общее количество сообщений с данными пользователей, которые будут отправлены. |
data array[object(User)] | Информация о пользователе. |
Содержит информацию о пользователе CRM-системы.
{ "id":string, "name":string, "extension":string, "os_username":string }
Наименование поля | Описание |
---|---|
id string | Идентификатор пользователя. |
name string | Имя пользователя. |
extension string | Добавочный номер телефона пользователя. |
os_username string | Имя пользователя ОС (если используется аутентификация ОС). |
Возвращает подробную информацию о пользователе.
{ "id":string }
Наименование поля | Описание |
---|---|
id string | Идентификатор пользователя. |
{ "result":string, "data":{ "name":string, "os_username":string, "extension":string, "image":string } }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
data.name string | Имя пользователя. |
data.os_username string | Имя пользователя ОС (если используется аутентификация ОС). |
data.extension string | Добавочный номер телефона пользователя. |
data.image string | Фото. Изображение в формате base64. |