Skip to end of metadata
Go to start of metadata

Addon API — это програмный интерфейс для работы с расширением для браузера, который позволяет легко интегрироваться с различными внешними сервисами. Для интеграции необходимо указать в настройках модуля API ссылку по которой будут осуществляться POST запросы с нашего сервера.

(warning) Ссылку следует указывать без префикса http://

Addon API пока в бета режиме и есть вероятность что он будет модифицирован, вопросы и замечания присылайте на 000@onlinepbx.ru.


 


 

Тестовый запрос

Таблица параметров:

ПараметрПримечаниеОписание параметра
action Тип запроса
status 1- успешно, 0 - неуспешно
Запрос

POST /api/ HTTP/1.1
Host: custom_crm.onlinepbx.ru
Accept: */*
Content-Length: 11
Content-Type: application/x-www-form-urlencoded

action=test

Ответ

HTTP/1.1 200 OK
Date: Tue, 18 Oct 2016 09:31:41 GMT
Server: Apache
Content-Length: 14
Content-Type: application/json

{"status":"1"}


 

Поиск карточки по номеру

Таблица параметров запроса:

ПараметрПримечаниеОписание параметра
action Тип запроса
phone 

Телефонный номер. Не подлежит какому-либо форматированию с нашей стороны и отправляется ровно в том формате в котором он был передан оператором связи либо пользователем. Номера: +7(495)222-22-22, +74952222222, 74952222222, 84952222222, 8 495 222 22 22, 4952222222, 2222222, 222-22-22, 2222222 доб.211 и т.д, могут принадлежать одному и тому-же контакту, важно это учитывать. Оптимальным способом поиска по номеру, считается поиск только по цифрам начиная с конца номера.

Запрос

POST /api/ HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 49
Host: custom_crm.onlinepbx.ru
Connection: close

action=contact_info&data[phone]=0123456789&trunk=

Таблица параметров ответа:

ПараметрПримечаниеОписание параметра
statusДля параметра contact1- успешно, 0 - не успешно
commentДля параметра contactКомментарий или ошибка
idДля параметра contactИдентификатор контакта
urlДля параметра contactАдрес карточки контакта
nameДля параметра contactИмя, фамилия контакта
emailДля параметра contactEmail котакта
photoДля параметра contactАдрес фото контакта
idДля параметра companyИдентификатор компании
urlДля параметра companyАдрес карточки компании
titleДля параметра companyНазвание компании
emailДля параметра companyEmail компании
logoДля параметра companyАдрес логотипа компании
idДля параметра leadИдентификатор компании
urlДля параметра leadАдрес карточки Лида
titleДля параметра leadНазвание лида
emailДля параметра leadEmail компании
idДля параметра leadИдентификатор сделки
urlДля параметра leadАдрес карточки Лида
titleДля параметра leadНазвание сделки
Ответ

HTTP/1.1 200 OK
Date: Tue, 18 Oct 2016 09:47:42 GMT
Server: Apache
Content-Length: 905
Connection: close
Content-Type: application/json

{"status":"1","comment":"","data":{"contact":{"id":"1665","url":"http:\/\/192.168.0.10\/crm\/contact.php?id=1665","name":"\u0418\u0432\u0430\u043d \u0418\u0432\u0430\u043d\u043e\u0432","email":"ivan@example.com","photo":"http:\/\/192.168.0.10\/crm\/contact_foto.png?id=1665"},"company":{"id":"1587","url":"http:\/\/192.168.0.10\/crm\/company.php?id=1587","title":"\u0420\u043e\u0433\u0430 \u0438 \u043a\u043e\u043f\u044b\u0442\u0430","email":"info@example.com","logo":"http:\/\/192.168.0.10\/crm\/company_logo.png?id=1587"},"lead":{"id":"111","url":"http:\/\/192.168.0.10\/crm\/lead.php?id=111","title":"\u0417\u0430\u043f\u0440\u043e\u0441 \u043d\u0430 \u0441\u0432\u0438\u043d\u043d\u0443\u044e \u0433\u0440\u0443\u0434\u043a\u0443","email":"info@example.com"},"deal":{"id":"243","url":"http:\/\/192.168.0.10\/crm\/deal.php?id=243","title":"35 \u0413\u043e\u043b\u043e\u0432 \u0431\u044b\u043a\u0430"}}}

(warning) Обрабатывается только первый запрос. Он сохраняется в памяти браузера.


 

Загрузка звонков

(warning) Для хранения звонков используется отдельная база данных. Это предназначено для того, чтобы справляться с большим количеством запросов. Мы иначе собираем данные в эту базу, поэтому список будет более полным и может отличаться от истории из панели управления. Список звонков, доступных по API, находится по адресу: https://panel2.onlinepbx.ru/calls.php

Таблица параметров запроса:

ПараметрПримечаниеОписание параметра
action Тип запроса
data Массив звонков
id Идентификатор звонка в базе
uuid UUID звонка (для получения записи и поиска через апи)
caller Номер звонящего
callee Добавочный номер того, кому звонили
trunk Номер транка
start_stamp timestamp начала звонка
duration Общая продолжительность звонка в секундах
billsec Время разговора после ответа в секундах
type Тип звонка - inbound/outbound/local

Таблица параметров ответа:

ПараметрПримечаниеОписание параметра
status 1- успешно, 0 - неуспешно
comment Комментарий или ошибка
data Массив с результатами обработки
id Идентификатор звонка из запроса
call_id Идентификатор звонка в базе или false
lead_id Идентификатор лида если создан или false
contact_id Идентификатор контакта если создан или false
Запрос

POST /api/ HTTP/1.1
Host: custom_crm.onlinepbx.ru
Accept: */*
Content-Length: 882
Content-Type: application/x-www-form-urlencoded

