SMS Log: gets the delivery record for one outbound message by its correlation id.

GET /api/twilio/sms-log/by-correlation/{correlationId} deprecated

Requires: Twilio.SmsLog.View, merchant scope.

Requires API key scope: admin (Administration)

This is the lookup a sending feature uses to reflect a delivery outcome on its own record: it holds the correlation id returned by the send, and asks here whether the message was delivered, blocked by the compliance gate, or failed at the carrier. The tenant and merchant ids must match the message's owning scope, and the caller's own scope is enforced on top. Returns no content when no record exists, which includes a message whose row has aged out of the 30-day retention window.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, MessagingApi } from '@winkpg/winkpg-api';

const api = new MessagingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.smsLogFindByCorrelationId("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MessagingApi(config);
var result = await api.SmsLogFindByCorrelationIdAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/twilio/sms-log/by-correlation/{correlationId}");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MessagingApi(client)
    result = api.sms_log_find_by_correlation_id("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

correlationId required

path

string (uuid)

Correlation id returned by the send.

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

query

string (uuid)

Tenant id that scopes the lookup.

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

query

string (uuid)

Merchant id that scopes the lookup.

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.

suppressNulls required

query

boolean

If true, omit properties with null 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.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

Body: SmsLogDto SmsLogDto Each item has these 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.

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

429 Too Many Requests

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

Errors 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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 RemoteServiceErrorInfo:

Field Type Description

code required

string

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.

message required

string

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.

details required

string

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.

data required

object

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.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

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.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

SMS Log: gets the delivery record for one outbound message by its correlation id.

Example request

Parameters

Request body

Responses

Errors

Authentication