Документация по 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
Ссылка на пример кода Guzzle
Пример ответа:
{"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 [обязательный] ID устройства
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[опционально] Время, определенное для отправки сообщения. Например 2024-04-15 02:45:45
sim int, default = 0 [опционально] SIM slot # 0 or 1
customerid int [опционально] ID покупателя необязательное поле.
urgent int [опционально] SMS помечено как срочное. Это поле не является обязательным. SMS будет отправлено с приоритетом и может быть полезно при отправке одноразовых паролей (OTPs).

Ответ в формате JSON::
Переменная Тип Описание
token string Ваш токен получен с помощью метода извлечения токена:
error int 0 | 1 - указывает, есть ли ошибка при обработке запроса
message string Сообщение об ошибке, пустое, если все в порядке.
Ссылка на пример кода Curl
Ссылка на пример кода Guzzle
Пример ответа:
{ "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 [обязательный] Ваш email
pass string [обязательный] Ваш пароль
sendto string [обязательный]Телефонный номер абонента. Допустимы все символы. Например: +4915752982212, +4917642111111, +1 17642031984. Также можно указать несколько цифр через запятую
body string [обязательный] Тело сообщения
device_id string [обязательный] ID устройства
timetosend string
YYYY-MM-DD
or
YYYY-MM-DD HH:MM:SS
[опционально] Время, определенное для отправки сообщения. Например 2024-04-15 02:45:45
sim int, default = 0 [опционально] SIM slot # 0 or 1
customerid int [опционально] ID покупателя необязательное поле.
urgent int [опционально] SMS помечено как срочное. Это поле не является обязательным. SMS будет отправлено с приоритетом и может быть полезно при отправке одноразовых паролей (OTPs).

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

3. Массовая отправка SMS с использованием JSON

Пояснение: Создает SMS на сервере для отправки. После этого Телефон с приложением Smsgateway24 звонит серверу и принимает SMS и отправляет его с 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
Ссылка на пример кода Guzzle
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 от клиентов. Все входные переменные являются обязательными для этого метода, и статус SMS-сообщений может варьироваться.
Endpoint: https://smsgateway24.com/getdata/getallsms
Метод: GET, POST (Используйте %2B вместо знака "+" в запросе GET)
Параметры запроса:
Переменная Тип Описание
token string [обязательный] Ваш токен получен с помощью метода извлечения токена.
device_id string [опционально] ID устройства
status int [опционально]
  • 1 - Ожидание СМС
  • 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
Ссылка на пример кода Guzzle
Пример ответа ... :
{ "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
Ссылка на пример кода Guzzle
Пример ответа:
{ "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
Ссылка на пример кода Guzzle
Пример ответа ... :
{"error":0,"contact_id":15954765,"message":"ok"}

7. Создать рассылку

Пояснение:После создания тега вы можете сделать рассылку по телефонам с тегом.
Конечная точка: https://smsgateway24.com/getdata/savepaket
Метод:: GET, POST
Параметры запроса:
Переменная Тип Описание
token string [обязательный] Ваш токен получен с помощью метода извлечения токена.
title string [обязательный] Название рассылки
device_id string [обязательный] ID устройства
body string [обязательный] Тело целевого сообщения
tags string [обязательный] ID тега. Может быть несколько, разделяя запятыми. Например: 12,13,14
sim int, default = 0 [обязательный]Номер sim в телефоне: 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
Ссылка на пример кода Guzzle
Пример ответа ... :
{"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 - ID устройства
  • title - Имя устройства
  • created - Дата создания устройства
  • createdhumanformat - Дата создания устройства в обычном формате
  • lastseen - Дата последнего просмотра устройства
  • lastseenhumanformat - Дата последнего просмотра устройства
  • serialnumber - Серийный номер устройства
  • siminfo - Информация о SIM-картах в JSON
  • appversion - Версия приложения, установленного на устройстве
  • subscription - На устройстве есть подписка
message string Сообщение об ошибке, пустое, если все в порядке.
Ссылка на пример кода Curl
Ссылка на пример кода Guzzle
Пример ответа:
    {
    "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 - Ожидание СМС
  • 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
Ссылка на пример кода Guzzle
Пример ответа:
{"error":0,"message":"OK","token":"abbde3e31e9d026c02f4f49fc551111e"}
or
{"error":1,"message":"Login or password incorrect"}