action=call_upload&data%5B0%5D%5Bid%5D=23&data%5B0%5D%5Buuid%5D=544aa79c-da7e-4c59-bebf-f289dc6ccd20&data%5B0%5D%5Bcaller%5D=100&data%5B0%5D%5Bcallee%5D=9197&data%5B0%5D%5Bstart_stamp%5D=1476789142&data%5B0%5D%5Bduration%5D=10&data%5B0%5D%5Bbillsec%5D=10&data%5B0%5D%5Btype%5D=local&data%5B0%5D%5Btrunk%5D=&data%5B1%5D%5Bid%5D=24&data%5B1%5D%5Buuid%5D=e53817e3-57b7-457b-94a9-ef319223e4a9&data%5B1%5D%5Bcaller%5D=100&data%5B1%5D%5Bcallee%5D=5300&data%5B1%5D%5Bstart_stamp%5D=1476789156&data%5B1%5D%5Bduration%5D=12&data%5B1%5D%5Bbillsec%5D=12&data%5B1%5D%5Btype%5D=local&data%5B1%5D%5Btrunk%5D=&data%5B2%5D%5Bid%5D=25&data%5B2%5D%5Buuid%5D=5e38b27b-2b0e-4247-aae2-0db88d1857e8&data%5B2%5D%5Bcaller%5D=100&data%5B2%5D%5Bcallee%5D=9196&data%5B2%5D%5Bstart_stamp%5D=1476789173&data%5B2%5D%5Bduration%5D=13&data%5B2%5D%5Bbillsec%5D=13&data%5B2%5D%5Btype%5D=local&data%5B2%5D%5Btrunk%5D=

(warning) Запрос на загрузку звонков осуществляется каждые 5 минут.

(warning) Максимальное количество звонков за один запрос — 30.

(warning) Запросы будут отправляться до тех пор, пока не придёт ответ об успешном получении звонка.

Ответ

HTTP/1.1 200 OK
Date: Tue, 18 Oct 2016 11:15:13 GMT
Server: Apache
Content-Length: 231
Content-Type: application/json

{"status":"1","comment":"","data":[{"id":"23","call_id":5968148,"lead_id":71026,"contact_id":74507},{"id":"24","call_id":1768776,"lead_id":92923,"contact_id":91800},{"id":"25","call_id":4516404,"lead_id":46212,"contact_id":34759}]}

 

 

К содержанию


 

Создание контакта

Таблица параметров запроса:

