SMSMasks

List available masks

Retrieves the masks (senders) enabled for the account of the authenticated API Key. The id field of each mask must be used as the value of the mask field when sending a message. If no masks are configured, an empty array is returned.

Authentication

x-api-keystring

Account authentication key. The App-Key must have the SMS channel enabled; it cannot be used against the endpoints of other channels.

Response

List of available masks.
idstringOptional

Unique identifier of the mask. It is used in the mask field when sending a message.

typeenumOptional
Type of mask configured.
namestringOptional
Descriptive name of the mask.
is_internationalbooleanOptional
Indicates whether the mask is enabled for international sends.
operatorslist of enumsOptional
Operators with an output configured for the mask.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error