Récupérer les messages sur une période
Cette méthode vous permet de retrouver l'historique des messages sur une période donnée.
GET
/messages
Paramètres de requête
date_start
requis
|
Ajouter un filtre pour récupérer les campagnes dont la date d'envoi se situe après cette date. Le format de la date doit-être comme suit : Y-m-d H:i:s |
date_end
requis
|
Ajouter un filtre pour récupérer les campagnes dont la date d'envoi se situe avant cette date. Le format de la date doit-être comme suit : Y-m-d H:i:s |
destination | Ajouter un filtre pour récupérer les campagnes qui contiennent un numéro ce numéro de téléphone |
message | Ajouter un filtre pour récupérer les campagnes dont le contenu contient ce texte |
type | Ajouter un filtre sur le type de message : message reçus (messages-in ), message envoyé (messages-out ). Par défaut, tous les messages sont retournés |
country | Ajouter un filtre pour récupérer les messages sur le pays d'envoi. Le pays doit être founri au format alpha2 : FR |
status | Add a filter on message status. Available status : delivered , sent , waiting , moderation , denied , not_sent , undelivered |
start | Vous pouvez définir l'enregistrement de départ pour la pagination |
length | Vous pouvez définir le nombre d'enregistrements à récupérer par requête. Par défaut 100. Maximum 1000 |
sort | Vous pouvez trier par date , destination , sender , status . Ajoutez - pour trier par order décroissant, par exemple -date |
Exemples
GET /messages?date_start=2023-09-01 00:00:00&date_end=2023-09-31 23:59:59 HTTP/1.1
Host: api.smsfactor.com
Accept: application/json
Authorization: Bearer your.token
Format de la réponse
{
"status": 1,
"message": "OK",
"totalRecords": 2,
"totalDisplayRecords": 2,
"messages": [
{
"campaign_id": 123,
"client_id": 1,
"client_message_id": "my id",
"contact_list_id": "",
"message": "Message via API",
"message_length": 15,
"cost": 1,
"country": "FR",
"destination": "33612345678",
"message_id": 138,
"sender": "",
"date": "2024-09-08 00:44:33",
"dlr_date": "2024-09-08 00:44:33",
"status": "SENT",
"status_details": "SENT",
"type": "sms_mt"
},
{
"campaign_id": 123,
"client_id": 1,
"client_message_id": "my id",
"contact_list_id": "",
"message": "An answer",
"message_length": 9,
"cost": 0,
"country": "",
"destination": "36000",
"message_id": 256,
"sender": "33612345678",
"date": "2024-09-08 00:44:33",
"dlr_date": "",
"status": "incoming_message",
"status_details": "",
"type": "sms_mo"
}
]
}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>1</status>
<message>OK</message>
<totalRecords>2</totalRecords>
<totalDisplayRecords>2</totalDisplayRecords>
<messages>
<campaign_id>123</campaign_id>
<client_id>1</client_id>
<client_message_id>my id</client_message_id>
<contact_list_id></contact_list_id>
<message>Message via API</message>
<message_length>15</message_length>
<cost>1</cost>
<country>FR</country>
<destination>33612345678</destination>
<message_id>138</message_id>
<sender></sender>
<date>"2024-09-08 00:44:33"</date>
<dlr_date>"2024-09-08 00:44:33"</dlr_date>
<status>SENT</status>
<status_details>SENT</status_details>
<type>sms_mt</type>
</messages>
<messages>
<campaign_id>123</campaign_id>
<client_id>1</client_id>
<client_message_id>my id</client_message_id>
<contact_list_id></contact_list_id>
<message>An answer</message>
<message_length>9</message_length>
<cost>0</cost>
<country></country>
<destination>36000</destination>
<message_id>256</message_id>
<sender>33612345678</sender>
<date>"2024-09-08 00:44:33"</date>
<dlr_date></dlr_date>
<status>incoming_message</status>
<status_details></status_details>
<type>sms_mo</type>
</messages>
</response>
Statuts
status | Description |
---|---|
sent | Le message a été envoyé. |
waiting | Le message est en attente d'envoi (campagne programmée dans le futur). |
delivered | Le message a été reçu. |
moderation | Le message est en cours de modération. Une action humaine est nécessaire pour valider ou rejeter (en cas de fraude) le message. |
denied | Le message a été refusé. |
not_sent | Le message n'a pas été envoyé (numéro invalide, pays non autorisé, heures non autorisées, anti-inondation...). |
undelivered | L'opérateur nous indique que le message n'a pas été reçu (numéro non attribué, problème de réseau, téléphone éteint...). |