Messages API

Messages API

Send a message

Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.

This endpoint allows you to send a message with any messaging resource. Current messaging resources include: long-code, short-code, number-pool, and alphanumeric-sender-id.

SecuritybearerAuth
Request
Request Body schema: application/json

Message payload

auto_detect
boolean
Default: false

Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.

from
string <address>

Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).

Required if sending with a phone number, short code, or alphanumeric sender ID.

media_urls
Array of strings <url>

A list of media URLs. The total media size must be less than 1 MB.

Required for MMS

messaging_profile_id
string

Unique identifier for a messaging profile.

Required if sending via number pool or with an alphanumeric sender ID.

subject
string

Subject of multimedia message

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

to
required
string <address> (ToNumber)

Receiving address (+E.164 formatted phone number or short code).

type
string

The protocol for sending the message, either SMS or MMS.

Enum: "SMS" "MMS"
use_profile_webhooks
boolean
Default: true

If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

Responses
200

Successful response with details about a message.

Response Schema: application/json
object (OutboundMessagePayload)
completed_at
string <date-time>

ISO 8601 formatted date indicating when the message was finalized.

object
direction
string

The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.

Value: "outbound"
encoding
string

Encoding scheme used for the message body.

Array of objects (Error)

These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

object
id
string <uuid>

Identifies the type of resource.

Array of objects
messaging_profile_id
string

Unique identifier for a messaging profile.

organization_id
string <uuid>

The id of the organization the messaging profile belongs to.

parts
integer [ 1 .. 10 ]

Number of parts into which the message's body must be split.

received_at
string <date-time>

ISO 8601 formatted date indicating when the message request was received.

record_type
string

Identifies the type of the resource.

Value: "message"
sent_at
string <date-time>

ISO 8601 formatted date indicating when the message was sent.

subject
string

Subject of multimedia message

tags
Array of strings

Tags associated with the resource.

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

Array of objects
type
string

The type of message.

Enum: "SMS" "MMS"
valid_until
string <date-time>

Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
Callbacks
postUpdate Post
post/messages
Request samples
application/json
{}
Response samples
application/json
{
  • "data": {
    • "completed_at": null,
    • "cost": null,
    • "direction": "outbound",
    • "encoding": "GSM-7",
    • "errors": [ ],
    • "from": {
      • "carrier": "TELNYX LLC",
      • "line_type": "VoIP",
      • "phone_number": "+18445550001"
      },
    • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
    • "media": [],
    • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
    • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
    • "parts": 1,
    • "received_at": "2019-01-23T18:10:02.574Z",
    • "record_type": "message",
    • "sent_at": null,
    • "subject": "From Telnyx!",
    • "tags": [
      • "Greetings"
      ],
    • "text": "Hello, World!",
    • "to": [
      • {
        • "carrier": "T-MOBILE USA, INC.",
        • "line_type": "Wireless",
        • "phone_number": "+18665550001",
        • "status": "queued"
        }
      ],
    • "type": "MMS",
    • "valid_until": null,
    • "webhook_failover_url": "https://backup.example.com/hooks",
    • "webhook_url": "https://www.example.com/hooks"
    }
}
Callback payload samples
POST: Update Post
application/json
{
  • "data": {
    • "event_type": "message.sent",
    • "id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
    • "occurred_at": "date-time",
    • "payload": {
      • "completed_at": null,
      • "cost": null,
      • "direction": "outbound",
      • "encoding": "GSM-7",
      • "errors": [ ],
      • "from": {
        • "carrier": "TELNYX LLC",
        • "line_type": "VoIP",
        • "phone_number": "+18445550001"
        },
      • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
      • "media": [],
      • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
      • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
      • "parts": 1,
      • "received_at": "2019-01-23T18:10:02.574Z",
      • "record_type": "message",
      • "sent_at": null,
      • "subject": "From Telnyx!",
      • "tags": [
        • "Greetings"
        ],
      • "text": "Hello, World!",
      • "to": [
        • {
          • "carrier": "T-MOBILE USA, INC.",
          • "line_type": "Wireless",
          • "phone_number": "+18665550001",
          • "status": "queued"
          }
        ],
      • "type": "MMS",
      • "valid_until": null,
      • "webhook_failover_url": "https://backup.example.com/hooks",
      • "webhook_url": "https://www.example.com/hooks"
      },
    • "record_type": "event"
    },
  • "meta": {}
}

Send a long code message

SecuritybearerAuth
Request
Request Body schema: application/json

Message payload

auto_detect
boolean
Default: false

Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.

from
required
string <address>

Phone number, in +E.164 format, used to send the message.

media_urls
Array of strings <url>

A list of media URLs. The total media size must be less than 1 MB.

Required for MMS

subject
string

Subject of multimedia message

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

to
required
string <address> (ToNumber)

