Skip to content

Lister des messages

get
https://api.reach.talkylabs.com/rest/messaging/v1/list

Cette opération permet d'extraire de la plateforme Reach les enregistrements des messages qui répondent aux critères spécifiés.

Lors de l'obtention de la liste des messages, les résultats seront triés en fonction du champ dateCreated, les plus récents apparaissant en premier.

Pagination

La plateforme Reach utilise une pagination basée sur le décalage pour lister les objets.

Par exemple, si une requête a un résultat de 100 objets avec pageSize = 10 et page = 5, alors les objets avec les indices 51 à 60 sont retournés.

Les bibliothèques clientes introduisent le paramètre limit qui peut être utilisé pour indiquer le nombre maximum d'objets satisfaisant les critères spécifiés à retourner.

Paramètres

  • deststringoptional

    Liste uniquement les messages envoyés à ce numéro de téléphone. Le numéro de téléphone doit être au format E.164.

  • srcstringoptional

    Liste uniquement les messages envoyés à partir de ce numéro de téléphone (au format E.164), ou cet identifiant alphanumérique de l'expéditeur.

  • bulkIdentifierstringoptional

    Liste uniquement les messages associés à ce bulkIdentifier.

  • sentAtdate-timeoptional

    uniquement les messages envoyés à la date spécifiée. Doit être au format ISO 8601.

  • sentAfterdate-timeoptional

    uniquement les messages envoyés après la date spécifiée. Doit être au format ISO 8601.

  • sentBeforedate-timeoptional

    Liste uniquement les messages envoyés avant la date spécifiée. Doit être au format ISO 8601.

  • pageSizeintegeroptional

    Nombre maximum d'objets à retourner à chaque invocation de la requête. La valeur par défaut est 20.

  • pageintegeroptional

    Il s'agit de la page d'objets à retourner. Cela permet d'éviter de renvoyer des données en double. La valeur par défaut est 0.

Exemple 1: Lister les derniers 20 messages

curl -X GET https://api.reach.talkylabs.com/rest/messaging/v1/list?pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalMessages": 5,
  "totalPages": 5,
  "outOfPageRange": false,
  "messages": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "body": "Hello World! This is a sms message.",
      "dest": "+237671234567",
      "src": "+237691234567",
      "bulkId": "myBulkGroup",
      "numSegments": 1,
      "numMedia": 0,
      "price": 25.0,
      "priceUnit": "xaf",
      "messageId": "MIDXXXXXXXXXXXX",
      "status": "sent",
      "messageType": "outbound",
      "errorCode": null,
      "errorMessage": null,
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateSent": "2016-08-29T09:12:34.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z"
    }
  ]
}

Exemple 2: Liste tous les messages correspondant à certains critères

Dans cet exemple, nous listons tous les messages envoyés le 29 août 2016 à partir du numéro de téléphone +237691234567.

curl -X GET https://api.reach.talkylabs.com/rest/messaging/v1/list?sentAt=2016-08-29T00%3A00%3A00Z&src=%2B237691234567&pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalMessages": 5,
  "totalPages": 5,
  "outOfPageRange": false,
  "messages": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "body": "Hello World! This is a sms message.",
      "dest": "+237671234567",
      "src": "+237691234567",
      "bulkId": "myBulkGroup",
      "numSegments": 1,
      "numMedia": 0,
      "price": 25.0,
      "priceUnit": "xaf",
      "messageId": "MIDXXXXXXXXXXXX",
      "status": "sent",
      "messageType": "outbound",
      "errorCode": null,
      "errorMessage": null,
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateSent": "2016-08-29T09:12:34.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z"
    }
  ]
}

Exemple 3: Liste tous les messages envoyés au cours d'une période donnée

Dans cet exemple, nous listons tous les messages envoyés avant le 31 août 2016 mais après le 21 août 2016.

curl -X GET https://api.reach.talkylabs.com/rest/messaging/v1/list?sentAfter=2016-08-21T00%3A00%3A00Z&sentBefore=2016-08-31T00%3A00%3A00Z&pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalMessages": 5,
  "totalPages": 5,
  "outOfPageRange": false,
  "messages": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "body": "Hello World! This is a sms message.",
      "dest": "+237671234567",
      "src": "+237691234567",
      "bulkId": "myBulkGroup",
      "numSegments": 1,
      "numMedia": 0,
      "price": 25.0,
      "priceUnit": "xaf",
      "messageId": "MIDXXXXXXXXXXXX",
      "status": "sent",
      "messageType": "outbound",
      "errorCode": null,
      "errorMessage": null,
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateSent": "2016-08-29T09:12:34.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z"
    }
  ]
}