Messages

Get a message

One SMS message with its current status: queued, sent, delivered or failed.

get/messages/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/messages/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: messages:read)

Path parameters

idstring uuid required

The id of the message.

Response

The message.

idstring uuid required

The id of the message.

tostring required

The recipient, in E.164.

fromstring required

The sender the recipient sees: an alphanumeric name of up to 11 characters.

bodystring required

The text as it was sent, after typographic quotes and dashes were made SMS-safe.

segmentsinteger required

How many SMS segments the text took. A segment is 160 GSM-7 or 70 UCS-2 characters (153 and 67 when split).

encoding'gsm7' | 'ucs2' | 'null' nullable required

gsm7, or ucs2 when the text has a character outside GSM-7 (an emoji, for example), which makes every segment shorter.

status'queued' | 'sent' | 'delivered' | 'failed' required

queued: accepted. sent: handed to the mobile network. delivered: the phone confirmed it. failed: it did not arrive; see error.

errorstring nullable required

With status failed: a short code, like delivery_failed or sending_failed. Otherwise null.

referencestring nullable required

Your own id for this message, as you sent it (an order number, for example).

created_atstring date-time required

When we accepted the message.

status_updated_atstring date-time nullable required

When the status last changed.

testboolean required

true for a message sent with a test key to a test number. It never reaches a phone.

Changes

No recorded changes to this operation across all 1 revision of this API.