Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
uniphone:crmapi [2017/06/26 09:06] mcvet Добавлено поле mobile для user.list и users.get |
uniphone:crmapi [2021/03/29 12:30] mcvet |
||
---|---|---|---|
Строка 36: | Строка 36: | ||
"client":string, | "client":string, | ||
"link":string, | "link":string, | ||
- | "responsible":array[object(Responsible)] | + | "responsible":array[object(Employee)] |
}</code> | }</code> | ||
Строка 62: | Строка 62: | ||
- | ==== [request] crm.v1.cmd.call_history==== | + | ==== [request] crm.v1.cmd.find ==== |
- | Подготавливает историю вызовов. Команда проверяет корректность указанных параметров и тут же возвращает ответ. История вызовов возвращается отдельным потоком сообщений публикуемых в очереди с заданным названием. Уникальность названия очереди контролирует клиентское приложение, которое должно предварительно подписаться на получение записей истории из этой очереди. | + | Выполняет поиск по справочнику абонентов. |
+ | |||
+ | == JSON формат: == | ||
+ | <code>{ | ||
+ | "search_line":string | ||
+ | }</code> | ||
+ | |||
+ | == Параметры: == | ||
+ | ^ Наименование поля ^ Описание ^ | ||
+ | | ** search_line**\\ //string// | Строка поиска, содержащая имя абонента или его номер телефона. Допускается указание части имени или номера. | | ||
+ | |||
+ | === Ответ === | ||
+ | |||
+ | == JSON формат: == | ||
+ | <code>{ | ||
+ | "result":string, | ||
+ | "no":integer, | ||
+ | "total":integer, | ||
+ | "data":array[object(Contact)] | ||
+ | }</code> | ||
+ | |||
+ | == Параметры: == | ||
+ | ^ Наименование поля ^ Описание ^ | ||
+ | | **result**\\ //string// | Результат выполнения команды. Содержит "Success" в случае успеха и описание ошибки в ином случае. | | ||
+ | | **no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | | ||
+ | | **total**\\ //integer// | Общее количество сообщений с записями истории звонков, которые будут | ||
+ | | **data**\\ [[uniphone:crmapi#contact|array[object(Contact)]]] | Массив, содержащий найденные контакты. | | ||
+ | |||
+ | |||
+ | ==== [request] crm.v1.cmd.call_history ==== | ||
+ | Возвращает записи истории вызовов отобранных по указанным в запросе параметрам. Для вызовов на группы операторов или вызовов с переадресацией, история содержит только те записи вызовов, в которых непосредственно участвовали указанные номера. | ||
== JSON формат: == | == JSON формат: == | ||
Строка 127: | Строка 157: | ||
"no":integer, | "no":integer, | ||
"total":integer, | "total":integer, | ||
- | "data":object(User) | + | "data":array[object(User)] |
}</code> | }</code> | ||
Строка 135: | Строка 165: | ||
| **no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | | | **no**\\ //integer// | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. | | ||
| **total**\\ //integer// | Общее количество сообщений с данными пользователей, которые будут отправлены. | | | **total**\\ //integer// | Общее количество сообщений с данными пользователей, которые будут отправлены. | | ||
- | | **data**\\ [[uniphone:crmapi#user|array[object(User)]]] | Информация о пользователе. | | + | | **data**\\ [[uniphone:crmapi#user|array[object(User)]]] | Массив, содержащий информацию о пользователях CRM-системы. | |
=== User === | === User === |