Внимание!
Эта wiki об устаревших версиях
Документация к актуальной версии интеграции 1С и телефонии доступна по ссылке
Инструменты пользователя
Инструменты пользователя
uniphone:crmapi
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
uniphone:crmapi [2017/04/25 10:46] mcvet Добавлено: users.list и users.get |
uniphone:crmapi [2021/03/29 12:30] (текущий) mcvet |
||
|---|---|---|---|
| Строка 11: | Строка 11: | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| | ** number**\\ //string// | Номер телефона абонента (внутренний или мобильный). | | | ** number**\\ //string// | Номер телефона абонента (внутренний или мобильный). | | ||
| Строка 23: | Строка 23: | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | | ||
| | **data**\\ [[uniphone:crmapi#contact|object(Contact)]] | В случае успеха содержит информацию о контакте, которому принадлежит номер телефона. | | | **data**\\ [[uniphone:crmapi#contact|object(Contact)]] | В случае успеха содержит информацию о контакте, которому принадлежит номер телефона. | | ||
| Строка 36: | Строка 36: | ||
| "client":string, | "client":string, | ||
| "link":string, | "link":string, | ||
| - | "responsible":array[object(Responsible)] | + | "responsible":array[object(Employee)] |
| }</code> | }</code> | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| | **number**\\ //string// | Номер телефона контакта. | | | **number**\\ //string// | Номер телефона контакта. | | ||
| | **contact**\\ //string// | Имя контакта (контактного лица). | | | **contact**\\ //string// | Имя контакта (контактного лица). | | ||
| Строка 57: | Строка 57: | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| | **name**\\ //string// | Имя сотрудника. | | | **name**\\ //string// | Имя сотрудника. | | ||
| | **extension**\\ //string// | Добавочный номер телефона сотрудника. | | | **extension**\\ //string// | Добавочный номер телефона сотрудника. | | ||
| - | ==== [request] crm.v1.cmd.call_history==== | + | ==== [request] crm.v1.cmd.find ==== |
| - | Подготавливает историю вызовов. Команда проверяет корректность указанных параметров и тут же возвращает ответ. История вызовов возвращается отдельным потоком сообщений публикуемых в очереди с заданным названием. Уникальность названия очереди контролирует клиентское приложение, которое должно предварительно подписаться на получение записей истории из этой очереди. | + | Выполняет поиск по справочнику абонентов. |
| == JSON формат: == | == JSON формат: == | ||
| <code>{ | <code>{ | ||
| - | "start_date":string, | + | "search_line":string |
| - | "end_date":string, | + | |
| - | "numbers":array[string], | + | |
| - | "place_to":string | + | |
| }</code> | }</code> | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| - | | **start_date**\\ //string// | Дата и время начальной границы отбора записей истории в формате RFC3339. | | + | | ** search_line**\\ //string// | Строка поиска, содержащая имя абонента или его номер телефона. Допускается указание части имени или номера. | |
| - | | **end_date**\\ //string// | Дата и время конечной границы отбора записей истории в формате RFC3339. | | + | |
| - | | **numbers**\\ array[string] | Номера телефонов, по которым запрашивается история. | | + | |
| - | | **place_to**\\ //string// | Название очереди, в которую будет отправлен результат запроса истории. | | + | |
| === Ответ === | === Ответ === | ||
| Строка 84: | Строка 78: | ||
| == JSON формат: == | == JSON формат: == | ||
| <code>{ | <code>{ | ||
| - | "result":string | + | "result":string, |
| + | "no":integer, | ||
| + | "total":integer, | ||
| + | "data":array[object(Contact)] | ||
| }</code> | }</code> | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| - | | **result**\\ //string// | Результат выполнения команды. Может содержать описание ошибки. | | + | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | |
| + | | **no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | | ||
| + | | **total**\\ //integer// | Общее количество сообщений с записями истории звонков, которые будут | ||
| + | | **data**\\ [[uniphone:crmapi#contact|array[object(Contact)]]] | Массив, содержащий найденные контакты. | | ||
| + | |||
| + | |||
| + | ==== [request] crm.v1.cmd.call_history ==== | ||
| + | Возвращает записи истории вызовов отобранных по указанным в запросе параметрам. Для вызовов на группы операторов или вызовов с переадресацией, история содержит только те записи вызовов, в которых непосредственно участвовали указанные номера. | ||
| + | |||
| + | == JSON формат: == | ||
| + | <code>{ | ||
| + | "start_date":string, | ||
| + | "end_date":string, | ||
| + | "numbers":array[string] | ||
| + | }</code> | ||
| + | |||
| + | == Параметры: == | ||
| + | ^ Наименование поля ^ Описание ^ | ||
| + | | **start_date**\\ //string// | Дата и время начальной границы отбора записей истории в формате RFC3339. | | ||
| + | | **end_date**\\ //string// | Дата и время конечной границы отбора записей истории в формате RFC3339. | | ||
| + | | **numbers**\\ array[string] | Номера телефонов, по которым запрашивается история. | | ||
| + | |||
| + | === Ответ === | ||
| - | Результат выполнения команды будет отправлен в очередь указанную в параметре **place_to** как только он будет готов. | ||
| == JSON формат: == | == JSON формат: == | ||
| <code>{ | <code>{ | ||
| "result":string, | "result":string, | ||
| - | "data":{ | + | "no":integer, |
| - | "no":integer, | + | "total":integer, |
| - | "total":integer, | + | "data":{ |
| - | "record":{ | + | "call_id":string, |
| - | "call_id":string, | + | "started":string, |
| - | "started":string, | + | "finished":string, |
| - | "finished":string, | + | "status":string, |
| - | "status":string, | + | "caller":object(Сontact), |
| - | "caller":object(Сontact), | + | "callee":object(Сontact), |
| - | "callee":object(Сontact), | + | "conversation":integer, |
| - | "conversation":integer, | + | "duration":integer, |
| - | "duration":integer, | + | "record_file":string |
| - | "record_file":string | + | |
| - | } | + | |
| } | } | ||
| }</code> | }</code> | ||
| Строка 114: | Строка 130: | ||
| == Параметры: == | == Параметры: == | ||
| ^ Наименование поля ^ Описание ^ | ^ Наименование поля ^ Описание ^ | ||
| - | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | | + | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | |
| - | | data.**no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | | + | | **no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | |
| - | | data.**total**\\ //integer// | Общее количество сообщений с записями истории звонков, которые будут отправлены. | | + | | **total**\\ //integer// | Общее количество сообщений с записями истории звонков, которые будут отправлены. | |
| - | | data.record.**call_id**\\ //string// | Глобальный идентификатор вызова (в формате провайдера). | | + | | data.**call_id**\\ //string// | Глобальный идентификатор вызова (в формате провайдера). | |
| - | | data.record.**started**\\ //string// | Дата и время начала вызова в формате RFC3339. | | + | | data.**started**\\ //string// | Дата и время начала вызова в формате RFC3339. | |
| - | | data.record.**finished**\\ //string// | Дата и время завершения вызова в формате RFC3339. | | + | | data.**finished**\\ //string// | Дата и время завершения вызова в формате RFC3339. | |
| - | | data.record.**status**\\ //string// | Статус завершения вызова (в формате провайдера). | | + | | data.**status**\\ //string// | Статус завершения вызова (в формате провайдера). | |
| - | | data.record.**caller**\\ [[uniphone:crmapi#contact|object(Сontact)]] | Данные инициатора вызова. | | + | | data.**caller**\\ [[uniphone:crmapi#contact|object(Сontact)]] | Данные инициатора вызова. | |
| - | | data.record.**callee**\\ [[uniphone:crmapi#contact|object(Сontact)]] | Данные вызываемого. | | + | | data.**callee**\\ [[uniphone:crmapi#contact|object(Сontact)]] | Данные вызываемого. | |
| - | | data.record.**conversation**\\ //integer// | Продолжительность разговора в секундах (время от начала разговора и до его завершения). Если вызов находился на удержании (hold), то время удержания будет вычтено. | | + | | data.**conversation**\\ //integer// | Продолжительность разговора в секундах (время от начала разговора и до его завершения). Если вызов находился на удержании (hold), то время удержания будет вычтено. | |
| - | | data.record.**duration**\\ //integer// | Продолжительность вызова в секундах. | | + | | data.**duration**\\ //integer// | Продолжительность вызова в секундах. | |
| - | | data.record.**record_file**\\ //string// | Ссылка на файл записи разговора. | | + | | data.**record_file**\\ //string// | Ссылка на файл записи разговора. | |
| Строка 139: | Строка 155: | ||
| <code>{ | <code>{ | ||
| "result":string, | "result":string, | ||
| - | "data":{ | + | "no":integer, |
| - | "no":integer, | + | "total":integer, |
| - | "total":integer, | + | "data":array[object(User)] |
| - | "user":object(User) | + | |
| - | } | + | |
| }</code> | }</code> | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | | ||
| - | | data.**no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | | + | | **no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | |
| - | | data.**total**\\ //integer// | Общее количество сообщений с данными пользователей, которые будут отправлены. | | + | | **total**\\ //integer// | Общее количество сообщений с данными пользователей, которые будут отправлены. | |
| - | | data.**user**\\ [[uniphone:crmapi#user|array[object(User)]]] | Информация о пользователе. | | + | | **data**\\ [[uniphone:crmapi#user|array[object(User)]]] | Массив, содержащий информацию о пользователях CRM-системы. | |
| === User === | === User === | ||
| Строка 161: | Строка 175: | ||
| "name":string, | "name":string, | ||
| "extension":string, | "extension":string, | ||
| - | "os_username":string | + | "mobile":string, |
| + | "os_username":string, | ||
| + | "image_hash":string | ||
| }</code> | }</code> | ||
| Строка 169: | Строка 185: | ||
| | **name**\\ //string// | Имя пользователя. | | | **name**\\ //string// | Имя пользователя. | | ||
| | **extension**\\ //string// | Добавочный номер телефона пользователя. | | | **extension**\\ //string// | Добавочный номер телефона пользователя. | | ||
| + | | **mobile**\\ //string// | Мобильный номер телефона пользователя. | | ||
| | **os_username**\\ //string// | Имя пользователя ОС (если используется аутентификация ОС). | | | **os_username**\\ //string// | Имя пользователя ОС (если используется аутентификация ОС). | | ||
| + | | **image_hash**\\ //string// | Хеш фотографии пользователя. Позволяет определить факт изменения фотографии для повторной загрузки. | | ||
| Строка 193: | Строка 211: | ||
| "os_username":string, | "os_username":string, | ||
| "extension":string, | "extension":string, | ||
| - | "image":string | + | "mobile":string, |
| + | "image":string, | ||
| + | "image_hash":string | ||
| } | } | ||
| }</code> | }</code> | ||
| == Параметры: == | == Параметры: == | ||
| - | ^ Наименование поля ^ Описание ^ | + | ^ Наименование поля ^ Описание ^ |
| - | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | | + | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | |
| | data.**name**\\ //string// | Имя пользователя. | | | data.**name**\\ //string// | Имя пользователя. | | ||
| | data.**os_username**\\ //string// | Имя пользователя ОС (если используется аутентификация ОС). | | | data.**os_username**\\ //string// | Имя пользователя ОС (если используется аутентификация ОС). | | ||
| | data.**extension**\\ //string// | Добавочный номер телефона пользователя. | | | data.**extension**\\ //string// | Добавочный номер телефона пользователя. | | ||
| + | | data.**mobile**\\ //string// | Мобильный номер телефона пользователя. | | ||
| | data.**image**\\ //string// | Фото. Изображение в формате base64. | | | data.**image**\\ //string// | Фото. Изображение в формате base64. | | ||
| + | | data.**image_hash**\\ //string// | Хеш фотографии пользователя. Позволяет определить факт изменения фотографии для повторной загрузки. | | ||
uniphone/crmapi.1493117203.txt.gz · Последние изменения: 2017/04/25 10:46 — mcvet
Инструменты страницы
Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: Public Domain
