SmsLogDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Read-only projection of one outbound SMS delivery-log row.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
correlationId
required |
string (uuid) | The platform correlation id for this message. Equal to `id`: there is
exactly one row per outbound message, so the correlation id is the document key. Surfaced under
its own name because that is what callers of the send API hold.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
toPhoneNumberMasked
required |
string | Recipient reduced to its last four digits (for example `•••••••4567`).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
fromPhoneNumberMasked
required |
string | Sending number reduced to its last four digits, when the send used a from-number.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
messagingServiceSid
required |
string | The Messaging Service SID the send routed through, when one was configured.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
messageSid
required |
string | Twilio's message SID, once the API accepted the message. Null for blocked / failed sends.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
status
required |
SmsDeliveryStatus SmsDeliveryStatus | Where the message currently sits in its lifecycle.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
isFailure
required |
boolean | Whether `status` means the message did not reach the handset.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
twilioErrorCode
required |
integer (int32) | Twilio numeric error code from the failing send or callback, when one was reported.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
failureCode
required |
string | Platform error code explaining a gateway-side refusal (for example a compliance block).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
bodyLength
required |
integer (int32) | Message length in characters. The body itself is never stored or returned.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
category
required |
SmsMessageCategory SmsMessageCategory | Declared message category.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
timestamp
required |
string (date-time) | When the send was attempted (UTC).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
lastStatusAt
required |
string (date-time) | When the most recent carrier callback was applied (UTC). Null until the first one lands.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
tenantId
required |
string (uuid) | Tenant the message was sent under.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
merchantId
required |
string (uuid) | Merchant the message belongs to.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.