List Messages API

Overview

List transactional GovSG messages

GET/v1/transactional/govsg

Authorization

bearerAuth

Query parameters

Response

200400401500

Successfully retrieved a list of messages

Body

application/json

has_more*boolean

data*array of GovSGMessageTransactional (object)

Request

JavaScriptCurl

const response = await fetch('/v1/transactional/govsg', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "has_more": false,
  "data": [
    {
      "id": 42,
      "recipient": "98765432",
      "template_id": 2,
      "language_code": "en_GB",
      "created_at": "2024-04-27T19:13:06.105Z",
      "updated_at": "2024-04-27T19:13:06.105Z",
      "accepted_at": "2024-04-27T19:13:06.105Z",
      "sent_at": "2024-04-27T19:13:06.105Z",
      "delivered_at": "2024-04-27T19:13:06.105Z",
      "read_at": "2024-04-27T19:13:06.105Z",
      "errored_at": "2024-04-27T19:13:06.105Z",
      "error_code": "text",
      "error_description": "text",
      "status": "UNSENT"
    }
  ]
}

Response format

• has_more: a boolean indicating whether there are more WhatsApp messages to retrieve.

• data: an array of JSON WhatsApp message objects. You can find an example of a single JSON message object here.

Example response

{
  "has_more": false,
  "data": [
    {
      "id": "505",
      "recipient": "[phone]",
      "template_id": "1",
      "params": {
        "topic": "document collection",
        "agency": "Open Government Products",
        "timeslot": "1-3PM",
        "officer_name": "John Tan",
        "recipient_name": "Stanley Nguyen",
        "officer_designation": "Reception Officer"
      },
      "language_code": "en_GB",
      "created_at": "2023-07-31T16:39:59.631Z",
      "updated_at": "2023-07-31T16:40:02.558Z",
      "accepted_at": "2023-07-31T16:40:01.526Z",
      "sent_at": "2023-07-31T16:40:01.000Z",
      "delivered_at": "2023-07-31T16:40:02.000Z",
      "read_at": null,
      "errored_at": null,
      "error_code": null,
      "error_description": null,
      "status": "DELIVERED"
    }
  ]
}