# GET /api/twilio/sms-log/by-correlation/{correlationId} SMS Log: gets the delivery record for one outbound message by its correlation id. 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. **Operation ID:** `smsLogFindByCorrelationId` ## Authorization Requires: Twilio.SmsLog.View, merchant scope. Requires API key scope: `admin` Required permissions: - `Twilio.SmsLog.View` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | correlationId | path | yes | string(uuid) | Correlation id returned by the send. | | tenantId | query | no | string(uuid) | Tenant id that scopes the lookup. | | merchantId | query | no | string(uuid) | Merchant id that scopes the lookup. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`SmsLogDto`](https://devportal.demo.winkpg.io/docs/api/models/SmsLogDto.md) Properties: - `id` (string(uuid)) - `correlationId` (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. - `toPhoneNumberMasked` (string): Recipient reduced to its last four digits (for example `•••••••4567`). (nullable) - `fromPhoneNumberMasked` (string): Sending number reduced to its last four digits, when the send used a from-number. (nullable) - `messagingServiceSid` (string): The Messaging Service SID the send routed through, when one was configured. (nullable) - `messageSid` (string): Twilio's message SID, once the API accepted the message. Null for blocked / failed sends. (nullable) - `status` ([SmsDeliveryStatus](https://devportal.demo.winkpg.io/docs/api/models/SmsDeliveryStatus.md)): Where the message currently sits in its lifecycle. Values: - `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` (boolean): Whether `status` means the message did not reach the handset. - `twilioErrorCode` (integer(int32)): Twilio numeric error code from the failing send or callback, when one was reported. (nullable) - `failureCode` (string): Platform error code explaining a gateway-side refusal (for example a compliance block). (nullable) - `bodyLength` (integer(int32)): Message length in characters. The body itself is never stored or returned. (nullable) - `category` ([SmsMessageCategory](https://devportal.demo.winkpg.io/docs/api/models/SmsMessageCategory.md)): Declared message category. Values: - `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` (string(date-time)): When the send was attempted (UTC). - `lastStatusAt` (string(date-time)): When the most recent carrier callback was applied (UTC). Null until the first one lands. (nullable) - `tenantId` (string(uuid)): Tenant the message was sent under. (nullable) - `merchantId` (string(uuid)): Merchant the message belongs to. (nullable) ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 429 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. **Content type:** `application/problem+json` Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) Properties: - `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines. - `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable) - `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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. ### cURL ```bash curl -X GET "{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript 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) ```typescript 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(); ``` ### C# (SDK) ```bash dotnet add package WinkPg.Api.Client ``` ```csharp 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) ```csharp 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(); ``` ### Python (SDK) ```bash pip install winkpg-api ``` ```python 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") ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python 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() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.