ПараметрПримечаниеОписание параметра
action Тип запроса
data Информация по контакту
name Имя контакта
phone Номер телефона
comment Комментарий
company_name 

Имя компании, в которой состоит контакт. Если такой не существует, то её нужно создать.

Таблица параметров ответа:

ПараметрПримечаниеОписание параметра
status 1- успешно, 0 - неуспешно
comment Комментарий или ошибка
data Результат обработки
contact_id Идентификатор контакта или fals
company_id Идентификатор компании или false
Запрос

POST /api/ HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 200
Host: custom_crm.onlinepbx.ru
Connection: close

action=create_contact&data[name]=%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2&data[phone]=0123456789&data[comment]=%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9

Ответ

HTTP/1.1 200 OK
Date: Tue, 18 Oct 2016 09:53:55 GMT
Server: Apache
Content-Length: 73
Connection: close
Content-Type: application/json

{"status":"1","comment":"","data":{"contact_id":12543,"company_id":6582}}

К содержанию


 

Создание Лида

Таблица параметров запроса:

ПараметрПримечаниеОписание параметра
action Тип запроса
data Информация по Лиду
name Имя контакта
phone Номер телефона
comment Комментарий
user_id Идентификатор пользователя, за которым будет закреплён лид

Таблица параметров ответа:

ПараметрПримечаниеОписание параметра
status 1- успешно, 0 - не успешно
comment Комментарий или ошибка
data Результат обработки
lead_id Идентификатор созданного лида или false
Запрос

POST /api/ HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 219
Host: custom_crm.onlinepbx.ru
Connection: close

action=create_lead&data[name]=%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2&data[phone]=0123456789&data[comment]=%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9&data[user_id]=5648527

Ответ

HTTP/1.1 200 OK
Date: Tue, 18 Oct 2016 10:01:28 GMT
Server: Apache
Content-Length: 52
Connection: close
Content-Type: application/json

{"status":"1","comment":"","data":{"lead_id":53317}}

К содержанию


 

Показать список пользователей

Таблица параметров запроса:

ПараметрПримечаниеОписание параметра
action Тип запроса
Запрос

POST /api/ HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 17
Host: custom_crm.onlinepbx.ru
Connection: close

action=list_users

Таблица параметров ответа:

ПараметрПримечаниеОписание параметра
status 1- успешно, 0 - неуспешно
comment Комментарий или ошибка
data Массив с пользователями
id Идентификатор пользователя
name Имя пользователя
phone Добавочный номер пользователя
photo Ссылка на фото
Ответ

HTTP/1.1 200 OK
Date: Tue, 18 Oct 2016 10:52:30 GMT
Server: Apache
Content-Length: 385
Connection: close
Content-Type: application/json

{"status":"1","comment":"","data":[{"id":"68554","name":"\u0418\u0432\u0430\u043d \u0418\u0432\u0430\u043d\u043e\u0432","phone":"01234568","photo":"http:\/\/192.168.0.10\/crm\/contact_foto.png?id=1665"},{"id":"26854","name":"\u041f\u0451\u0442\u0440 \u041f\u0435\u0442\u0440\u043e\u0432\u0438\u0447","phone":"987654321","photo":"http:\/\/192.168.0.10\/crm\/contact_foto.png?id=1571"}]}

К содержанию


 

Добавить комментарий к звонку

Таблица параметров запроса:

ПараметрПримечаниеОписание параметра
action Тип запроса
call_id Идентификатор звонка в базе
text Текст комментария

Таблица параметров ответа:

ПараметрПримечаниеОписание параметра
status 1- успешно, 0 - не успешно
comment 

Комментарий или ошибка

Запрос

POST /api/ HTTP/1.1
Host: custom_crm.onlinepbx.ru
Accept: */*
Content-Length: 127
Content-Type: application/x-www-form-urlencoded

action=comment_call&0%5Bcall_id%5D=8.0500058E+14&0%5Btext%5D=%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9

Ответ

HTTP/1.1 200 OK
Date: Tue, 18 Oct 2016 11:30:30 GMT
Server: Apache
Content-Length: 27
Content-Type: application/json

{"status":"1","comment":""}

 

 

К содержанию

Write a comment…