API de rappel de message
La couche API prend en charge la fonctionnalité de rappel de message.
Authentification
Pour plus de détails, consultez la section Méthodes d'authentification dans l'Aperçu de l'API REST.
Rappel de message
Endpoint
DELETE v4/push/withdraw/{msg_id}
Limitations
- Le rappel n'est pris en charge que pour les messages datant de moins d'un jour.
- Les rappels en double ne sont pas pris en charge.
Description des paramètres de la requête
| Nom | Obligatoire | Description |
|---|---|---|
| msg_id | O | Le msg_id retourné par la notification de message |
Exemple de requête
En-tête de requête
DELETE /v4/push/withdraw/1828256757
Authorization: Basic (chaîne d'authentification base64)
Accept: application/json
DELETE /v4/push/withdraw/1828256757
Authorization: Basic (chaîne d'authentification base64)
Accept: application/json
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse réussie
< 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"
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse d'échec
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
Afficher ce bloc de code dans la fenêtre flottante
{
"error": {
"code": 21003,
"message": "La valeur du paramètre est invalide, msg_id inexistant"
}
}
{
"error": {
"code": 21003,
"message": "La valeur du paramètre est invalide, msg_id inexistant"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Codes d'erreur
| Code | HTTP | Description | Message d'erreur | Explication détaillée |
|---|---|---|---|---|
| Aucun | 200 | Retour réussi | nil | Code de statut de succès |
| 21003 | 400 | Erreur de paramètre | La valeur du paramètre est invalide, avec des informations d'erreur spécifiques | La valeur du paramètre est invalide, avec des informations d'erreur spécifiques |