Receiving address (+E.164 formatted phone number or short code).

type
string

The protocol for sending the message, either SMS or MMS.

Enum: "SMS" "MMS"
use_profile_webhooks
boolean
Default: true

If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

Responses
200

Successful response with details about a message.

Response Schema: application/json
object (OutboundMessagePayload)
completed_at
string <date-time>

ISO 8601 formatted date indicating when the message was finalized.

object
direction
string

The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.

Value: "outbound"
encoding
string

Encoding scheme used for the message body.

Array of objects (Error)

These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

object
id
string <uuid>

Identifies the type of resource.

Array of objects
messaging_profile_id
string

Unique identifier for a messaging profile.

organization_id
string <uuid>

The id of the organization the messaging profile belongs to.

parts
integer [ 1 .. 10 ]

Number of parts into which the message's body must be split.

received_at
string <date-time>

ISO 8601 formatted date indicating when the message request was received.

record_type
string

Identifies the type of the resource.

Value: "message"
sent_at
string <date-time>

ISO 8601 formatted date indicating when the message was sent.

subject
string

Subject of multimedia message

tags
Array of strings

Tags associated with the resource.

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

Array of objects
type
string

The type of message.

Enum: "SMS" "MMS"
valid_until
string <date-time>

Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
Callbacks
postUpdate Post
post/messages/long_code
Request samples
application/json
{}
Response samples
application/json
{
  • "data": {
    • "completed_at": null,
    • "cost": null,
    • "direction": "outbound",
    • "encoding": "GSM-7",
    • "errors": [ ],
    • "from": {
      • "carrier": "TELNYX LLC",
      • "line_type": "VoIP",
      • "phone_number": "+18445550001"
      },
    • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
    • "media": [],
    • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
    • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
    • "parts": 1,
    • "received_at": "2019-01-23T18:10:02.574Z",
    • "record_type": "message",
    • "sent_at": null,
    • "subject": "From Telnyx!",
    • "tags": [
      • "Greetings"
      ],
    • "text": "Hello, World!",
    • "to": [
      • {
        • "carrier": "T-MOBILE USA, INC.",
        • "line_type": "Wireless",
        • "phone_number": "+18665550001",
        • "status": "queued"
        }
      ],
    • "type": "MMS",
    • "valid_until": null,
    • "webhook_failover_url": "https://backup.example.com/hooks",
    • "webhook_url": "https://www.example.com/hooks"
    }
}
Callback payload samples
POST: Update Post
application/json
{
  • "data": {
    • "event_type": "message.sent",
    • "id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
    • "occurred_at": "date-time",
    • "payload": {
      • "completed_at": null,
      • "cost": null,
      • "direction": "outbound",
      • "encoding": "GSM-7",
      • "errors": [ ],
      • "from": {
        • "carrier": "TELNYX LLC",
        • "line_type": "VoIP",
        • "phone_number": "+18445550001"
        },
      • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
      • "media": [],
      • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
      • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
      • "parts": 1,
      • "received_at": "2019-01-23T18:10:02.574Z",
      • "record_type": "message",
      • "sent_at": null,
      • "subject": "From Telnyx!",
      • "tags": [
        • "Greetings"
        ],
      • "text": "Hello, World!",
      • "to": [
        • {
          • "carrier": "T-MOBILE USA, INC.",
          • "line_type": "Wireless",
          • "phone_number": "+18665550001",
          • "status": "queued"
          }
        ],
      • "type": "MMS",
      • "valid_until": null,
      • "webhook_failover_url": "https://backup.example.com/hooks",
      • "webhook_url": "https://www.example.com/hooks"
      },
    • "record_type": "event"
    },
  • "meta": {}
}

Send a message using number pool

SecuritybearerAuth
Request
Request Body schema: application/json

Message payload

auto_detect
boolean
Default: false

Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.

media_urls
Array of strings <url>

A list of media URLs. The total media size must be less than 1 MB.

Required for MMS

messaging_profile_id
required
string

Unique identifier for a messaging profile.

subject
string

Subject of multimedia message

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

to
required
string <address> (ToNumber)

Receiving address (+E.164 formatted phone number or short code).

type
string

The protocol for sending the message, either SMS or MMS.

Enum: "SMS" "MMS"
use_profile_webhooks
boolean
Default: true

If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

Responses
200

Successful response with details about a message.

Response Schema: application/json
object (OutboundMessagePayload)
completed_at
string <date-time>

ISO 8601 formatted date indicating when the message was finalized.

object
direction
string

The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.

Value: "outbound"
encoding
string

Encoding scheme used for the message body.

Array of objects (Error)

These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

object
id
string <uuid>

Identifies the type of resource.

Array of objects
messaging_profile_id
string

Unique identifier for a messaging profile.

organization_id
string <uuid>

