Retrieve Message

Retrieves a single message and its delivery status.

We currently do not support pushing delivery status to your server via webhooks when the status of a message changes.

Endpoint #2
GET /campaigns/:campaignId/messages/:messageId
Example response body
{
  "createdAt": "2024-05-16T10:30:50.904+08:00",
  "updatedAt": "2024-05-16T10:30:50.965+08:00",
  "id": "<YOUR_MESSAGE_ID>",
  "recipient": "6599999999",
  "values": {
    "name": "John Doe",
    "fruit": "apple"
  },
  "fullMessage": "<YOUR_FULL_MESSAGE>",
  "latestStatus": "success",
  "templateBodyId": "<YOUR_TEMPLATE_BODY_ID>",
  "campaignId": "<YOUR_CAMPAIGN_ID>",
  "templateBody": {
    "createdAt": "2024-05-16T10:13:15.111+08:00",
    "updatedAt": "2024-05-16T10:13:15.111+08:00",
    "id": "<YOUR_TEMPLATE_BODY_ID>",
    "templateId": "<YOUR_TEMPLATE_ID>",
    "language": "english",
    "body": "{{body}}",
    "creatorId": "<YOUR_GENERATED_CREATOR_ID>"
  },
  "batches": [],
  "language": "english",
  "creatorEmail": "<YOUR_GENERATED_CREATOR_EMAIL>",
  "attempts": [
    {
      "status": "success",
      "createdAt": "2024-05-16T10:57:52.534+08:00"
    },
    {
      "status": "failure",
      "createdAt": "2024-05-16T10:30:50.906+08:00",
      "sentAt": "2024-05-16T10:31:50.187+08:00",
      "deliveredAt": null, 
      "error": {
        "type": "server_error",
        "code": "server_unknown_error"
      }
    }
  ]
}

Last updated