Lists SMS consent records for the caller's scope, newest transition first, with cursor-based paging.
GET
/api/twilio/sms-consent
deprecated
Requires: Twilio.SmsConsent.View, merchant scope.
Filters (phone number, status) are optional and combined with AND. Paging is keyset / cursor-based, not skip/take: pass `NextContinuationToken` from the previous response back as `ContinuationToken` to fetch the next page. Sorting supports `StatusChangedAt ASC` / `StatusChangedAt DESC` only and defaults to descending.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
MaxResultCount
required |
query | integer (int32) | Maximum rows per page (1 to PhoeniXGate.Twilio.Sms.GetSmsConsentListInput.MaxPageSize). Values at or below zero use the default page size. |
ContinuationToken
required |
query | string | Opaque cursor returned by a prior call. `null` for the first page. |
IncludeDeleted
required |
query | boolean | Part of the continuation-paging contract (Phoenix.Abp.Core.Application.Contracts.IContinuationPagedRequest). Not applied by the consent list endpoint: consent records are never soft-deleted, so there is no soft-delete filter to toggle. Kept to satisfy the interface; ignored here. |
IncludeInactive
required |
query | boolean | Part of the continuation-paging contract (Phoenix.Abp.Core.Application.Contracts.IContinuationPagedRequest). Not applied by the consent list endpoint: `SmsConsent` has no active/inactive concept. Kept to satisfy the interface; ignored here. |
Sorting
required |
query | string | Sort direction. Only `StatusChangedAt ASC` and `StatusChangedAt DESC` are supported — the cursor encodes (StatusChangedAt, Id). Anything else falls back to `StatusChangedAt DESC`. |
PhoneNumber
required |
query | string | Optional exact-match E.164 phone number filter. |
Status
required |
query | PhoeniXGateTwilioSmsSmsConsentStatus | Optional status filter (opted in / opted out). |
MerchantId
required |
query | string (uuid) | Caller-requested merchant scope. Honoured only when the caller holds `SmsConsent.ViewAllMerchants`; 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.