The id of the organization the messaging profile belongs to.

parts
integer [ 1 .. 10 ]

Number of parts into which the message's body must be split.

received_at
string <date-time>

ISO 8601 formatted date indicating when the message request was received.

record_type
string

Identifies the type of the resource.

Value: "message"
sent_at
string <date-time>

ISO 8601 formatted date indicating when the message was sent.

subject
string

Subject of multimedia message

tags
Array of strings

Tags associated with the resource.

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

Array of objects
type
string

The type of message.

Enum: "SMS" "MMS"
valid_until
string <date-time>

Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
Callbacks
postUpdate Post
post/messages/number_pool
Request samples
application/json
{}
Response samples
application/json
{
  • "data": {
    • "completed_at": null,
    • "cost": null,
    • "direction": "outbound",
    • "encoding": "GSM-7",
    • "errors": [ ],
    • "from": {
      • "carrier": "TELNYX LLC",
      • "line_type": "VoIP",
      • "phone_number": "+18445550001"
      },
    • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
    • "media": [],
    • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
    • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
    • "parts": 1,
    • "received_at": "2019-01-23T18:10:02.574Z",
    • "record_type": "message",
    • "sent_at": null,
    • "subject": "From Telnyx!",
    • "tags": [
      • "Greetings"
      ],
    • "text": "Hello, World!",
    • "to": [
      • {
        • "carrier": "T-MOBILE USA, INC.",
        • "line_type": "Wireless",
        • "phone_number": "+18665550001",
        • "status": "queued"
        }
      ],
    • "type": "MMS",
    • "valid_until": null,
    • "webhook_failover_url": "https://backup.example.com/hooks",
    • "webhook_url": "https://www.example.com/hooks"
    }
}
Callback payload samples
POST: Update Post
application/json
{
  • "data": {
    • "event_type": "message.sent",
    • "id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
    • "occurred_at": "date-time",
    • "payload": {
      • "completed_at": null,
      • "cost": null,
      • "direction": "outbound",
      • "encoding": "GSM-7",
      • "errors": [ ],
      • "from": {
        • "carrier": "TELNYX LLC",
        • "line_type": "VoIP",
        • "phone_number": "+18445550001"
        },
      • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
      • "media": [],
      • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
      • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
      • "parts": 1,
      • "received_at": "2019-01-23T18:10:02.574Z",
      • "record_type": "message",
      • "sent_at": null,
      • "subject": "From Telnyx!",
      • "tags": [
        • "Greetings"
        ],
      • "text": "Hello, World!",
      • "to": [
        • {
          • "carrier": "T-MOBILE USA, INC.",
          • "line_type": "Wireless",
          • "phone_number": "+18665550001",
          • "status": "queued"
          }
        ],
      • "type": "MMS",
      • "valid_until": null,
      • "webhook_failover_url": "https://backup.example.com/hooks",
      • "webhook_url": "https://www.example.com/hooks"
      },
    • "record_type": "event"
    },
  • "meta": {}
}

Send a short code message

SecuritybearerAuth
Request
Request Body schema: application/json

Message payload

auto_detect
boolean
Default: false

Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.

from
required
string <address>

Phone number, in +E.164 format, used to send the message.

media_urls
Array of strings <url>

A list of media URLs. The total media size must be less than 1 MB.

Required for MMS

subject
string

Subject of multimedia message

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

to
required
string <address> (ToNumber)

Receiving address (+E.164 formatted phone number or short code).

type
string

The protocol for sending the message, either SMS or MMS.

Enum: "SMS" "MMS"
use_profile_webhooks
boolean
Default: true

If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

Responses
200

Successful response with details about a message.

Response Schema: application/json
object (OutboundMessagePayload)
completed_at
string <date-time>

ISO 8601 formatted date indicating when the message was finalized.

object
direction
string

The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.

Value: "outbound"
encoding
string

Encoding scheme used for the message body.

Array of objects (Error)

These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

object
id
string <uuid>

Identifies the type of resource.

Array of objects
messaging_profile_id
string

Unique identifier for a messaging profile.

organization_id
string <uuid>

The id of the organization the messaging profile belongs to.

parts
integer [ 1 .. 10 ]

Number of parts into which the message's body must be split.

received_at
string <date-time>

ISO 8601 formatted date indicating when the message request was received.

record_type
string

Identifies the type of the resource.

Value: "message"
sent_at
string <date-time>

ISO 8601 formatted date indicating when the message was sent.

subject
string

Subject of multimedia message

tags
Array of strings

Tags associated with the resource.

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

Array of objects
type
string

The type of message.

