Statut
Requête
Liste des statuts des SMS envoyés par les utilisateurs. Vous pouvez interroger cette liste.
URL
https://sms.api.engagelab.cc/v1/status
https://sms.api.engagelab.cc/v1/status
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
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| offset | string | non | position de départ, [0-], par défaut à 0 |
| limit | string | non | quantité, [0-100], par défaut à 100 |
| time_zone | string | non | fuseau horaire, exemple : +8 |
| send_date | string | oui | format de la date d'envoi : yyyy-MM-dd |
| phone | string | non | téléphone |
| sms_ids | string | non | IDs des SMS renvoyés lors d'une livraison réussie, plusieurs sms_id séparés par ;, jusqu'à 10 pris en charge |
| msg_type | string | non | type de SMS, 2 représente un SMS international |
| sms_user | string | non | un certain SMS pour le client SMS_USER |
| template_id | string | non | ID du modèle de SMS |
| label_id | string | non | ID du label SMS |
| status | string | non | 1 envoyé, 2 délivré, 3 en attente du résultat, 4 échec du traitement, 5 échec d'envoi |
| sub_status | string | non | sous-état |
Astuces :
- Prise en charge de la consultation des données détaillées d'une journée dans les 6 derniers mois.
- Les enregistrements correspondants obtenus à chaque requête seront mis en cache pendant 10 minutes.
- Cette interface limite chaque SMS_USER à 60 appels par minute.
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| phone | téléphone |
| sms_id | ID du SMS |
| msg_type | type de SMS |
| sms_user | SMS_USER |
| template_id | ID du modèle de SMS |
| template_name | nom du modèle de SMS |
| status | 1 envoyé, 2 délivré, 3 en attente du résultat, 4 échec du traitement, 5 échec d'envoi |
| status_desc | description du statut de livraison du SMS, divisé en envoyé, délivré, en attente du résultat, échec du traitement, échec d'envoi |
| sub_status | sous-état |
| sub_status_desc | la description du sous-état est indiquée dans le tableau ci-dessous |
| request_time | heure de la requête |
| update_time | heure de mise à jour |
| response_message | réponse |
Code d'état d'échec de traitement et description :
| sub_status | description du sous-état |
|---|---|
| 410 | Échec du traitement - Blocage global |
| 420 | Échec du traitement - Blocage partiel |
| 430 | Échec du traitement - Désabonnement |
| 440 | Échec du traitement - Blocage par mot-clé |
| 450 | Échec du traitement - Erreur de variable |
| 460 | Échec du traitement - Erreur de contenu |
| 470 | Échec du traitement - Fréquence dépassée |
| 480 | Échec du traitement - Autre |
Code d'état d'échec d'envoi et description :
| sub_status | description du sous-état |
|---|---|
| 500 | Échec d'envoi - Vide |
| 510 | Échec d'envoi - Hors service |
| 520 | Échec d'envoi - Liste noire |
| 530 | Échec d'envoi - Occupé |
| 540 | Échec d'envoi - Pas de réponse |
| 550 | Échec d'envoi - Interception |
| 560 | Échec d'envoi - Panne |
| 570 | Échec d'envoi - Hors service |
| 580 | Échec d'envoi - Éteint |
| 590 | Échec d'envoi - Autre |
Exemple de valeur retournée
{
"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
}
}
Afficher ce bloc de code dans la fenêtre flottante
