Skip to content

Latest commit

 

History

History
45 lines (41 loc) · 2.88 KB

OutboundMessage.md

File metadata and controls

45 lines (41 loc) · 2.88 KB
Raw

OutboundMessage

Properties

Name Type Description Notes
recordType RecordTypeEnum Identifies the type of the resource. [optional]
direction DirectionEnum The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you. [optional]
id UUID Identifies the type of resource. [optional]
type TypeEnum The type of message. [optional]
messagingProfileId UUID Unique identifier for a messaging profile. [optional]
from String Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). [optional]
to List<OutboundMessageTo> [optional]
text String Message body (i.e., content) as a non-empty string. Required for SMS [optional]
subject String Subject of multimedia message [optional]
media List<OutboundMessageMedia> [optional]
webhookUrl String The URL where webhooks related to this message will be sent. [optional]
webhookFailoverUrl String The failover URL where webhooks related to this message will be sent if sending to the primary URL fails. [optional]
encoding String Encoding scheme used for the message body. [optional]
parts Integer Number of parts into which the message's body must be split. [optional]
tags List<String> Tags associated with the resource. [optional]
cost OutboundMessageCost [optional]
receivedAt OffsetDateTime ISO 8601 formatted date indicating when the message request was received. [optional]
sentAt OffsetDateTime ISO 8601 formatted date indicating when the message was sent. [optional]
completedAt OffsetDateTime ISO 8601 formatted date indicating when the message was finalized. [optional]
validUntil OffsetDateTime 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 [optional]
errors List<Error> These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses. [optional]

Enum: RecordTypeEnum

Name Value
MESSAGE "message"

Enum: DirectionEnum

Name Value
OUTBOUND "outbound"

Enum: TypeEnum

Name Value
SMS "SMS"
MMS "MMS"