Request Sender ID

Submit a new sender ID for registration and approval.

Requirements:

• Alphanumeric: 3-11 characters, letters only
• Numeric: 3-15 digits
• Must not contain offensive content
• Business verification may be required

Approval Time:

• Standard: 1-3 business days
• Express: 24 hours (additional fee)

Documents Required:

• Business registration certificate
• Trade license
• Authorization letter (on company letterhead)

POST /senders

Request sender ID

cURL

curl --request POST \
  --url https://api.hixbe.com/sms/senders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Hixbe-Version: <hixbe-version>' \
  --data '
{
  "name": "MYSTORE",
  "type": "alphanumeric",
  "country": "BD",
  "purpose": "E-commerce order notifications and OTP",
  "documents": [
    "https://files.hixbe.com/doc_abc123.pdf"
  ]
}
'

201

{
  "id": "snd_002xyz",
  "name": "MYSTORE",
  "status": "pending",
  "type": "alphanumeric",
  "country": "BD",
  "approved_at": null,
  "rejection_reason": null,
  "created_at": "2026-01-15T10:30:00Z"
}

Authorizations

Authorization · string · header · required

Use your API key as a Bearer token. Format: Authorization: Bearer sk_live_xxxxx

Headers

Hixbe-Version · string · default: 2026-01-01 · required

API version in YYYY-MM-DD format. Using the latest version ensures access to newest features.

Pattern: ^\d{4}-\d{2}-\d{2}$

Body

application/json

name · string · required

Desired sender ID (3-11 characters for alphanumeric)

Required string length: 3 - 11

Example:

"MYSTORE"

type · enum<string> · required

Type of sender ID

Available options: alphanumeric, numeric

Example:

"alphanumeric"

country · string · required

Country code (ISO 3166-1 alpha-2) for registration

Example:

"BD"

purpose · string · required

Intended use of sender ID

Maximum string length: 500

Example:

"E-commerce order notifications and OTP"

documents · string<uri>[]

URLs of supporting documents (uploaded via /files endpoint)

Example:

["https://files.hixbe.com/doc_abc123.pdf"]

Response

201

application/json

Sender ID request submitted

Sender ID registration and approval status

id · string · required

Unique sender ID identifier

Example:

"snd_001abc"

name · string · required

Sender ID name (alphanumeric, 3-11 characters)

Required string length: 3 - 11

Example:

"HIXBE"

status · enum<string> · required

Approval status

Available options: pending, approved, rejected, suspended

Example:

"approved"

type · enum<string> · required

Type of sender ID

Available options: alphanumeric, numeric, shortcode

Example:

"alphanumeric"

country · string

Country code (ISO 3166-1 alpha-2) where sender ID is registered

Example:

"BD"

approved_at · string<date-time> | null

Approval timestamp

Example:

"2025-12-01T09:00:00Z"

rejection_reason · string | null

Reason for rejection (if status is rejected)

Example:

null

created_at · string<date-time>

Creation timestamp

Example:

"2025-11-15T10:00:00Z"