Rejets de SMS
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| offset | Integer | non | position de décalage, [0-], par défaut 0 |
| limit | Integer | non | quantité, [0-100], par défaut 100 |
| phone | string | non | numéro de téléphone |
| start_date | string | oui | date de début, formatée yyyy-MM-dd |
| end_date | string | oui | date de fin, formatée yyyy-MM-dd |
Astuces :
L'intervalle de jours entre start_date et end_date ne peut pas dépasser 90 jours.
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| phone | numéro de téléphone |
| bounce_type | type de rejet |
| msg_type | type de SMS, 2 représente un SMS international |
| bounce_time | heure du rejet |
| expire_time | heure d'expiration |
| reason | raison du rejet |
bounce_type code de type correspondant et sa description
| bounce_type | Description |
|---|---|
| 500 | Échec d'envoi, numéro inexistant |
| 510 | Échec d'envoi, numéro hors service |
| 520 | Échec d'envoi, numéro sur liste noire |
| 530 | Échec d'envoi, ligne occupée |
| 540 | Échec d'envoi, pas de réponse |
| 550 | Échec d'envoi, contenu du modèle intercepté |
| 560 | Échec d'envoi, erreur du terminal mobile |
| 570 | Échec d'envoi, mobile hors service |
| 580 | Échec d'envoi, mobile éteint |
| 590 | Échec d'envoi, autres raisons |
| 410 | Liste d'interception globale |
| 411 | Liste d'interception globale personnalisée |
| 420 | Liste d'interception locale |
| 421 | Liste d'interception locale personnalisée |
| 430 | Désabonnement |
| 440 | Filtrage par mot-clé |
| 450 | Erreur de remplacement de variable |
| 460 | Longueur de variable dépasse la limite |
| 470 | Exception d'encodage (Remarque : les exceptions d'encodage sont fusionnées avec 460, désormais 470 signifie fréquence dépassée) |
| 480 | Type d'envoi non pris en charge |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 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": "Liste d'interception locale personnalisée"
}
],
"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": "Liste d'interception locale personnalisée"
}
],
"total": 1,
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Suppression
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
DELETE
DELETE
Afficher ce bloc de code dans la fenêtre flottante
Content-type
application/json
application/json
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Description des paramètres du corps de la requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| phone | string | oui | numéro de téléphone |
| start_date | string | oui | date de début, formatée yyyy-MM-dd |
| end_date | string | oui | date de fin, formatée yyyy-MM-dd |
Astuces :
L'intervalle de jours entre start_date et end_date ne peut pas dépasser 90 jours.
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| count | nombre de rejets supprimés |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status: 401
{
"code": 30000,
"message": "Non autorisé."
}
{
"code": 30000,
"message": "Non autorisé."
}
Afficher ce bloc de code dans la fenêtre flottante
