Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Example

Description

id

String

"id": "ex-am-pl-id-12-34"

Unique message ID. You can use the id from provider

provider

String

"provider": "telnyx"

Name of the messaging provider used in lowercase

Current known providers:

Code Block
twilio
bandwidth
telnyx
pinpoint
plivo
infobip
messagebird
commio
imimobile
sinch
vonage
smpp
ringcentral
cdyne

message_created_at

String

"2024-03-14T13:00:00-05:00"

Datetime the message was created by you in ISO 8601 format. If none is given, this will be the time the message is processed.

message_sent_at

String

"2024-03-14T13:00:00-05:00"

Datetime the message was sent (to or from the carrier) by your provider (CPaaS) in ISO 8601 format. If none is given, this will be the time the message is processed.

message_finalized_at

String

"2024-03-14T13:00:00-05:00"

Datetime the message was marked finalized by the provider (CPaaS) in ISO 8601 format. If none is given, this will be the time the message is processed.

error_code

String

"000"

Code the provider returned if there was an issue with sending this message

from_number

String

"+1234567890"

Phone number formatted in E.164 the message is being sent from

to_number

String

"+1098765432"

Phone number formatted in E.164 the message was sent to

body

String

"The text you sent. Text STOP to Unsubscribe."

Contents of the message sent

status

String

"delivered"

Status returned from the provider

direction

String

"outbound"

Direction of the message. Certain providers have more than inbound/outbound descriptions. These will be saved for future reference, but also normalized into inbound/outbound buckets

message_type

String

"SMS"

Kind of message sent: SMS/MMS

segment_count

Integer

2

Number of segments provider broke message into for sending

...