| Variable | Tipo | Descripción |
|---|---|---|
| string | [requerido] Your login in the system. Usually email | |
| pass | string | [requerido] Your password in the system |
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | Tu token se adquiere a través del método de recuperación de tokens: |
| error | int | 0 | 1 - indica si hay un error al procesar la solicitud |
| message | string | Mensaje de error, vacío si todo está en orden. |
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | [requerido] Su token se adquiere mediante el método de recuperación de token. |
| sendto | string | [requerido] Recipient address or phone number. Multiple values can be separated by commas. |
| body | string | [requerido] 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 | [requerido] ID del dispositivo |
| sim | int | [requerido] Sim slot: 0 and 1 for SMS. 2 - Whatsapp Business, 3 - WhatsApp Personal. 4 and 5 - RCS. |
| timetosend | string YYYY-MM-DD o YYYY-MM-DD HH:MM:SS |
[opcional] Tiempo asignado para enviar un mensaje. Por ejemplo, 2026-05-29 17:21:27 |
| customerid | int | [opcional] Número de identificación de su cliente. Campo opcional |
| urgent | int | [opcional] Marks the message as urgent. Useful for OTP and high-priority traffic. |
| file | file (multipart/form-data) | [opcional] 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. |
| Variable | Tipo | Descripción |
|---|---|---|
| error | int | 0 or 1 - indicates whether there is an error in processing the request |
| message | string | Mensaje de error, vacío si todo está en orden. |
| sms_id | int | Created message identifier in our system. |
{
"error": 0,
"sms_id": 62807347,
"message": "Sms has been saved successfully"
}
| Variable | Tipo | Descripción |
|---|---|---|
| string | [requerido] Tu email | |
| pass | string | [requerido] Su contraseña |
| sendto | string | [requerido] Recipient address or phone number. |
| body | string | [requerido] Cuerpo del mensaje |
| device_id | int | [requerido] ID del dispositivo |
| sim | int | [requerido] Sim slot: 0 and 1 for SMS. 2 - Whatsapp Business, 3 - WhatsApp Personal. 4 and 5 - RCS |
| timetosend | string | [opcional] Scheduled sending time. |
| customerid | int | [opcional] Your customer identifier. |
| urgent | int | [opcional] Marks the message as urgent. |
| Variable | Tipo | Descripción |
|---|---|---|
| datajson | string | [requerido] {"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}]} |
| Variable | Tipo | Descripción |
|---|---|---|
| error | int | 0 | 1 - indica si hay un error al procesar la solicitud |
| message | string | Mensaje de error, vacío si todo está en orden. |
{
"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
}
]
}
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | [requerido] Su token se adquiere mediante el método de recuperación de token. |
| device_id | string | [opcional] ID del dispositivo |
| status | int |
[opcional]
|
| begindate | string YYYY-MM-DD or YYYY-MM-DD HH:MM:SS |
[opcional] Begin Date Time |
| enddate | string YYYY-MM-DD or YYYY-MM-DD HH:MM:SS |
[opcional] End Date Time |
| sim | int | [opcional] Sim slot: 0 and 1 for SMS. 2 - Whatsapp Business, 3 - WhatsApp Personal. 4 and 5 - RCS # 0 or 1 |
| customerid | int | [opcional] Número de identificación de su cliente. Campo opcional |
| onlycount | int | [opcional] 0 | 1 contar sólo |
| phone | string | [opcional] 0 | 1 Filtro de números de teléfono |
| orderbydesc | int | [opcional] 0 | 1 Order by any field |
| timezone | int | [opcional] Especifique su zona horaria local, como por ejemplo fijarla en Sidney. |
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | Tu token se adquiere a través del método de recuperación de tokens: |
| error | int | 0 | 1 - indica si hay un error al procesar la solicitud |
| message | string | Mensaje de error, vacío si todo está en orden |
| 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
}
}
}
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | [requerido] Su token se adquiere mediante el método de recuperación de token. |
| title | string | [requerido] Nombre de etiqueta |
| Variable | Tipo | Descripción |
|---|---|---|
| tag_id | int | Tag ID |
| error | int | 0 | 1 - indica si hay un error al procesar la solicitud |
| message | string | Mensaje de error, vacío si todo está en orden. |
{
"error": 0,
"tag_id": 8303,
"message": "OK"
}
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | [requerido] Su token se adquiere mediante el método de recuperación de token. |
| phone | string | [requerido] phone number |
| ctag_id | int | [requerido] Tag ID |
| string | [requerido] Nombre de tu cliente |
| Variable | Tipo | Descripción |
|---|---|---|
| contact_id | int | Contact Id |
| error | int | 0 | 1 - indica si hay un error al procesar la solicitud |
| message | string | Mensaje de error, vacío si todo está en orden. |
{"error":0,"contact_id":15954765,"message":"ok"}
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | [requerido] Su token se adquiere mediante el método de recuperación de token. |
| title | string | [requerido] Título del boletín |
| device_id | string | [requerido] ID del dispositivo |
| body | string | [requerido] Cuerpo del mensaje de destino |
| tags | string | [requerido] Etiqueta Id. Puede ser vario, separada por comas. Por ejemplo: 12,13,14 |
| sim | int | [requerido]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 | [requerido]Date time when Newsletter should be sent. Do not forget tap start on device. DD.MM.YYYY H:i:s |
| Variable | Tipo | Descripción |
|---|---|---|
| contact_id | int | Id de contacto |
| error | int | 0 | 1 - indica si hay un error al procesar la solicitud |
| message | string | Mensaje de error, vacío si todo está en orden. |
| paket_id | int | Package ID |
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | [requerido] Su token se adquiere mediante el método de recuperación de token. |
| Variable | Tipo | Descripción |
|---|---|---|
| count | int | Número de dispositivos: |
| device | json |
|
| message | string | Mensaje de error, vacío si todo está en orden. |
{
"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
}
}
}
| Variable | Tipo | Descripción |
|---|---|---|
| token | string | [requerido] Su token se adquiere mediante el método de recuperación de token. |
| sms_id | int | [requerido] Sms Id |
| Variable | Tipo | Descripción |
|---|---|---|
| sms_id | int | SMS ID |
| status | int | SMS Status
|
| status_description | string | Nombre de estado |
| error | int | 0 | 1 - hay un error al procesar la solicitud |
| message | string | Mensaje de error, vacío si todo está en orden. |