Документация api sender id — smsgateway24

Документация | SmsGateway24.com

v.1.0

1. Получение токена:

Описание: При успешном выполнении этого запроса вы получите токен. Затем с его помощью можно обращаться к серверу и делать другие запросы.
Эндпойнт: https://smsgateway24.com/getdata/gettoken
Метод:: GET
Параметры запроса:
Переменная Тип Описание
email string [обязательный] Your login in the system. Usually email
pass string [обязательный] Your password in the system

Ответ в формате JSON::
Переменная Тип Описание
token string Токен получается через метод получения токена:
error int 0 | 1 — указывает, произошла ли ошибка при обработке запроса
message string Сообщение об ошибке; пустое, если всё в порядке.
Ссылка на пример кода на Curl
Ссылка на пример кода на Guzzle
Пример ответа:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f41119fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

2. Отправка SMS с использованием Sender ID. (POST)

Описание: После того как вы запросили Sender ID для своей компании, вы можете отправлять SMS через API-запросы.
Эндпойнт: https://smsgateway24.com/getdata/addsmstosenderid
Метод:: POST
Параметры запроса в виде JSON, например:
{
    "token":"5f0eb980819f0e07b9b14d5dsacxzc6a",
    "send_to":"+4915752982212",
    "sender_id":"2",
    "template_id":"9",
    "webhook_callback_url":"https://webhook.site/5557129a-8513-4cb8-ae2e-8aa17a5bb957",
    "template_data":{
        "var_1":"John",
        "order":"777"
    }
}

Где:
Переменная Тип Описание
token string [обязательный] Токен получается через метод получения токена.
send_to string [обязательный] Номер телефона клиента. Например: +4915752982212
sender_id string [обязательный] Идентификаторы ваших Sender ID. Найти свои Sender ID можно здесь: Sender ID list
template_id string [обязательный] Получить ID своих шаблонов можно здесь:Template list
webhook_callback_url string [необязательно] Укажите URL своего сервера, чтобы получать обратные вызовы
template_data json [необязательно] Имена ваших динамических переменных.

Ответ в формате JSON::
Переменная Тип Описание
token string Токен получается через метод получения токена:
error int 0 | 1 — указывает, произошла ли ошибка при обработке запроса
message string Сообщение об ошибке; пустое, если всё в порядке.
cost float Стоимость SMS
Пример ответа:
{"error":0,"sms_id":63752087,"message":"Sms has been saved successfully","cost":0.068}

3. Отправка SMS с использованием Sender ID. (GET)

Описание: После того как вы запросили Sender ID для своей компании, вы можете отправлять SMS через API-запросы.
Эндпойнт: https://smsgateway24.com/getdata/addsmstosenderid
Метод:: GET
Параметры запроса в виде JSON, например: Где:
Переменная Тип Описание
token string [обязательный] Токен получается через метод получения токена.
send_to string [обязательный] Номер телефона клиента. Например: +4915752982212
sender_id string [обязательный] Идентификаторы ваших Sender ID. Найти свои Sender ID можно здесь: Sender ID list
template_id string [обязательный] Получить ID своих шаблонов можно здесь:Template list
webhook_callback_url string [необязательно] Укажите URL своего сервера, чтобы получать обратные вызовы
template_data_as_string json [необязательно] Имена ваших динамических переменных.

Ответ в формате JSON::
Переменная Тип Описание
token string Токен получается через метод получения токена:
error int 0 | 1 — указывает, произошла ли ошибка при обработке запроса
message string Сообщение об ошибке; пустое, если всё в порядке.
cost float Стоимость SMS
Пример запроса:
https://smsgateway24.com/getdata/addsmstosenderid?token=5f0eb980819f0e07b9b1432132131d&send_to=+4915752982212&sender_id=1&template_id=8&template_data_as_string={"order":"order1","date":"010202"}

Пример ответа:
{"error":0,"sms_id":63752087,"message":"Sms has been saved successfully","cost":0.068}