Документация API по услуге "Отправка кодов в голосовом сообщении при звонке": различия между версиями
Artemt (обсуждение | вклад) (API инструкция Код по звонку) |
Admin (обсуждение | вклад) |
||
(не показаны 4 промежуточные версии 2 участников) | |||
Строка 2: | Строка 2: | ||
<br /> | <br /> | ||
Пример запроса: | Пример запроса: | ||
− | https://neocomms.ru/codesay_api/call.php?apiKey=354b84059216d758c591a9fc3882a570&phone= | + | https://neocomms.ru/codesay_api/call.php?apiKey=354b84059216d758c591a9fc3882a570&phone=79031111111 |
'''Обязательные параметры:''' | '''Обязательные параметры:''' | ||
<br /> | <br /> | ||
− | ''apiKey'' - Ваш ключ из личного кабинета | + | *''apiKey'' - Ваш ключ из личного кабинета |
+ | *''phone'' - Номер телефона куда звонить (11 цифр в международном формате без знака «+». Допустимы только российские номера, т.е. номер должен начинаться с цифры «7»). | ||
+ | |||
+ | '''Необязательный параметр:''' | ||
<br /> | <br /> | ||
− | + | *''code'' - код (3 или 4 цифры) для воспроизведения его синтезированным голосом. Если его нет в запросе, код будет сгенерирован из 3-х случайных цифр. | |
− | + | ||
− | ''code'' - | + | Ответ возвращается всегда в виде JSON-массива, первый элемент которого называется "''status''" и может принимать значения: |
− | + | *''ok'' - звонок отправлен | |
+ | *''error'' - произошла ошибка | ||
− | ok | + | В случае успеха (status=ok) , второй элемент массива, который называется "''code''", содержит код, который будет озвучен клиенту. Затем предпримается попытка звонка на указанный в запросе номер и синтезированным голосом произнесен код. |
− | |||
− | |||
− | В случае, если произошла ошибка (status=error), то второй элемент, который называется reason содержит краткое название ошибки. | + | В случае, если произошла ошибка (status=error), то второй элемент, который называется "''reason''" содержит краткое название ошибки. |
<br /> | <br /> | ||
Возможные ошибки: | Возможные ошибки: | ||
− | invalidParams - не переданы обязательные параметры (apiKey, phone) | + | *invalidParams - не переданы обязательные параметры (apiKey, phone) |
− | + | *invalidApiKey – неверный apiKey | |
− | invalidApiKey – неверный apiKey | + | *invalidPhone - телефон не состоит из 11 цифр или не является российским |
− | + | *lowBalance – у вас нулевой баланс, докупите звонков в личном кабинете | |
− | invalidPhone - телефон не состоит из 11 цифр или не является российским | ||
− | |||
− | lowBalance – у вас нулевой баланс, докупите звонков в личном кабинете | ||
− | |||
− | |||
Если клиент не ответил на звонок, или сбросил вызов не подняв трубку, дозвон будет продолжаться. | Если клиент не ответил на звонок, или сбросил вызов не подняв трубку, дозвон будет продолжаться. |
Текущая версия на 16:47, 20 сентября 2017
Для звонка необходимо обратится методом HTTP-GET к скрипту https://neocomms.ru/codesay_api/call.php
Пример запроса:
https://neocomms.ru/codesay_api/call.php?apiKey=354b84059216d758c591a9fc3882a570&phone=79031111111
Обязательные параметры:
- apiKey - Ваш ключ из личного кабинета
- phone - Номер телефона куда звонить (11 цифр в международном формате без знака «+». Допустимы только российские номера, т.е. номер должен начинаться с цифры «7»).
Необязательный параметр:
- code - код (3 или 4 цифры) для воспроизведения его синтезированным голосом. Если его нет в запросе, код будет сгенерирован из 3-х случайных цифр.
Ответ возвращается всегда в виде JSON-массива, первый элемент которого называется "status" и может принимать значения:
- ok - звонок отправлен
- error - произошла ошибка
В случае успеха (status=ok) , второй элемент массива, который называется "code", содержит код, который будет озвучен клиенту. Затем предпримается попытка звонка на указанный в запросе номер и синтезированным голосом произнесен код.
В случае, если произошла ошибка (status=error), то второй элемент, который называется "reason" содержит краткое название ошибки.
Возможные ошибки:
- invalidParams - не переданы обязательные параметры (apiKey, phone)
- invalidApiKey – неверный apiKey
- invalidPhone - телефон не состоит из 11 цифр или не является российским
- lowBalance – у вас нулевой баланс, докупите звонков в личном кабинете
Если клиент не ответил на звонок, или сбросил вызов не подняв трубку, дозвон будет продолжаться.
Всего будет совершено до 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); ?>