API de retirada de mensajes
La capa de API admite la funcionalidad de retirada de mensajes.
Autenticación
Para obtener más detalles, se recomienda consultar la sección Métodos de autenticación en la visión general de la API REST.
Retirada de mensajes
Endpoint
DELETE v4/push/withdraw/{msg_id}
Limitaciones
- La retirada solo se admite para mensajes dentro de un día.
- No se admiten retiradas duplicadas.
Descripción de parámetros de la solicitud
| Nombre | Obligatorio | Descripción |
|---|---|---|
| msg_id | S | El msg_id devuelto por el envío de mensajes |
Ejemplo de solicitud
Encabezado de la solicitud
DELETE /v4/push/withdraw/1828256757
Authorization: Basic (base64 auth string)
Accept: application/json
DELETE /v4/push/withdraw/1828256757
Authorization: Basic (base64 auth string)
Accept: application/json
Este bloque de código se muestra en una ventana flotante
Ejemplo de respuesta
Respuesta correcta
< HTTP/1.1 200 OK
< Content-Type: application/json
{
"request_id": "",
"msg_id": "1180003"
}
< HTTP/1.1 200 OK
< Content-Type: application/json
{
"request_id": "",
"msg_id": "1180003"
}
Este bloque de código se muestra en una ventana flotante
Respuesta con error
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8
Este bloque de código se muestra en una ventana flotante
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
Este bloque de código se muestra en una ventana flotante
Códigos de error
| Código | HTTP | Descripción | Mensaje de error | Explicación detallada |
|---|---|---|---|---|
| Ninguno | 200 | Respuesta correcta | nil | Código de estado correcto |
| 21003 | 400 | Error de parámetro | Parameter value is invalid, along with specific error information | El valor del parámetro no es válido; incluye información específica del error |
