Для работы с API нужна авторизация.
Для авторизации необходимо:
- Получить токен
Для получения токена надо сформировать POST запрос
в запросе ожидаются параметры:
email - e-mail адрес, например just@example.ru
password - пароль, например 1234567890
Пары email/password должны быть установлены нами предварительно.
Пример данных запроса в формате json:
{"email": "just@example.ru", "password": "1234567890"}
ответ:
{"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTYyNzMwOTI3MiwianRpIjoiNDc1OGFjMGMtYjEzZi00NTE0LTlmNTEtZWI3MzNmYmNlYWFlIi"}
Полученный токен имеет время жизни 24 часа.
2. При запросах к API в заголовке должен присутствовать параметр Authorization.
Формат: Bearer <токен>
напрмер:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTYyNzMwOTI3MiwianRpIjoiNDc1OGFjMGMtYjEzZi00NTE0LTlmNTEtZWI3MzNmYmNlYWFlIi
Запрос на инициирование авторизации входящим звонком
Инициирование авторизации - POST запрос.
в запросе ожидаются параметры:
srcNumber - номер с которого ожидается вызов в формате e164, 9-15 цифр, первой цифрой не должен быть 0, например 79871234567
timeout – таймаут, определяющий время ожидания авторизации в секундах. Если параметр не указан, значение по умолчанию 30 сек.
cbUrl - ссылка, по которой будет сделан запрос при успешной авторизации
Пример данных запроса в формате json:
{"srcNumber": "79871234567", "cbUrl": "https://none.none.ru", "timeout": "60"}
Данные ответа:
- параметр status - код завершения операции.
Общая классификация соответствует кодам завершения HTTP:
2xx: успешно
4xx, 5xx: ошибка при выполнении операции
- параметр message - присутствует в случае завершения с ошибкой и содержит ее краткое описание
- объект callDetails,
содержащий параметры:
callId – уникальный идентификатор авторизации, строка
dstNumber – номер, на который ожидается вызов для авторизации
timeout - копирует значение из запроса
srcNumber - копирует значение из запроса
Пример данных в ответе:
{"callDetails": {"callId": "64C6FD42-DE9E-11ED-A41E-9B22F56616F3", "cbUrl": "https://none.none.ru", "dstNumber": "74993011016", "srcNumber": "79871234567", "timeout": "60"}, "status": "200"}
Пример сообщения об ошибке:
{"message": "Token has expired"}
При поступлении вызова с номера srcNumber на номер dstNumber, до истечения времени жизни запроса, будет осуществлен HTTP POST запрос по ссылке из cbUrl (webhook).
Параметры в теле запроса:
callId – уникальный идентификатор авторизации, строка
dstNumber – номер, на который поступил вызов
srcNumber - номер с которого поступил вызов
Пример тела запроса:
{"callId": "64C6FD42-DE9E-11ED-A41E-9B22F56616F3", "dstNumber": "74993011016", "srcNumber": "79871234567"}
Ответы на данные запросы системой не обрабатываются.