WAwavix
SMS and MMS

Retrieve a Sender ID

Changed on

Returns the Sender ID identified by id.

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

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v3/messages/sender-ids/{id}
  • Auth
    HTTP bearer

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"
  ]
}

Changes

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 76b9bb35619fRevision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status