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

GET /api/twilio/inbound-messages deprecated

Requires: Twilio.InboundMessages.View, merchant scope.

Paged with a continuation token. Use the keyword filter (typically `None`) to review free-text messages that may carry an unstructured opt-out an operator must honor manually.

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/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.
`ContinuationToken` required	query	string	Opaque cursor returned by a prior call. `null` for the first page.
`IncludeDeleted` required	query	boolean	Disables the soft-delete filter. Honoured only for callers with the relevant permission.
`IncludeInactive` required	query	boolean	Disables the IsActive filter. Honoured only for callers with the relevant permission.
`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.
`Sorting` required	query	string	Sort direction. Only `ReceivedAt ASC` and `ReceivedAt DESC` are supported; anything else falls back to `ReceivedAt DESC`.
`Keyword` required	query	SmsInboundKeyword	Optional keyword-class filter. The common operator query is `None`: the free-text messages that may carry an unstructured revocation.
`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.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.