Внимание!
Эта wiki об устаревших версиях
Документация к актуальной версии интеграции 1С и телефонии доступна по ссылке

Инструменты пользователя

Инструменты сайта


uniphone:crmapi

Это старая версия документа!


UniPhone CRM API

API реализуемое на стороне CRM приложения или web-сервиса.

[request] crm.cmd.whois

Возвращает данные абонента, которому принадлежит заданный номер телефона.

JSON формат:
{
  "number":string
}
Параметры:
Наименование поля Описание
number
string
Номер телефона абонента (внутренний или мобильный).

Ответ

JSON формат:
{
  "result":string,
  "data":object(Сontact)
}
Параметры:
Наименование поля Описание
result
string
Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае.
data
object(Сontact)
В случае успеха содержит информацию о контакте, которому принадлежит номер телефона.

Сontact

Содержит информацию о контакте, занесенном в CRM-систему.

JSON формат:
{
  "number":string,
  "contact":string,
  "client":string,
  "link":string
}
Параметры:
Наименование поля Описание
number
string
Номер телефона контакта.
contact
string
Имя контакта (контактного лица).
client
string
Наименование физического или юридического лица.
link
string
Ссылка на карточку контакта в CRM-системе.

[request] crm.cmd.call_history

Подготавливает историю вызовов. Команда проверяет корректность указанных параметров и тут же возвращает ответ. История вызовов возвращается отдельным потоком сообщений публикуемых в очереди с заданным названием. Уникальность названия очереди контролирует клиентское приложение, которое должно предварительно подписаться на получение записей истории из этой очереди.

JSON формат:
{
  "start_date":string,
  "end_date":string,
  "numbers":array[string],
  "place_to":string
}
Параметры:
Наименование поля Описание
start_date
string
Дата и время начальной границы отбора записей истории в формате RFC3339.
end_date
string
Дата и время конечной границы отбора записей истории в формате RFC3339.
numbers
array[string]
Номера телефонов, по которым запрашивается история.
place_to
string
Название очереди, в которую будет отправлен результат запроса истории.

Ответ

JSON формат:
{
  "result":string
}
Параметры:
Наименование поля Описание
result
string
Результат выполнения команды. Может содержать описание ошибки.

Результат выполнения команды будет отправлен в очередь указанную в параметре place_to как только он будет готов.

JSON формат:
{
  "result":string,
  "data":{
    "no":integer,
    "total":integer,
    "record":{
      "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» в случае успеха и описание ошибки в ином случае.
data.no
integer
Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total].
data.total
integer
Общее количество сообщений с записями истории звонков, которые будут отправлены.
data.record.call_id
string
Глобальный идентификатор вызова (в формате провайдера).
data.record.started
string
Дата и время начала вызова в формате RFC3339.
data.record.finished
string
Дата и время завершения вызова в формате RFC3339.
data.record.status
string
Статус завершения вызова (в формате провайдера).
data.record.caller
object(Сontact)
Данные инициатора вызова.
data.record.callee
object(Сontact)
Данные вызываемого.
data.record.conversation
integer
Продолжительность разговора в секундах (время от начала разговора и до его завершения). Если вызов находился на удержании (hold), то время удержания будет вычтено.
data.record.duration
integer
Продолжительность вызова в секундах.
data.record.record_file
string
Ссылка на файл записи разговора.
uniphone/crmapi.1491899466.txt.gz · Последние изменения: 2017/04/11 08:31 — mcvet