Skip to main content
GET
Retrieve a Sender ID

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Path Parameters

id
string<uuid>
required

The unique ID of the Sender ID.

Response

Returns the Sender ID.

id
string<uuid>
required

Sender ID ID.

Example:

"3c7a5a90-43e0-43e0-b006-fdfea30c5a7c"

sender_id
string
required

Sender ID.

Example:

"Wavix"

type
enum<string>
required

Format of the Sender ID. One of alphanumeric (a text sender name), numeric (a phone number), or shortcode (a short code).

Available options:
alphanumeric,
numeric,
shortcode
Example:

"alphanumeric"

usecase
string

Use case for the Sender ID.

Example:

"promo"

samples
string[]

Message samples.

allowlisted_in
string[]

List of countries where the Sender ID is allowlisted.