Estado
Consulta
Lista de estados de SMS enviados por los usuarios.
Se puede consultar esta lista.
URL
https://sms.api.engagelab.cc/v1/status
https://sms.api.engagelab.cc/v1/status
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Basic base64(sms_user:sms_key) |
Descripción de parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| offset | string | no | posición inicial, [0-], el valor predeterminado es 0 |
| limit | string | no | cantidad, [0-100], el valor predeterminado es 100 |
| time_zone | string | no | zona horaria, ejemplo: +8 |
| send_date | string | Sí | formato de la fecha de envío: yyyy-MM-dd |
| phone | string | no | teléfono |
| sms_ids | string | no | ID devueltos tras la entrega correcta del SMS, admite varios ID de SMS; separados por comas (máximo 10) |
| msg_type | string | no | tipo de SMS. El 2 representa SMS internacional |
| sms_user | string | no | un SMS_USER específico del cliente |
| template_id | string | no | ID de la plantilla de SMS |
| label_id | string | no | ID de la etiqueta de SMS |
| status | string | no | 1: enviado; 2: entregado; 3: en espera de resultado; 4: fallo de procesamiento; 5: fallo de envío |
| sub_status | string | no | subestado |
Consejos:
- Se admite la consulta de datos detallados de un día dentro de los últimos 6 meses.
- Los registros obtenidos en cada consulta se almacenarán en caché durante 10 [minutos].
- Esta interfaz limita a cada SMS_USER a 60 llamadas por minuto.
Ejemplo de solicitud
curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| phone | teléfono |
| sms_id | ID del SMS |
| msg_type | tipo de SMS |
| sms_user | SMS_USER |
| template_id | ID de la plantilla de SMS |
| template_name | nombre de la plantilla de SMS |
| status | 1: enviado; 2: entregado; 3: en espera de resultado; 4: fallo de procesamiento; 5: fallo de envío |
| status_desc | descripción del estado de entrega del SMS; se divide en enviado, entregado, en espera de resultado, fallo de procesamiento, fallo de envío |
| sub_status | subestado |
| sub_status_desc | la descripción del subestado se muestra en la tabla siguiente |
| request_time | hora de la solicitud |
| update_time | hora de actualización |
| response_message | respuesta |
Código y descripción del estado de fallo de procesamiento:
| sub_status | Descripción de sub_status |
|---|---|
| 410 | Fallo de procesamiento: bloqueo global |
| 420 | Fallo de procesamiento: bloqueo parcial |
| 430 | Fallo de procesamiento: cancelación de suscripción |
| 440 | Fallo de procesamiento: bloqueo por palabra clave |
| 450 | Fallo de procesamiento: error de variable |
| 460 | Fallo de procesamiento: error de contenido |
| 470 | Fallo de procesamiento: exceso de frecuencia |
| 480 | Fallo de procesamiento: otros |
Código y descripción del estado de fallo de envío:
| sub_status | Descripción de sub_status |
|---|---|
| 500 | Fallo de envío: vacío |
| 510 | Fallo de envío: fuera de servicio |
| 520 | Fallo de envío: lista negra |
| 530 | Fallo de envío: ocupado |
| 540 | Fallo de envío: sin respuesta |
| 550 | Fallo de envío: interceptación |
| 560 | Fallo de envío: avería |
| 570 | Fallo de envío: no está en servicio |
| 580 | Fallo de envío: apagado |
| 590 | Fallo de envío: otros |
Ejemplo de valor devuelto
{
"result": [{
"sms_id":"***_**_**_**_**$**",
"msg_type": 2,
"phone": "+16235217",
"request_time": "2017-02-19 00:21:20",
"response_message": "success",
"sms_user": "*****",
"status_desc": "delivery",
"status":2,
"template_id": "10",
"template_name": "engagelab code",
"update_time": "2017-02-19 00:21:21"
}
],
"total": 1
}
}
{
"result": [{
"sms_id":"***_**_**_**_**$**",
"msg_type": 2,
"phone": "+16235217",
"request_time": "2017-02-19 00:21:20",
"response_message": "success",
"sms_user": "*****",
"status_desc": "delivery",
"status":2,
"template_id": "10",
"template_name": "engagelab code",
"update_time": "2017-02-19 00:21:21"
}
],
"total": 1
}
}
Este bloque de código se muestra en una ventana flotante
