| Змінна | Тип | Опис |
|---|---|---|
| string | [обов’язково] Your login in the system. Usually email | |
| pass | string | [обов’язково] Your password in the system |
| Змінна | Тип | Опис |
|---|---|---|
| token | string | Ваш токен набутий через метод отримання токена: |
| error | int | 0 | 1 - показує чи є помилка при обробці запиту |
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |
| Змінна | Тип | Опис |
|---|---|---|
| token | string | [обов’язково] Ваш токен отримати через метод отримання. |
| sendto | string | [обов’язково] Recipient address or phone number. Multiple values can be separated by commas. |
| body | string | [обов’язково] Message body. Not required when sending an image (see the "file" parameter below) — in that case body will be replaced with the uploaded image URL. |
| device_id | int | [обов’язково] Ідентифікатор пристрою |
| sim | int | [обов’язково] Sim slot: 0 and 1 for SMS. 2 - Whatsapp Business, 3 - WhatsApp Personal. 4 and 5 - RCS. |
| timetosend | string YYYY-MM-DD або YYYY-MM-DD HH:MM:SS |
[необов'язково] Часу визначено для надсилання повідомлення. Наприклад, 2026-05-29 17:23:03 |
| customerid | int | [необов'язково] ID вашого покупця. Необов'язкове поле |
| urgent | int | [необов'язково] Marks the message as urgent. Useful for OTP and high-priority traffic. |
| file | file (multipart/form-data) | [необов'язково] Image file to send (jpeg, png, webp, gif). When provided, the request must be sent as multipart/form-data with POST. The file is uploaded to our S3 storage and its public URL replaces the "body" field, so the image is delivered to the recipient (currently supported on WhatsApp / WhatsApp Business slots) and is also displayed in the corresponding chat. This parameter is fully optional — existing integrations that only send text messages can keep working without any changes. |
| Змінна | Тип | Опис |
|---|---|---|
| error | int | 0 or 1 - indicates whether there is an error in processing the request |
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |
| sms_id | int | Created message identifier in our system. |
{
"error": 0,
"sms_id": 62807347,
"message": "Sms has been saved successfully"
}
| Змінна | Тип | Опис |
|---|---|---|
| string | [обов’язково] Адреса електронної пошти | |
| pass | string | [обов’язково] Ваш пароль |
| sendto | string | [обов’язково] Recipient address or phone number. |
| body | string | [обов’язково] Текст повідомлення |
| device_id | int | [обов’язково] Ідентифікатор пристрою |
| sim | int | [обов’язково] Sim slot: 0 and 1 for SMS. 2 - Whatsapp Business, 3 - WhatsApp Personal. 4 and 5 - RCS |
| timetosend | string | [необов'язково] Scheduled sending time. |
| customerid | int | [необов'язково] Your customer identifier. |
| urgent | int | [необов'язково] Marks the message as urgent. |
| Змінна | Тип | Опис |
|---|---|---|
| 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}]} |
| Змінна | Тип | Опис |
|---|---|---|
| error | int | 0 | 1 - показує чи є помилка при обробці запиту |
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |
{
"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
}
]
}
| Змінна | Тип | Опис |
|---|---|---|
| token | string | [обов’язково] Ваш токен отримати через метод отримання. |
| device_id | string | [необов'язково] Ідентифікатор пристрою |
| status | int |
[необов'язково]
|
| 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 and 1 for SMS. 2 - Whatsapp Business, 3 - WhatsApp Personal. 4 and 5 - RCS # 0 or 1 |
| customerid | int | [необов'язково] ID вашого покупця. Необов'язкове поле |
| onlycount | int | [необов'язково] 0 | 1 тільки для |
| phone | string | [необов'язково] 0 | 1 Фільтр номерів телефонів |
| orderbydesc | int | [необов'язково] 0 | 1 Order by any field |
| timezone | int | [необов'язково] Укажіть місцевий часовий пояс, наприклад, такі як налаштування його в Австралію/Сідней. |
| Змінна | Тип | Опис |
|---|---|---|
| token | string | Ваш токен набутий через метод отримання токена: |
| error | int | 0 | 1 - показує чи є помилка при обробці запиту |
| message | string | Повідомлення про помилку, порожнє, якщо все у порядку |
| count | int | SMS amount |
| smss | int | JSON object |
{
"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
}
}
}
| Змінна | Тип | Опис |
|---|---|---|
| token | string | [обов’язково] Ваш токен отримати через метод отримання. |
| title | string | [обов’язково] Назва тегу |
| Змінна | Тип | Опис |
|---|---|---|
| tag_id | int | Tag ID |
| error | int | 0 | 1 - показує чи є помилка при обробці запиту |
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |
{
"error": 0,
"tag_id": 8303,
"message": "OK"
}
| Змінна | Тип | Опис |
|---|---|---|
| token | string | [обов’язково] Ваш токен отримати через метод отримання. |
| phone | string | [обов’язково] phone number |
| ctag_id | int | [обов’язково] Tag ID |
| string | [обов’язково] Ім'я покупця |
| Змінна | Тип | Опис |
|---|---|---|
| contact_id | int | Contact Id |
| error | int | 0 | 1 - показує чи є помилка при обробці запиту |
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |
{"error":0,"contact_id":15954765,"message":"ok"}
| Змінна | Тип | Опис |
|---|---|---|
| token | string | [обов’язково] Ваш токен отримати через метод отримання. |
| title | string | [обов’язково] Заголовок інформаційного бюлетеня |
| device_id | string | [обов’язково] Ідентифікатор пристрою |
| body | string | [обов’язково] Тіло цільового повідомлення |
| tags | string | [обов’язково] Тег Id. Може бути розділений комами. Наприклад: 12,13,14 |
| sim | int | [обов’язково]Sim slot: 0 and 1 for SMS. 2 - Whatsapp Business, 3 - WhatsApp Personal. 4 and 5 - RCS 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 |
| Змінна | Тип | Опис |
|---|---|---|
| contact_id | int | Id контакту |
| error | int | 0 | 1 - показує чи є помилка при обробці запиту |
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |
| paket_id | int | Package ID |
| Змінна | Тип | Опис |
|---|---|---|
| token | string | [обов’язково] Ваш токен отримати через метод отримання. |
| Змінна | Тип | Опис |
|---|---|---|
| count | int | Кількість пристроїв: |
| device | json |
|
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |
{
"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
}
}
}
| Змінна | Тип | Опис |
|---|---|---|
| token | string | [обов’язково] Ваш токен отримати через метод отримання. |
| sms_id | int | [обов’язково] Sms Id |
| Змінна | Тип | Опис |
|---|---|---|
| sms_id | int | SMS ID |
| status | int | SMS Status
|
| status_description | string | Назва статусу |
| error | int | 0 | 1 - при обробці запиту сталася помилка |
| message | string | Повідомлення про помилку, порожнє, якщо все в порядку. |