SmsConsentCheckResultDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Result of a send-time pre-check: whether SMS may be sent to a phone number for a merchant scope. A send UI uses this to disable the SMS channel for an opted-out recipient before the operator sends (e.g. the invoice pay-link send dialog).
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.
Fields
| Field | Type | Description | ||||
|---|---|---|---|---|---|---|
phoneNumber
required |
string | The E.164-normalized number the check was resolved against. Empty when the input could not be normalized.
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 the check was evaluated 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.
| ||||
hasRecord
required |
boolean | `true` when a consent record exists for this number in scope.
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.
| ||||
status
required |
SmsConsentStatus SmsConsentStatus | The record's current status, or `null` when no record exists.
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.
| ||||
isOptedOut
required |
boolean | `true` when the recipient has opted out: the SMS channel should be disabled.
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.
| ||||
canSendSms
required |
boolean | `true` when a send is currently allowed by the consent store. This is the inverse of
`isOptedOut`: no record and opted-in both allow. (Whether express consent is
<em>required</em> before the first send is a caller policy decision, not enforced here.)
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 model has no documented fields.