Sign in

v50

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-06-16122182589.7 KB
SMS and MMS

Retrieve a Sender ID

Returns the Sender ID identified by id.

get/v3/messages/sender-ids/{id}

Path parameters

idstring uuid required

The unique ID of the Sender ID.

Response

Returns the Sender ID.

idstring uuid required

Sender ID ID.

sender_idstring required

Sender ID.

type'alphanumeric' | 'numeric' | 'shortcode' required

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

usecasestring

Use case for the Sender ID.

samplesstring[]

Message samples.

allowlisted_instring[]

List of countries where the Sender ID is allowlisted.

Example response

{
  "id": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c",
  "sender_id": "Wavix",
  "type": "alphanumeric",
  "usecase": "promo",
  "samples": [
    "Sample"
  ],
  "allowlisted_in": [
    "GB"
  ]
}