Enum: "SMS" "MMS"
valid_until
string <date-time>

Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
Callbacks
postUpdate Post
post/messages/short_code
Request samples
application/json
{}
Response samples
application/json
{
  • "data": {
    • "completed_at": null,
    • "cost": null,
    • "direction": "outbound",
    • "encoding": "GSM-7",
    • "errors": [ ],
    • "from": {
      • "carrier": "TELNYX LLC",
      • "line_type": "VoIP",
      • "phone_number": "+18445550001"
      },
    • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
    • "media": [],
    • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
    • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
    • "parts": 1,
    • "received_at": "2019-01-23T18:10:02.574Z",
    • "record_type": "message",
    • "sent_at": null,
    • "subject": "From Telnyx!",
    • "tags": [
      • "Greetings"
      ],
    • "text": "Hello, World!",
    • "to": [
      • {
        • "carrier": "T-MOBILE USA, INC.",
        • "line_type": "Wireless",
        • "phone_number": "+18665550001",
        • "status": "queued"
        }
      ],
    • "type": "MMS",
    • "valid_until": null,
    • "webhook_failover_url": "https://backup.example.com/hooks",
    • "webhook_url": "https://www.example.com/hooks"
    }
}
Callback payload samples
POST: Update Post
application/json
{
  • "data": {
    • "event_type": "message.sent",
    • "id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
    • "occurred_at": "date-time",
    • "payload": {
      • "completed_at": null,
      • "cost": null,
      • "direction": "outbound",
      • "encoding": "GSM-7",
      • "errors": [ ],
      • "from": {
        • "carrier": "TELNYX LLC",
        • "line_type": "VoIP",
        • "phone_number": "+18445550001"
        },
      • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
      • "media": [],
      • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
      • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
      • "parts": 1,
      • "received_at": "2019-01-23T18:10:02.574Z",
      • "record_type": "message",
      • "sent_at": null,
      • "subject": "From Telnyx!",
      • "tags": [
        • "Greetings"
        ],
      • "text": "Hello, World!",
      • "to": [
        • {
          • "carrier": "T-MOBILE USA, INC.",
          • "line_type": "Wireless",
          • "phone_number": "+18665550001",
          • "status": "queued"
          }
        ],
      • "type": "MMS",
      • "valid_until": null,
      • "webhook_failover_url": "https://backup.example.com/hooks",
      • "webhook_url": "https://www.example.com/hooks"
      },
    • "record_type": "event"
    },
  • "meta": {}
}

Retrieve a message

Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation. If you require messages older than this, please generate an MDR report.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

The id of the message

Responses
200

Successful response with details about a message.

Response Schema: application/json
object (OutboundMessagePayload)
completed_at
string <date-time>

ISO 8601 formatted date indicating when the message was finalized.

object
direction
string

The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.

Value: "outbound"
encoding
string

Encoding scheme used for the message body.

Array of objects (Error)

These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

object
id
string <uuid>

Identifies the type of resource.

Array of objects
messaging_profile_id
string

Unique identifier for a messaging profile.

organization_id
string <uuid>

The id of the organization the messaging profile belongs to.

parts
integer [ 1 .. 10 ]

Number of parts into which the message's body must be split.

received_at
string <date-time>

ISO 8601 formatted date indicating when the message request was received.

record_type
string

Identifies the type of the resource.

Value: "message"
sent_at
string <date-time>

ISO 8601 formatted date indicating when the message was sent.

subject
string

Subject of multimedia message

tags
Array of strings

Tags associated with the resource.

text
string

Message body (i.e., content) as a non-empty string.

Required for SMS

Array of objects
type
string

The type of message.

Enum: "SMS" "MMS"
valid_until
string <date-time>

Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled

webhook_failover_url
string <url>

The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.

webhook_url
string <url>

The URL where webhooks related to this message will be sent.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/messages/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.Message.retrieve("uuid")
Response samples
application/json
{
  • "data": {
    • "completed_at": null,
    • "cost": null,
    • "direction": "outbound",
    • "encoding": "GSM-7",
    • "errors": [ ],
    • "from": {
      • "carrier": "TELNYX LLC",
      • "line_type": "VoIP",
      • "phone_number": "+18445550001"
      },
    • "id": "40385f64-5717-4562-b3fc-2c963f66afa6",
    • "media": [],
    • "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
    • "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
    • "parts": 1,
    • "received_at": "2019-01-23T18:10:02.574Z",
    • "record_type": "message",
    • "sent_at": null,
    • "subject": "From Telnyx!",
    • "tags": [
      • "Greetings"
      ],
    • "text": "Hello, World!",
    • "to": [
      • {
        • "carrier": "T-MOBILE USA, INC.",
        • "line_type": "Wireless",
        • "phone_number": "+18665550001",
        • "status": "queued"
        }
      ],
    • "type": "MMS",
    • "valid_until": null,
    • "webhook_failover_url": "https://backup.example.com/hooks",
    • "webhook_url": "https://www.example.com/hooks"
    }
}