Envío
Envío
Enviar una plantilla de SMS a uno o varios usuarios
URL
https://sms.api.engagelab.cc/v1/send
https://sms.api.engagelab.cc/v1/send
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
POST
POST
Este bloque de código se muestra en una ventana flotante
Content-Type
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
Descripción de parámetros del cuerpo
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| from | string | no | El nombre del remitente admite de 3 a 11 caracteres y solo admite caracteres alfanuméricos en inglés; el valor predeterminado está vacío; la visualización depende del resultado efectivo. |
| to | array | yes | Lista de números de teléfono móvil, con un máximo de 1000 en la lista. |
| body | object | yes | Configuración del contenido del SMS |
| template_id | int | yes | ID de la plantilla |
| msg_type | int | no | Tipo de SMS; 2 representa SMS internacional; el valor predeterminado es 2. |
| label_id | int | no | Etiqueta de SMS |
| vars | object | no | Variable. Hasta 1 MB |
| custom_args | object | no | Campos opcionales personalizados por el cliente. El tamaño máximo es 1 KB. |
| request_id | string | no | ID de esta solicitud de envío; máximo de 128 caracteres. |
Sugerencias:
- Vars se utiliza para la sustitución de variables del contenido del mensaje. El formato es un objeto JSON y el formato es
'{"varname": ["value1", "value2"]}', donde varname es la variable de contenido del mensaje.- El contenido del mensaje es: Welcome to the %sp% SMS service. Valor vars correspondiente: {"sp": "engagelab"} Sustitución del contenido del SMS: Welcome to use EngageLab SMS service.
- De forma predeterminada, cada valor en vars no puede superar los 16 caracteres de longitud, con formato de cadena (string), y las variables no pueden contener enlaces HTTP (para requisitos especiales, póngase en contacto con el servicio de atención al cliente).
- El sistema sustituirá las variables de la plantilla de SMS por los parámetros en vars, y todos los números de teléfono recibirán el mismo contenido sustituido.
- Dado que custom_args es definido por el usuario, se incorporará en el encabezado; los datos posteriores de SMSHook se le devolverán.
- request_id se utiliza para evitar envíos repetidos, y el período de validez es de 1 hora. Si se envía repetidamente en el plazo de 1 hora, se devolverá el resultado de la última solicitud.
Ejemplo de solicitud
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123",
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
"week":"Tuesday"
}
}
}'
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123",
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
"week":"Tuesday"
}
}
}'
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| success_count | Número de transmisiones correctas |
| sms_ids | Lista de ID de SMS enviados correctamente |
| failed_count | Número de envíos fallidos |
| failed_items | Lista de teléfonos con envío fallido y motivos del fallo |
| phone | Teléfono |
| message | Motivo del fallo |
| request_id | ID de esta solicitud de envío |
| custom_args | Campos opcionales personalizados por el cliente |
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 200
// ejemplo de resultados devueltos correctamente
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123"
}
// ejemplo de resultados devueltos con éxito parcial
{
"code": 41031,
"message": "partial success",
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123",
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Invalid phone number format"
}
]
}
// ejemplo de resultados devueltos correctamente
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123"
}
// ejemplo de resultados devueltos con éxito parcial
{
"code": 41031,
"message": "partial success",
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123",
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Invalid phone number format"
}
]
}
Este bloque de código se muestra en una ventana flotante
Respuesta: Error
Estado HTTP: 401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
Este bloque de código se muestra en una ventana flotante
Respuesta: Error
Estado HTTP: 400
// ejemplo de resultados devueltos con error
{
"code": 32002,
"message": "Invalid phone number format"
}
// ejemplo de resultados devueltos con error
{
"code": 32002,
"message": "Invalid phone number format"
}
Este bloque de código se muestra en una ventana flotante
