Skip to main content

Retrieve a Message

GET 
/Accounts/:AccountSid/Messages/:Sid

Retrieve a single message.

Permissions​

The API token must include the following scopes: Messaging.

Request​

Path Parameters

    AccountSid uuidrequired

    The unique identifier of the project that sent or received this message.

    Sid uuidrequired

    A unique ID that identifies this specific message.

Responses​

OK

Schema

    account_sid uuid

    The unique identifier of the project that sent or received this message.

    api_version string

    The version number of the SignalWire CXML REST API used to handle this message.

    body string

    The text of the message. Up to 1600 characters long and can be null if no message was sent.

    num_segments integer

    The number of segments that make up the entire message. If the body of the message is larger than 160 GSM-7 characters or 70 UCS-2 characters, it will automatically be broken up into smaller messages and annotated to attempt proper reconstruction on the recipient handset. Not all carriers and handsets support this. SignalWire will recombine inbound messages into a single message. Your project will be charged for each segment sent or received.

    num_media string

    The number of media files that were included with the message.

    date_created string

    The date and time the message was created in RFC 2822 format.

    date_sent string

    The date and time the message was sent in RFC 2822 format.

    date_updated string

    The date and time the message was last updated in RFC 2822 format.

    direction string

    Possible values: [inbound, outbound-api, outbound-call, outbound-reply]

    The direction of the message.

    error_code string

    If an error has occurred on the message, the error code will give you a specific code to help lookup more information on the failure. If no error occurred, error_code will be null.

    error_message string

    A human readable description of the error that occurred. If no error occurred, error_message will be null.

    from string

    The phone number in E.164 format. For inbound messages, this will be the remote phone number who sent the message. For outbound messages, this will be one of your SignalWire phone numbers.

    price integer

    The cost of the individual message billed to your project.

    price_unit string

    The currency in which price is charged as.

    sid string

    A unique ID that identifies this specific message.

    status string

    Possible values: [queued, sending, sent, delivered, undelivered, failed, receiving, received]

    Current status of the message.

    to string

    The phone number in E.164 format that received the message. For inbound messages, this is one of your SignalWire phone numbers; for outbound messages, this is the remote phone number that received the message.

    messaging_service_sid string

    If a number group was used when sending an outbound message, the number group's ID will be present. If no number group was used, the value will be null.

    uri string

    The URI of this particular message.

    subresource_uris

    object

    The URIs for any subresources associated with this message.

    media string
Loading...