# GET /api/twilio/inbound-messages

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

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.

**Operation ID:** `inboundSmsMessageGetList`

## Authorization

Requires: Twilio.InboundMessages.View, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Twilio.InboundMessages.View`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| MaxResultCount | query | no | integer(int32) | Maximum rows per page, capped at 100. |
| ContinuationToken | query | no | string | Opaque cursor returned by a prior call. `null` for the first page. |
| IncludeDeleted | query | no | boolean | Disables the soft-delete filter. Honoured only for callers with the relevant permission. |
| IncludeInactive | query | no | boolean | Disables the IsActive filter. Honoured only for callers with the relevant permission. |
| IncludeApproxTotalCount | query | no | 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 | query | no | string | Sort direction. Only `ReceivedAt ASC` and `ReceivedAt DESC` are supported; anything else  falls back to `ReceivedAt DESC`. |
| Keyword | query | no | [SmsInboundKeyword](https://devportal.demo.winkpg.io/docs/api/models/SmsInboundKeyword.md) | Optional keyword-class filter. The common operator query is  `None`: the free-text messages that may carry an unstructured revocation. |
| MerchantId | query | no | 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 | query | no | boolean | If true, omit properties with null values. |

**`Keyword` values**

| Value | Description |
| --- | --- |
| `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. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`ContinuationPagedResultDtoOfInboundSmsMessageDto`](https://devportal.demo.winkpg.io/docs/api/models/ContinuationPagedResultDtoOfInboundSmsMessageDto.md)

Properties:
- `items` (array<[InboundSmsMessageDto](https://devportal.demo.winkpg.io/docs/api/models/InboundSmsMessageDto.md)>): The items returned for this page. (nullable)
  Fields of each item:
  - `id` (string(uuid)): Row id.
  - `messageSid` (string): Twilio inbound message SID. (nullable)
  - `fromPhoneNumber` (string): Sender number (E.164): the recipient who texted in. (nullable)
  - `toPhoneNumber` (string): The platform number the message was sent to (E.164). (nullable)
  - `body` (string): The message body after card-number redaction. (nullable)
  - `keyword` ([SmsInboundKeyword](https://devportal.demo.winkpg.io/docs/api/models/SmsInboundKeyword.md)): Keyword classification of the message.
    Values:
    - `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` (string(uuid)): Tenant scope of the row. (nullable)
  - `merchantId` (string(uuid)): Merchant scope of the row. (nullable)
  - `receivedAt` (string(date-time)): When the message was received (UTC).
- `nextContinuationToken` (string): Continuation token to use when requesting the next page.  Null means no additional pages exist. (nullable)
- `approxTotalCount` (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)
- `pageItemCount` (integer(int32)): Convenience property for the number of items in this page. (read only)
- `retrievedAt` (string(date-time)): When the page was retrieved. Useful for diagnostics and cache behavior.

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

### PowerShell

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

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

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

### C# (raw HTTP)

```csharp
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();
```

### 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.InboundSmsMessageApi(client)
    result = api.inbound_sms_message_get_list()
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.