Документація 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}