WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.

`ContinuationPagedResultDtoOfSmsLogDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Represents a page of results obtained through continuation-token paging. Supports an approximate total count for display purposes.

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

items required

array of SmsLogDto array of SmsLogDto

The items returned for this page. 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.

Fields of each SmsLogDto:

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.

`Unknown`	No state recorded. Only ever seen on a malformed document.
`GatewayBlocked`	The send-time compliance gate refused the message (for example the recipient has opted out). No Twilio API call was made, so no carrier callback will ever follow. Distinct from GatewaySendFailed so a compliance block is auditable separately from a carrier fault.
`GatewaySendFailed`	The Twilio API rejected the create-message call. The message never entered the carrier network.
`GatewaySent`	Twilio accepted the message. Carrier callbacks (if a status callback URL was set) follow.
`Queued`	Carrier callback: the message is queued, accepted, scheduled, or sending.
`Sent`	Carrier callback: the message has been handed to the carrier.
`Delivered`	Carrier callback: the carrier confirmed delivery to the handset.
`Undelivered`	Carrier callback: the carrier could not deliver the message. Usually carries a Twilio error code.
`Failed`	Carrier callback: the message failed outright or was cancelled. Usually carries a Twilio error code.

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.

`Transactional`	Transactional message tied to a specific interaction the recipient initiated or expects (payment link, receipt, invoice, one-time passcode). This is the platform's default when a caller sets no category: every SMS sender wired today is transactional.
`Marketing`	Promotional / marketing message. Requires express marketing consent and is subject to the stricter content and timing policy. Callers sending marketing SMS must set this explicitly; it is never inferred.
`Reminder`	Recurring reminder in an ongoing program the recipient enrolled in (an overdue-invoice reminder series, a scheduled payment nudge). Not marketing, but recurring, so CTIA requires the opt-out instruction to ride on the message itself and TCPA timing applies.

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 body has no documented fields.

nextContinuationToken required

string

Continuation token to use when requesting the next page. Null means no additional pages exist. 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.

approxTotalCount required

integer (int64)

An approximate total count of matching items. This value is optional and may be stale or estimated, so treat it as an approximation. 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.

pageItemCount required

integer (int32)

Convenience property for the number of items in this page. read only

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.

retrievedAt required

string (date-time)

When the page was retrieved. Useful for diagnostics and cache behavior.

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.