Fetch a Message

import { TwilioClient } from "twilio-comms";
async function main() {
    const client = new TwilioClient({
        accountId: "YOUR_ACCOUNTID_HERE",
        authToken: "YOUR_AUTHTOKEN_HERE",
    });
    await client.messages.fetch("messageId");
}
main();

{
  "attempts": [
    {
      "from": {
        "address": "bowlingteam_212_sender",
        "channel": "RCS",
        "senderId": "comms_sender_01h9krwprkeee8fzqspvwy6nq8"
      },
      "to": [
        {
          "address": "+14153901002",
          "channel": "PHONE"
        }
      ],
      "status": "FAILED",
      "attemptedAt": "2023-08-24T14:15:22Z",
      "infoUrl": "https://console.twilio.com/us1/monitor/logs/sms/AC77ec7f777777f7a77ce7777aeef7777f/SMbffad777cc7777777777777dfcdc7f77",
      "error": {
        "code": 61337,
        "message": "Recipient does not have RCS enabled.",
        "infoUrl": "https://twilio.com/docs/api/errors/61337"
      }
    },
    {
      "from": {
        "address": "+12065558844",
        "channel": "SMS",
        "senderId": "comms_sender_01h9krwprkeee8fzqspvwy6nq8"
      },
      "to": [
        {
          "address": "+14153901002",
          "channel": "PHONE"
        }
      ],
      "status": "DELIVERED",
      "attemptedAt": "2023-08-24T14:15:22Z",
      "infoUrl": "https://console.twilio.com/us1/monitor/logs/sms/AC77ec7f777777f7a77ce7777aeef7777f/SMbffad777cc7777777777777dfcdc7f77",
      "error": {
        "code": 21614,
        "message": "The address specified in the request is not a valid phone number.",
        "infoUrl": "https://www.twilio.com/docs/api/errors/21614",
        "context": "$.from[0].address"
      }
    }
  ],
  "content": {
    "text": "Thanks for joining us today!",
    "media": [
      {
        "url": "http://content.cool.co/party-thanks.png"
      }
    ]
  },
  "createdAt": "2023-08-24T14:15:22Z",
  "from": {
    "address": "+12065558844",
    "channel": "SMS",
    "senderId": "comms_sender_01h9krwprkeee8fzqspvwy6nq8"
  },
  "id": "comms_message_2x4y6z8a0b1c2d3e4f5g6h7j8k",
  "related": [
    {
      "name": "SESSION",
      "id": "comms_session_01h2xcejqtf2nbrexx3vqjhp41",
      "uri": "https://comms.twilio.com/v1/Sessions/comms_session_01h2xcejqtf2nbrexx3vqjhp41"
    }
  ],
  "status": "DELIVERED",
  "tags": {},
  "to": [
    {
      "address": "+14153901002",
      "channel": "PHONE"
    }
  ],
  "updatedAt": "2023-08-24T14:15:22Z"
}

This operation fetches a single Message using its ID.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Path parameters

messageIdstringRequired

Response

attemptslist of objects

The list of attempts Twilio executed to process the Message.

contentobject

The resolved content of the Message.

createdAtstringformat: "date-time"

The date and time when the entity was created.

fromobject

The sender of the Message.

idstringformat: "^comms_message_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"

A reference to a Message.

scheduledForstring or null

The scheduled send time of the Message. This field is only present if the Message was created with a schedule.

statusenum

The status of a Message. The status can be one of the following:

SCHEDULED The Message is scheduled to be sent by Twilio in the future.
QUEUED The Message is queued in Twilio for sending.
SENT The Message has been sent by Twilio.
DELIVERED The Message has been successfully delivered to the recipient.
READ The Message has been read by the recipient.
UNDELIVERED The Message was successfully sent by Twilio but have not been delivered to the recipient.
FAILED The Message processing failed inside Twilio. Use GET /Messages/Operations/{operationId}/Errors for more details.
CANCELED The Message was canceled via API request.
GROUP The Message is part of a group communication. To get the status for each Recipient of the group communication, use the Receipts endpoint e.g. GET /Messages/comms_message_01h2xcejqtf2nbrexx3vqjhp41/Receipts
INBOUND The Message was received by Twilio from an external source.

The status of a `Message`. The status can be one of the following: - `SCHEDULED` The `Message` is scheduled to be sent by Twilio in the future. - `QUEUED` The `Message` is queued in Twilio for sending. - `SENT` The `Message` has been sent by Twilio. - `DELIVERED` The `Message` has been successfully delivered to the recipient. - `READ` The `Message` has been read by the recipient. - `UNDELIVERED` The `Message` was successfully sent by Twilio but have not been delivered to the recipient. - `FAILED` The `Message` processing failed inside Twilio. Use `GET /Messages/Operations/{operationId}/Errors` for more details. - `CANCELED` The `Message` was canceled via API request. - `GROUP` The `Message` is part of a group communication. To get the status for each Recipient of the group communication, use the `Receipts` endpoint e.g. GET `/Messages/comms_message_01h2xcejqtf2nbrexx3vqjhp41/Receipts` - `INBOUND` The `Message` was received by Twilio from an external source.

tagsmap from strings to strings

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs.

This field can be templated with Liquid. Specify variables with each recipient for personalization.

Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs. This field can be templated with [Liquid](https://shopify.github.io/liquid/). Specify `variables` with each recipient for personalization.

tolist of objects

The list of recipient(s) that the Message was directed to.

This list is always of size 1, except for Group Messaging usage, where the number of recipients plus the sender will match the group size.

The list of recipient(s) that the Message was directed to. - This list is always of size 1, except for Group Messaging usage, where the number of recipients plus the sender will match the group size.

updatedAtstringformat: "date-time"

The date and time when the entity was last updated.

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error