Api документації

Документація | 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
Посилання на код пазлу
Приклад відповіді:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f41119fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

2. Надіслати одне SMS на TOKEN:

Опис: Генерує SMS-повідомлення на сервері, що колективно надсилається одним пакетом. Дозволяє створювати кілька SMS-повідомлень одночасно за одним запитом.
Кінцева точка: https://smsgateway24.com/getdata/addsms
Метод:: GET, POST ( Використовувати %2B замість знака плюс '+' в запиті GET )
Параметри запиту:
Змінна Тип Опис
token string [обов’язково] Ваш токен отримати через метод отримання.
sendto string [обов’язково]Номер телефону абонента. Всі символи дозволені. Наприклад: +4915752982212 + 4917642111111 +1 17642031984. Крім того, декілька чисел можуть бути визначені комами.
body string [обов’язково] Текст повідомлення
device_id string [обов’язково] Ідентифікатор пристрою
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[необов'язково] Часу визначено для надсилання повідомлення. Наприклад, 2024-04-15 03:53:51
sim int, default = 0 [необов'язково] SIM slot # 0 or 1
customerid int [необов'язково] ID вашого покупця. Необов'язкове поле.
urgent int [необов'язково] SMS, позначені як невідкладні. Це поле не обов'язкове. SMS буде відправляти з пріоритетом, а воно може бути корисним при надсиланні одноразових паролів (OTP).

JSON-форматована відповідь::
Змінна Тип Опис
token string Ваш токен набутий через метод отримання токена:
error int 0 | 1 - показує чи є помилка при обробці запиту
message string Повідомлення про помилку, порожнє, якщо все в порядку.
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

2.1 Надіслати поодинокі SMS використовуючи логін та пароль:

Опис: Генерує SMS-повідомлення на сервері, що колективно надсилається одним пакетом. Дозволяє створювати кілька SMS-повідомлень одночасно за одним запитом.
Кінцева точка: https://smsgateway24.com/getdata/smstosend
Метод:: GET, POST ( Використовувати %2B замість знака плюс '+' в запиті GET )
Параметри запиту:
Змінна Тип Опис
email string [обов’язково] Адреса електронної пошти
pass string [обов’язково] Ваш пароль
sendto string [обов’язково]Номер телефону абонента. Всі символи дозволені. Наприклад: +4915752982212 + 4917642111111 +1 17642031984. Крім того, декілька чисел можуть бути визначені комами.
body string [обов’язково] Текст повідомлення
device_id string [обов’язково] Ідентифікатор пристрою
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[необов'язково] Часу визначено для надсилання повідомлення. Наприклад, 2024-04-15 03:53:51
sim int, default = 0 [необов'язково] SIM slot # 0 or 1
customerid int [необов'язково] ID вашого покупця. Необов'язкове поле.
urgent int [необов'язково] SMS, позначені як невідкладні. Це поле не обов'язкове. SMS буде відправляти з пріоритетом, а воно може бути корисним при надсиланні одноразових паролів (OTP).

JSON-форматована відповідь::
Змінна Тип Опис
token string Ваш токен набутий через метод отримання токена:
error int 0 | 1 - показує чи є помилка при обробці запиту
message string Повідомлення про помилку, порожнє, якщо все в порядку.
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді:
{ "error": 0, "sms_id": 62807347, "message": "Sms has been saved successfully"}

3. Надсилання SMS з масовим використанням JSON

Опис: Створює SMS на сервері, щоб надіслати. Після цього, телефон з програмою Smsgateway24 дзвонить із сервера та надсилає його з власної SIM-карти за посиланням
Кінцева точка: https://smsgateway24.com/getdata/addalotofsms
Метод:: GET, POST
Параметри запиту:
Змінна Тип Опис
datajson string [обов’язково] {"token":"df427bfcf113c9a21c67718035076b5b","smsdata":[{"sendto":"015752982212","body":"Test message","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260},{"sendto":"+4915752982212","body":"Test message 2","sim":1,"timetosend":"2019-07-01 23:50:00","device_id":260,"urgent":1}]}

JSON-форматована відповідь::
Змінна Тип Опис
error int 0 | 1 - показує чи є помилка при обробці запиту
message string Повідомлення про помилку, порожнє, якщо все в порядку.
Посилання на код приклади Curl
Посилання на код пазлу
Request example:
{ "token":"df427bfcf113c9a21c6771803501", "smsdata":[ { "sendto":"015752982212", "body":"Your password is 12345", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":1 }, { "sendto":"015752982212", "body":"Regular SMS. Not urgnet", "sim":1, "timetosend":"2019-07-01 23:50:00", "device_id":260, "customerid":122, "urgent":0 } ] }

4. Отримати всі SMS (включно з вхідними SMS):

Опис: Цей запит дозволяє отримати всі повідомлення, пов'язані з вашим аккаунтом, у тому числі вхідні смс від клієнтів. Всі змінні для вводу є обов'язковими в цьому методі, і SMS-повідомлення можуть змінюватися в залежності від статусу.
Endpoint: https://smsgateway24.com/getdata/getallsms
Метод: GET, POST (Використовувати %2B замість знака "+" в GET запиті)
Параметри запиту:
Змінна Тип Опис
token string [обов’язково] Ваш токен отримати через метод отримання.
device_id string [необов'язково] Ідентифікатор пристрою
status int [необов'язково]
  • 1 - В очікуванні SMS
  • 2 - SMS взято по телефону
  • 3 - У черзі для надсилання. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - Вхідні SMS
  • 6 - SMS відправлено телефоном
  • 7 - SMS доставлено
  • 8 - SMS НЕ доставлено
  • 9 - SMS, узагалі не визначено - загальна помилка. (Прочитайте що робити з цією помилкою сюди)
  • Можливо менш поширені помилки:
  • 10 - SMS не надіслано - No Service
  • 11 - SMS не надіслано - Null PDU
  • 12 - SMS не надіслано - Radio Off
  • 100, 101 - SMS не надіслано - NOT ALLOWED. (Дозволи на надсилання SMS у програмі не надано)
begindate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[необов'язково] Begin Date Time
enddate string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[необов'язково] End Date Time
sim int [необов'язково] SIM slot # 0 or 1
customerid int [необов'язково] ID вашого покупця. Необов'язкове поле
onlycount int [необов'язково] 0 | 1 тільки для
phone string [необов'язково] 0 | 1 Фільтр номерів телефонів
orderbydesc int [необов'язково] 0 | 1 Order by any field
timezone int [необов'язково] Укажіть місцевий часовий пояс, наприклад, такі як налаштування його в Австралію/Сідней.

JSON-форматована відповідь::
Змінна Тип Опис
token string Ваш токен набутий через метод отримання токена:
error int 0 | 1 - показує чи є помилка при обробці запиту
message string Повідомлення про помилку, порожнє, якщо все у порядку
count int SMS amount
smss int JSON object
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді ... :
{ "smss": { "62050971": { "id": 62050971, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 2, "statustitle": "sending", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:44:43.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null }, "62051117": { "id": 62051117, "sendto": "+4912312312332", "body": "Hello! Thank you for Order! ", "customerid": null, "status": 7, "statustitle": "delivered", "deviceid": 11231, "urgent": null, "created": { "date": "2023-11-02 22:46:09.000000", "timezone_type": 3, "timezone": "Europe/Paris" }, "senttime": null, "timetosend": null, "paketid": null, "pakettitle": null, "paketbody": null } } }

5. Додати новий список контактів

Опис: Для створення групи чисел потрібен тег для створення бюлетеня. Наприклад, використовуйте співробітників тегу
Кінцева точка: https://smsgateway24.com/getdata/savetag
Метод:: GET, POST
Параметри запиту:
Змінна Тип Опис
token string [обов’язково] Ваш токен отримати через метод отримання.
title string [обов’язково] Назва тегу

JSON-форматована відповідь::
Змінна Тип Опис
tag_id int Tag ID
error int 0 | 1 - показує чи є помилка при обробці запиту
message string Повідомлення про помилку, порожнє, якщо все в порядку.
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді:
{ "error": 0, "tag_id": 8303, "message": "OK" }

6. Додати контакти до списку контактів:

Опис: Додайте контакти для будь-якого тегу. Наприклад, для тегу * Співробітників * будуть відмінно підходити до тегу.
Кінцева точка: https://smsgateway24.com/getdata/savecontact
Метод:: GET, POST
Параметри запиту:
Змінна Тип Опис
token string [обов’язково] Ваш токен отримати через метод отримання.
phone string [обов’язково] phone number
ctag_id int [обов’язково] Tag ID
fullname string [обов’язково] Ім'я покупця

JSON-форматована відповідь::
Змінна Тип Опис
contact_id int Contact Id
error int 0 | 1 - показує чи є помилка при обробці запиту
message string Повідомлення про помилку, порожнє, якщо все в порядку.
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді ... :
{"error":0,"contact_id":15954765,"message":"ok"}

7. Створити інформаційний бюлетень

Опис:Після створення тегу, ви можете вказати пошту на телефоні із цим тегом.
Кінцева точка: https://smsgateway24.com/getdata/savepaket
Метод:: GET, POST
Параметри запиту:
Змінна Тип Опис
token string [обов’язково] Ваш токен отримати через метод отримання.
title string [обов’язково] Заголовок інформаційного бюлетеня
device_id string [обов’язково] Ідентифікатор пристрою
body string [обов’язково] Тіло цільового повідомлення
tags string [обов’язково] Тег Id. Може бути розділений комами. Наприклад: 12,13,14
sim int, default = 0 [обов’язково]номер гнізду для сигнальної камери в телефоні: 0 or 1
time_to_send int, default = 0 [обов’язково]Date time when Newsletter should be sent. Do not forget tap start on device. DD.MM.YYYY H:i:s

JSON-форматована відповідь::
Змінна Тип Опис
contact_id int Id контакту
error int 0 | 1 - показує чи є помилка при обробці запиту
message string Повідомлення про помилку, порожнє, якщо все в порядку.
paket_id int Package ID
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді ... :
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}

8. Отримати список пристроїв

Опис: Ви можете дізнатися все про ваші пристрої.
Кінцева точка: https://smsgateway24.com/getdata/getalldevices
Метод:: GET, POST
Параметри запиту:
Змінна Тип Опис
token string [обов’язково] Ваш токен отримати через метод отримання.

JSON-форматована відповідь::
Змінна Тип Опис
count int Кількість пристроїв:
device json
  • id - Ідентифікатор пристрою
  • title - Ім'я пристрою
  • created - Дата створення пристрою
  • createdhumanformat - Дата створення пристрою в регулярному форматі
  • lastseen - Дата останнього перегляду пристрою
  • lastseenhumanformat - Дата останнього перегляду пристрою
  • serialnumber - Серійний номер пристрою
  • siminfo - Інформація про SIM-карту в форматі JSON
  • appversion - Версія додатка, встановлена на пристрої
  • subscription - Підписка на пристрої
message string Повідомлення про помилку, порожнє, якщо все в порядку.
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді:
    {
    "count": 2,
    "device": {
        "1576": {
            "id": 1576,
            "title": "AOSP_on_IA_Emulator",
            "number": null,
            "imei": "358240051111110",
            "created": {
                "date": "2020-03-28 20:10:29.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "28.03.2020 20:10:29",
            "lastseen": {
                "date": "2020-04-23 17:02:21.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "23.04.2020 17:02:21",
            "serialnumber": "EMULATOR30X0X5X0",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "89014103211118510720",
                    "Number": " 15555215554",
                    "Roaming": "0",
                    "CountryIso": "us",
                    "CarrierName": "Android (T-Mobile)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": null,
            "delaybetweenrequest": 1,
            "subscription": true
        },
        "1297": {
            "id": 1297,
            "title": "Android_SDK_built_for_x86",
            "number": null,
            "imei": "null",
            "created": {
                "date": "2020-01-20 14:01:05.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "createdhumanformat": "20.01.2020 14:01:05",
            "lastseen": {
                "date": "2020-04-20 20:51:34.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "lastseenhumanformat": "20.04.2020 20:51:34",
            "serialnumber": "unknown",
            "siminfo": [
                {
                    "Slot": "0",
                    "IccId": "8949226172233934327",
                    "Number": "+4915752982212",
                    "Roaming": "1",
                    "CountryIso": "de",
                    "CarrierName": "Drillisch (o2)"
                }
            ],
            "appversion": "12.1.21",
            "isappversionactual": false,
            "delaybetweeneachsms": 5,
            "delaybetweenrequest": 10,
            "subscription": false
        }
    }
}

9. Отримати статус доставки одних SMS

Опис: Ви можете знайти статус доставки кожної з SMS через цей метод
Кінцева точка: https://smsgateway24.com/getdata/getsmsstatus
Метод:: GET, POST
Параметри запиту:
Змінна Тип Опис
token string [обов’язково] Ваш токен отримати через метод отримання.
sms_id int [обов’язково] Sms Id

JSON-форматована відповідь::
Змінна Тип Опис
sms_id int SMS ID
status int SMS Status
  • 1 - В очікуванні SMS
  • 2 - SMS взято по телефону
  • 3 - У черзі для надсилання. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
  • 5 - Вхідні SMS
  • 6 - SMS відправлено телефоном
  • 7 - SMS доставлено
  • 8 - SMS НЕ доставлено
  • 9 - SMS, узагалі не визначено - загальна помилка. (Прочитайте що робити з цією помилкою сюди)
  • Можливо менш поширені помилки:
  • 10 - SMS не надіслано - No Service
  • 11 - SMS не надіслано - Null PDU
  • 12 - SMS не надіслано - Radio Off
  • 100, 101 - SMS не надіслано - NOT ALLOWED. (Дозволи на надсилання SMS у програмі не надано)
status_description string Назва статусу
error int 0 | 1 - при обробці запиту сталася помилка
message string Повідомлення про помилку, порожнє, якщо все в порядку.
Посилання на код приклади Curl
Посилання на код пазлу
Приклад відповіді:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}