Дата создания документации - 22.11.2022
Дата последнего редактирования документации - 22.11.2022
Текущая версия документации - 1,0



Что такое Click2Call API


Click2Call API - это интерфейс, сделанный для разработчиков, желающих предоставить функцию мгновенного звонка без ручного набора номера для своих клиентов с использованием номеров и мобильного приложения SipSim. 


Маршруты и аутентификация


Для обеспечения интеграции со внешними системами, необходимо настроить отправку запросов на адрес сервера SipSim. Адрес сервера выдается по запросу технической командой SipSim.


Тип данныхСпособ получения
URLВыдается по запросу, технической службой SipSim


Для обеспечения аутентификации используются токены аутентификации:


ПараметрСпособ получения
crm_tokenВыдается технической службой SipSim единоразово разработчику, который решил реализовать Click2Call.

Необходим для идентификации разработчика.

Пример: aSdft12345QWEAS54211f
token Генерируется в личном кабинете SipSim, в разделе Интеграции →  API Click2Call. 

Необходим для идентификации клиента разработчика.

Пример: aSdft12345QWEAS54211f 



Структура запросов

Мы поддерживаем GET метод. Данные передаются в формате JSON. 


Ответ содержит JSON объект, который содержит одно из значений, перечисленное в секции Возвращаемые значения. 


Необязательные параметры могут быть пустыми или отсутствовать.

Ниже представлено описание основных параметров, которые должны быть включены в запрос: 


GET

 

Параметр

Тип данных

Описание

Обязательный/Необязательный параметр

crm_name 

string

Имя CRM, выдается технической службой SipSim единоразово разработчику, который решил реализовать Click2Call.

Обязательный параметр
crm_token 

string

Токен разработчика, необходимый для аутентификации. Выдается технической службой SipSim единоразово разработчику, который решил реализовать Click2Call.

Обязательный параметр

token 

string

Токен клиента разработчика, генерируется в личном кабинете SipSim, в разделе Интеграции →  API Click2Call.

Обязательный параметр

caller 

string

Номер телефона SipSim, с которого будет поступать вызов, в международном формате.Обязательный параметр

receiver 

string

Номер телефона, на который будет поступать вызов, в международном формате.Обязательный параметр

PBX_ID 

string

Уникальный идентификатор звонка, сгенерированный самим разработчиком. Необходим для идентификации каждого конкретного звонка. Обязательный параметр
crm_username

string

Имя клиента в CRM разработчика.Обязательный параметр
crm_user_email

string

Адрес электронной почты клиента в CRM разработчика.Необязательный параметр


Пример запроса:

{
"crm_name": "CRMNAME",   
"crm_token": "aSdft12345QWEAS54211f",    
"token": "aSdft12345QWEAS54211f",    
"caller": "+375291111111",    
"receiver": "+375291111111", 
"pbx_id": "asd123wqda12"
"crm_username": "Евгений Алёхин",
"crm_user_email": "user228@gmail.com"
}
Ruby
Ruby
Ruby

Пример успешного ответа: 

{
"status_code":200,
"success":true,
"message":"Request accepted"
}
Ruby
Ruby
Ruby

Пример ответа в случае непрохождения авторизации:

{
"status_code":500,
"success":false,
"message":"crm_token is required param, crm_name is required param, token is required param, something went wrong"
}
Ruby
Ruby
Ruby

Пример ответа в случае прохождения авторизации, но при отсутствии основных параметров:

{
"status_code":500,
"success":false,
"message":"caller is required param, receiver is required param, pbx_id is required param, crm_username is required param, invalid caller number, invalid receiver number, something went wrong"
}
Ruby
Ruby

Пример ответа в случае если на телефоне не установлено приложение:

{
"status_code":400,
"success":false,
"message":"Invalid device token of uninstalled app"
}

Ограничения на отправку событий

В стандартной конфигурации на отправку событий распространяются следующие ограничения:


Период действия ограниченияМаксимальное количество событий
1 минута100


При превышении лимита количества значений будет произведена блокировка отправки событий на 10 минут.  Лимит действует на конкретный токен. Стандартные ограничения могут меняться в процессе развития продукта.


Что если телефон выключен?

Если при отправке запроса приложение было установлено, но телефон выключен или вне зоны действия сети, ответ будет успешным. 


Для корректной работы сервиса после выключения или перезагрузки устройства рекомендуется вручную открыть приложение SipSim.


Дополнительная информация

 Инструкция по мобильному приложению SipSim (ссылка).