201 lines
9.3 KiB
PHP
201 lines
9.3 KiB
PHP
1) Тестовый запрос
|
||
2) Поиск карточки по номеру
|
||
3) Загрузка звонков
|
||
4) Создание контакта
|
||
5) Создание Лида
|
||
6) Показать список пользователей
|
||
7) Добавить комментарий к звонку
|
||
|
||
Крон на получение секретного ключа
|
||
Авторизация
|
||
|
||
|
||
1) Получение ключа
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/auth.json
|
||
--
|
||
auth_key обязательно API ключ
|
||
new Параметр указывающий на необходимость обновления ключа, обязательное значение "true"
|
||
key Ключ для дальнейшей работы с API
|
||
key_id Идентификатор ключа
|
||
--
|
||
(warning) Не запрашивайте ключ при каждом запросе, а только если в ответ получите: {"status":0,"comment":"not authenticated","data":""}
|
||
(warning) Здесь и далее example.onpbx.ru — это пример домена в нашем сервисе. У каждого клиента уникальный домен.
|
||
(warning) При частых запросах авторизации (4-5 запросов в секунду), некоторые сессии будут обрабатываться некорректно, так как каждая новая авторизация даёт новый ключ.
|
||
(warning) Время жизни секретного ключа 3 дня с момента последнего обращения.
|
||
|
||
|
||
|
||
Звонки
|
||
|
||
|
||
|
||
2) Мгновенные
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/call/now.json
|
||
--
|
||
from обязательно Кто, первый вызываемый номер (номер абонента или внешний номер)
|
||
to обязательно Кому, второй вызываемый номер (любой)
|
||
gate_from Номер транка для первого номера
|
||
gate_to Номер транка для второго номера
|
||
to_domain Указываете домен на который должен быть совершен звонок (для прямых звонков)
|
||
from_orig_number Телефонный номер который увидит первый вызываемый номер
|
||
from_orig_name Имя пользователя которое увидит первый вызываемый номер
|
||
--
|
||
|
||
|
||
|
||
|
||
3) Отложенные
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/call/later.json
|
||
--
|
||
from обязательно Кто, первый вызываемый номер (номер абонента или внешний номер)
|
||
to обязательно Кому, второй вызываемый номер (любой)
|
||
gate_from Номер транка для первого номера
|
||
gate_to Номер транка для второго номера
|
||
to_domain Указываете домен на который должен быть совершен звонок (для прямых звонков)
|
||
date Дата в формате (RFC-2822)
|
||
--
|
||
|
||
|
||
|
||
4) История звонков
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/history/search.json
|
||
--
|
||
duration_from Длительность (всего звонка) от (сек.)
|
||
duration_to Длительность (всего звонка) до (сек.)
|
||
billsec_from Продолжительность разговора от (сек.)
|
||
billsec_to Продолжительность разговора до (сек.)
|
||
date_from Звонок начался (дата) от (RFC-2822)
|
||
date_to Звонок кончился (дата) до (RFC-2822)
|
||
start_date_from Звонок начался (дата) от (RFC-2822)
|
||
start_date_to Звонок начался (дата) до (RFC-2822)
|
||
end_date_from Звонок кончился (дата) от (RFC-2822)
|
||
end_date_to Звонок кончился (дата) до (RFC-2822)
|
||
number По точному номеру
|
||
out_number По части номера (выдается любой номер содержащий в себе эти цифры)
|
||
type По типу - inbound/outbound/local
|
||
uuid Выдача конкретного звонка по уникальному ID
|
||
uuid_array Выдача нескольких звонков по списку ID
|
||
download Если параметр указан то вместо массива данных будет возвращен URL для скачивания файла записей звонков. Если найден 1 звонок, то время жизни ссылки 200 секунд, иначе 1 час.
|
||
--
|
||
НЕОБХОДИМ ОДИН ИЗ СЛЕДУЮЩИХ ПАРАМЕТРОВ
|
||
--
|
||
uuid Уникальный идентификатор сессии
|
||
caller Звонящий
|
||
from_domain Домен звонящего
|
||
to Кому звонили
|
||
to_domain Домен того, кому звонили
|
||
gateway Транк
|
||
date Дата в формате UNIX timestamp - https://www.unixtimestamp.com/index.php
|
||
duration Общая длительность звонка
|
||
billsec Длительность разговора
|
||
hangup_cause Причина завершения звонка - https://api.onlinepbx.ru/lib/hangup_cause.js
|
||
type Тип звонка - inbound/outbound/local
|
||
--
|
||
Возможна задержка до 1 минуты между завершением звонка и его доступностью при использовании API.
|
||
|
||
|
||
|
||
5) ПоисК
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/history/search.json
|
||
|
||
|
||
6) Скачивание записи конкретного звонка
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/history/search.json
|
||
|
||
|
||
7) Скачивание нескольких записей звонков tar архивом
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/history/search.json
|
||
|
||
|
||
ICM (Интеллектуальный менеджер контактов)
|
||
|
||
8) Поиск контакта
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/icm/search.json
|
||
--
|
||
out_num Внешний номер
|
||
int_num Внутренний номер сотрудника
|
||
date_from Дата последнего изменения от (RFC-2822)
|
||
date_to Дата последнего изменения до (RFC-2822)
|
||
creation_date_from Дата создания от (RFC-2822)
|
||
creation_date_to Дата создания до (RFC-2822)
|
||
--
|
||
Для запроса необходим хотя бы один параметр
|
||
|
||
|
||
|
||
9) Добавить контакт
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/icm/add.json
|
||
--
|
||
out_num обязательно Внешний номер
|
||
out_name Имя контакта
|
||
int_num обязательно Внутренний номер сотрудника
|
||
block Защита от изменений 1/0 (включена/выключена)
|
||
note Примечание
|
||
--
|
||
|
||
|
||
|
||
10) Изменить контакт
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/icm/edit.json
|
||
--
|
||
out_num обязательно Внешний номер
|
||
out_name Имя контакта
|
||
int_num обязательно Внутренний номер сотрудника
|
||
block Защита от изменений 1/0 (включена/выключена)
|
||
note Примечание
|
||
--
|
||
|
||
|
||
|
||
Пользователи
|
||
|
||
|
||
11) Добавить пользователя
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/user/add.json
|
||
--
|
||
num обязательно Внутренний номер пользователя
|
||
pass обязательно Пароль
|
||
name Имя (латинскими буквами)
|
||
delay1 Задержка 1
|
||
tr1 Номер при недоступности 1
|
||
delay2 Задержка 2
|
||
tr2 Номер при недоступности 2
|
||
delay3 Задержка 3
|
||
tr3 Номер при недоступности 3
|
||
--
|
||
|
||
|
||
|
||
12) Изменить пользователя
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/user/edit.json
|
||
--
|
||
num обязательно Внутренний номер пользователя
|
||
pass обязательно Пароль
|
||
name Имя (латинскими буквами)
|
||
delay1 Задержка 1
|
||
tr1 Номер при недоступности 1
|
||
delay2 Задержка 2
|
||
tr2 Номер при недоступности 2
|
||
delay3 Задержка 3
|
||
tr3 Номер при недоступности 3
|
||
--
|
||
|
||
|
||
|
||
13) Получить
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/user/get.json
|
||
--
|
||
num обязательно Внутренний номер пользователя
|
||
name Имя (латинскими буквами)
|
||
delay1 Задержка 1
|
||
tr1 Номер при недоступности 1
|
||
delay2 Задержка 2
|
||
tr2 Номер при недоступности 2
|
||
delay3 Задержка 3
|
||
tr3 Номер при недоступности 3
|
||
--
|
||
|
||
|
||
|
||
14) Получить список внутренних номеров пользователей
|
||
URL: api.onlinepbx.ru/example.onpbx.ru/user/get.json |