Документация API по услуге "Отправка кодов в голосовом сообщении при звонке": различия между версиями
Artemt (обсуждение | вклад) (API инструкция Код по звонку) |
Admin (обсуждение | вклад) м (Admin переименовал страницу Инструкция по API по услуге "Код в звонке" в [[Документация API по услуге "Отправка кодов в голосовом сообщении пр…) |
(нет различий)
|
Версия 16:32, 20 сентября 2017
Для звонка необходимо обратится методом HTTP-GET к скрипту https://neocomms.ru/codesay_api/call.php
Пример запроса:
https://neocomms.ru/codesay_api/call.php?apiKey=354b84059216d758c591a9fc3882a570&phone=79031...
Обязательные параметры:
apiKey - Ваш ключ из личного кабинета
phone - Номер телефона куда звонить (11 цифр в международном формате без знака «+». Допустимы только российские номера, т.е. номер должен начинаться с цифры «7»).
code - Код (4 цифры) для воспроизведения его синтезированным голосом. Параметр "code" необязателен. Если его нет в запросе, код будет сгенерирован из 4-х случайных цифр.
Ответ возвращается всегда в виде JSON-массива, первый элемент которого называется status и может принимать значения:
ok - звонок отправлен
error - произошла ошибка
В случае, если произошла ошибка (status=error), то второй элемент, который называется reason содержит краткое название ошибки.
Возможные ошибки:
invalidParams - не переданы обязательные параметры (apiKey, phone)
invalidApiKey – неверный apiKey
invalidPhone - телефон не состоит из 11 цифр или не является российским
lowBalance – у вас нулевой баланс, докупите звонков в личном кабинете
В случае успеха (status=ok) , второй элемент массива, который называется "code", содержит код, который будет озвучен клиенту. Затем предпримается попытка звонка на указанный в запросе номер и синтезированным голосом произнесен код.
Если клиент не ответил на звонок, или сбросил вызов не подняв трубку, дозвон будет продолжаться.
Всего будет совершено до 3-х попыток звонка. Длительность ожидания поднятия трубки - 30 секунд.
Безопасность
Для того чтобы apiKey не украли и не вызвонили все деньги на вашем балансе, рекомендуем обращаться к API не с помощью AJAX, а с сервера, например с помощью cURL:
<?php $curl = curl_init (); curl_setopt ($curl, CURLOPT_URL, "https://neocomms.ru/codesay_api/call.php? apiKey=354b84059216d758c591a9fc3882a570&phone=79031234567&code=4375"); curl_setopt ($curl, CURLOPT_RETURNTRANSFER, 1); curl_setopt ($curl, CURLOPT_TIMEOUT, 30); curl_setopt ($curl, CURLOPT_CUSTOMREQUEST, "GET"); echo curl_exec ($curl); ?>