Rebotes de SMS
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
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 | true | Basic base64(sms_user:sms_key) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| offset | Integer | no | posición de desplazamiento (offset), [0-], el valor predeterminado es 0 |
| limit | Integer | no | cantidad, [0-100], el valor predeterminado es 100 |
| phone | string | no | número de teléfono |
| start_date | string | yes | start_date, con formato yyyy-MM-dd |
| end_date | string | yes | end_date, con formato yyyy-MM-dd |
Nota:
El número de días del intervalo de consulta entre start_date y end_date no puede superar los 90 días.
Ejemplo de solicitud
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--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 | número de teléfono |
| bounce_type | tipo de rebote |
| msg_type | tipo de SMS; 2 representa SMS internacional |
| bounce_time | hora del rebote |
| expire_time | hora de caducidad |
| reason | motivo del rebote |
bounce_type: código de tipo correspondiente y su descripción
| Tipo de rebote | Descripción |
|---|---|
| 500 | Fallo de envío, número inexistente |
| 510 | Fallo de envío, número fuera de servicio |
| 520 | Fallo de envío, número en lista negra |
| 530 | Fallo de envío, línea ocupada |
| 540 | Fallo de envío, sin respuesta |
| 550 | Fallo de envío, contenido de plantilla interceptado |
| 560 | Fallo de envío, error del terminal móvil |
| 570 | Fallo de envío, móvil fuera de servicio |
| 580 | Fallo de envío, móvil apagado |
| 590 | Fallo de envío, otros motivos |
| 410 | Lista de interceptación global |
| 411 | Lista de interceptación global personalizada |
| 420 | Lista de interceptación local |
| 421 | Lista de interceptación local personalizada |
| 430 | Cancelación de suscripción |
| 440 | Filtrado por palabra clave |
| 450 | Error de sustitución de variables |
| 460 | La longitud de la variable supera el límite |
| 470 | Excepción de codificación (Nota: Las excepciones de codificación se han combinado con 460; ahora 470 representa que la frecuencia supera el límite) |
| 480 | Tipo de envío no compatible |
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 200
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "Customize local interception list"
}
],
"total": 1,
"count": 1
}
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "Customize local interception list"
}
],
"total": 1,
"count": 1
}
Este bloque de código se muestra en una ventana flotante
Eliminar
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
DELETE
DELETE
Este bloque de código se muestra en una ventana flotante
Content-type
application/json
application/json
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 |
|---|---|---|---|
| phone | string | yes | número de teléfono |
| start_date | string | yes | start_date, con formato yyyy-MM-dd |
| end_date | string | yes | end_date, con formato yyyy-MM-dd |
Nota:
El número de días del intervalo de consulta entre start_date y end_date no puede superar los 90 días.
Ejemplo de solicitud
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--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 |
|---|---|
| count | cantidad de rebotes eliminados |
Ejemplo de valor devuelto
Respuesta: Éxito
Estado HTTP: 200
{
"count": 1
}
{
"count": 1
}
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
