WAwavix
SMS and MMS

Create a Sender ID

Changed on

Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US. Registering a Sender ID incurs a recurring monthly fee, billed to the account balance.

post/v3/messages/sender-ids

Request

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

Request body

sender_idstring required

Sender ID name. Can be either an alphanumeric string or a phone number.

type'numeric' | 'alphanumeric' required

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

countriesstring[] required

Two-letter ISO country codes where the Sender ID is allowlisted.

usecase'transactional' | 'promo' | 'authentication' required

Primary use case for the Sender ID. One of transactional (account or order notifications), promo (marketing and promotional messages), or authentication (one-time passcodes and verification codes).

monthly_volume'1-1000' | '1001-20000' | '20001-50000' | '50001-100000' | 'More than 100000'

Expected number of messages sent per month from the Sender ID. One of 1-1000, 1001-20000, 20001-50000, 50001-100000, or More than 100000. Each value is the message-count band for the month.

samplesstring[]

Message samples.

Example request

{
  "sender_id": "Wavix",
  "usecase": "transactional",
  "monthly_volume": "1001-20000",
  "samples": [
    "Sample message 1",
    "Sample message 2"
  ]
}

Response

Returns the created Sender ID.

idstring required

Sender ID ID.

sender_idstring required

Sender ID name.

type'numeric' | 'alphanumeric' required

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

allowlisted_instring[] required

List of countries where the Sender ID is allowlisted.

usecasestring

Primary use case declared for the Sender ID, such as transactional, promo, or authentication.

samplesstring[]

Message samples.

Example response

{
  "id": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c",
  "sender_id": "Wavix",
  "usecase": "promo",
  "samples": [
    "Sample message 1",
    "Sample message 2"
  ]
}

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 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 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

    • info

      added the required property to the response with the status

  • 33be77905120Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API