> ## Documentation Index > Fetch the complete documentation index at: https://docs.xerobi.com/llms.txt > Use this file to discover all available pages before exploring further. # 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) ## OpenAPI ````yaml POST /senders openapi: 3.1.0 info: title: Xerobi SMS Gateway API version: '2026-01-01' description: >- A modern, developer-friendly SMS Gateway API supporting transactional, OTP, promotional and bulk messaging. ## Overview The Xerobi SMS Gateway API enables you to send SMS messages programmatically with support for: - **Transactional SMS**: Account notifications, confirmations, alerts - **OTP Messages**: One-time passwords with optimized delivery routes - **Promotional SMS**: Marketing campaigns and announcements - **Bulk Messaging**: Send to thousands of recipients efficiently - **Templates**: Reusable message templates with variable substitution - **Webhooks**: Real-time delivery status notifications ## Authentication Authenticate using your API key as a Bearer token: ```bash curl -H "Authorization: Bearer sk_live_xxxxx" \ -H "Xerobi-Version: 2026-01-01" \ https://api.hixbe.com/sms/messages ``` **API Key Types:** - `sk_live_*` - Production keys for live messaging - `sk_test_*` - Test keys for development (no actual SMS sent) Get your API keys from the [Xerobi Dashboard](https://dashboard.hixbe.com/api-keys). ## Rate Limits - **Standard accounts**: 100 requests/minute - **Business accounts**: 1,000 requests/minute - **Enterprise accounts**: Custom limits Rate limit headers are included in all responses: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Requests remaining - `X-RateLimit-Reset`: Unix timestamp when limit resets ## Message Routes Different routes optimize for delivery speed, reliability, and cost: | Route | Use Case | Delivery Speed | Cost | |-------|----------|----------------|------| | **otp** | One-time passwords | < 5 seconds | Premium | | **transactional** | Notifications, alerts | < 30 seconds | Standard | | **promotional** | Marketing messages | < 2 minutes | Economy | ## Phone Number Format Phone numbers must be in international format without + or spaces: - ✅ Correct: `8801712345678` (Bangladesh) - ✅ Correct: `14155551234` (USA) - ❌ Incorrect: `+880 171 234 5678` - ❌ Incorrect: `01712345678` ## Idempotency Include `Idempotency-Key` header to safely retry requests: ```bash curl -H "Idempotency-Key: unique-key-123" \ -H "Authorization: Bearer sk_live_xxxxx" \ ... ``` ## Webhooks Receive real-time delivery updates via webhooks. Events include: - `message.queued` - Message accepted and queued - `message.sent` - Message sent to carrier - `message.delivered` - Successfully delivered - `message.failed` - Delivery failed ## Support Need help? Contact us: - Email: support@xerobi.com - Documentation: https://developer.hixbe.com - Status: https://status.hixbe.com contact: name: Xerobi Developer Support url: https://developer.hixbe.com email: support@xerobi.com termsOfService: https://hixbe.com/terms license: name: Commercial url: https://hixbe.com/license servers: - url: https://api.hixbe.com/sms description: Production Server - url: https://api-sandbox.hixbe.com/sms description: Sandbox Server (test mode) security: - bearerAuth: [] tags: - name: Messages description: Send and track individual SMS messages - name: Bulk description: CSV and list-based bulk sending for campaigns - name: Senders description: Manage sender IDs and registration - name: Templates description: Create and manage message templates with variables - name: Reports description: Delivery statistics and usage analytics - name: Account description: Balance, usage limits and account profile - name: Webhooks description: Configure delivery report callbacks paths: /senders: post: tags: - Senders summary: Request sender ID description: |- 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) operationId: requestSenderID parameters: - $ref: '#/components/parameters/Xerobi-Version' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Desired sender ID (3-11 characters for alphanumeric) example: MYSTORE minLength: 3 maxLength: 11 type: type: string enum: - alphanumeric - numeric description: Type of sender ID example: alphanumeric country: type: string description: Country code (ISO 3166-1 alpha-2) for registration example: BD purpose: type: string description: Intended use of sender ID example: E-commerce order notifications and OTP maxLength: 500 documents: type: array description: URLs of supporting documents (uploaded via /files endpoint) items: type: string format: uri example: - https://files.hixbe.com/doc_abc123.pdf required: - name - type - country - purpose responses: '201': description: Sender ID request submitted content: application/json: schema: $ref: '#/components/schemas/Sender' example: id: snd_002xyz name: MYSTORE status: pending type: alphanumeric country: BD approved_at: null rejection_reason: null created_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' components: parameters: Xerobi-Version: name: Xerobi-Version in: header description: >- API version in YYYY-MM-DD format. Using the latest version ensures access to newest features. required: true schema: type: string default: '2026-01-01' pattern: ^\d{4}-\d{2}-\d{2}$ example: '2026-01-01' schemas: Sender: type: object description: Sender ID registration and approval status properties: id: type: string description: Unique sender ID identifier example: snd_001abc name: type: string description: Sender ID name (alphanumeric, 3-11 characters) example: HIXBE minLength: 3 maxLength: 11 status: type: string enum: - pending - approved - rejected - suspended description: Approval status example: approved type: type: string enum: - alphanumeric - numeric - shortcode description: Type of sender ID example: alphanumeric country: type: string description: Country code (ISO 3166-1 alpha-2) where sender ID is registered example: BD approved_at: type: string format: date-time nullable: true description: Approval timestamp example: '2025-12-01T09:00:00Z' rejection_reason: type: string nullable: true description: Reason for rejection (if status is rejected) example: null created_at: type: string format: date-time description: Creation timestamp example: '2025-11-15T10:00:00Z' required: - id - name - status - type Error: type: object description: Standard error response with detailed information properties: error: type: object properties: type: type: string description: Error category for programmatic handling example: validation_error code: type: string description: Specific error code example: invalid_phone_number message: type: string description: Human-readable error message example: >- Phone number must be in international format without spaces or special characters param: type: string nullable: true description: Parameter that caused the error example: to request_id: type: string description: Unique request identifier for support and debugging example: req_abc123xyz doc_url: type: string description: Link to relevant documentation example: https://developer.hixbe.com/errors/invalid-phone-number required: - type - code - message - request_id required: - error responses: ValidationError: description: Request validation failed content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: validation_error code: invalid_phone_number message: >- Phone number must be in international format (e.g., 8801712345678) param: to request_id: req_def456 doc_url: https://developer.hixbe.com/phone-format Unauthorized: description: Authentication failed - invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: authentication_error code: invalid_api_key message: >- Invalid API key provided. Check your API key at https://dashboard.hixbe.com/api-keys request_id: req_abc123 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: APIKEY description: >- Use your API key as a Bearer token. Format: `Authorization: Bearer sk_live_xxxxx` ```` ## Related topics - [Error Handling](https://docs.xerobi.com/faq-guides/error-handling.md) - [SMS API FAQ](https://docs.xerobi.com/faq-guides/sms-api-faq.md) - [Xerobi SMS Gateway API Introduction](https://docs.xerobi.com/sms-api/introduction.md) - [List Sender IDs](https://docs.xerobi.com/sms-api/endpoint/list-senders.md) - [Get Request Trace](https://docs.xerobi.com/payment-api/endpoint/get-request-trace.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.