The API reference is not available right now

This instance could not load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance does not document an operation under that identifier. It may have been renamed, or it may belong to a feature this installation does not have enabled.

Back to the API reference

API reference InboundSmsMessage

Lists inbound-SMS rows for the caller's scope, newest first, with continuation-token paging. Use the keyword filter (typically `None`) to review free-text messages that may carry an unstructured opt-out an operator must honor manually.

GET /api/twilio/inbound-messages deprecated

Requires: Twilio.InboundMessages.View, merchant scope.

**Required permissions**: `Twilio.InboundMessages.View` **Scope**: merchant

Parameters

Name In Type Description
MaxResultCount required query integer (int32) Maximum rows per page. The app service caps this 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.
Sorting required query string Sort direction. Only `ReceivedAt ASC` and `ReceivedAt DESC` are supported; anything else falls back to `ReceivedAt DESC`.
Keyword required query PhoeniXGateTwilioSmsSmsInboundKeyword Optional keyword-class filter. The common operator query is PhoeniXGate.Twilio.Sms.SmsInboundKeyword.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 app service substitutes the operating-context merchant.
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.

Responses

200 OK

Field Type Description

This response has no documented body fields.

403 Forbidden

Field Type Description

This response has no documented body fields.

401 Unauthorized

Field Type Description

This response has no documented body fields.

400 Bad Request

Field Type Description

This response has no documented body fields.

404 Not Found

Field Type Description

This response has no documented body fields.

501 Not Implemented

Field Type Description

This response has no documented body fields.

500 Internal Server Error

Field Type Description

This response has no documented body fields.

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. See the error-code reference in this document's description for the values `error.code` can take.

Field Type Description

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