Lists inbound-SMS rows for the caller's scope, newest first.

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/inbound-messages" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/inbound-messages' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.inboundSmsMessageGetList();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/twilio/inbound-messages', {
  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 InboundSmsMessageApi(config);
var result = await api.InboundSmsMessageGetListAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/twilio/inbound-messages");
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.InboundSmsMessageApi(client)
    result = api.inbound_sms_message_get_list()

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/twilio/inbound-messages",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

MaxResultCount required

query

integer (int32)

Maximum rows per page, capped at 100.

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.

ContinuationToken required

query

string

Opaque cursor returned by a prior call. `null` for the first page.

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.

IncludeDeleted required

query

boolean

Disables the soft-delete filter. Honoured only for callers with the relevant permission.

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.

IncludeInactive required

query

boolean

Disables the IsActive filter. Honoured only for callers with the relevant permission.

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.

IncludeApproxTotalCount required

query

boolean

Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before.

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.

Sorting required

query

string

Sort direction. Only `ReceivedAt ASC` and `ReceivedAt DESC` are supported; anything else falls back to `ReceivedAt DESC`.

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.

Keyword required

query

SmsInboundKeyword SmsInboundKeyword

Optional keyword-class filter. The common operator query is `None`: the free-text messages that may carry an unstructured revocation.

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.

`None`	Not a recognized keyword. The message is persisted for operator review; no consent change.
`OptOut`	An opt-out keyword (STOP, STOPALL, UNSUBSCRIBE, OPTOUT, CANCEL, END, REVOKE, QUIT).
`OptIn`	An opt-in / re-subscribe keyword (START, UNSTOP, YES).
`Help`	The HELP keyword: the recipient asked for program identification and a support contact.

MerchantId required

query

string (uuid)

Caller-requested merchant scope. Honoured only when the caller has the `InboundMessages.ViewAllMerchants` permission; otherwise the caller's own merchant is used.

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

OK

Body: ContinuationPagedResultDtoOfInboundSmsMessageDto ContinuationPagedResultDtoOfInboundSmsMessageDto Each item has these fields.

Field Type Description

items required

array of InboundSmsMessageDto array of InboundSmsMessageDto

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

Field Type Description

id required

string (uuid)

Row id.

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 inbound message SID. 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.

fromPhoneNumber required

string

Sender number (E.164): the recipient who texted in. 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.

toPhoneNumber required

string

The platform number the message was sent to (E.164). 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.

body required

string

The message body after card-number redaction. 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.

keyword required

SmsInboundKeyword SmsInboundKeyword

Keyword classification of the message.

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.

`None`	Not a recognized keyword. The message is persisted for operator review; no consent change.
`OptOut`	An opt-out keyword (STOP, STOPALL, UNSUBSCRIBE, OPTOUT, CANCEL, END, REVOKE, QUIT).
`OptIn`	An opt-in / re-subscribe keyword (START, UNSTOP, YES).
`Help`	The HELP keyword: the recipient asked for program identification and a support contact.

tenantId required

string (uuid)

Tenant scope of the row. 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 scope of the row. 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.

receivedAt required

string (date-time)

When the message was received (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.

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

Lists inbound-SMS rows for the caller's scope, newest first.

Example request

Parameters

Request body

Responses

Errors

Authentication