gateway

Send several SMS in one call

Sends a batch where every entry has its own text and recipients. deviceId is optional and resolves the same way as POST /gateway/send-sms.

post/api/v1/gateway/send-bulk-sms

Request

  • Base URL: https://api.textbee.dev
  • URL: https://api.textbee.dev/api/v1/gateway/send-bulk-sms
  • Auth: API key in header x-api-key

Request body

messageTemplatestring

Optional label for the batch. Each entry in messages carries its own text.

deviceIdstring

Device to send from. When omitted, uses your default device, or the enabled device with the most recent heartbeat.

Example request

{
  "messages": [
    {
      "message": "Your appointment is confirmed for Tuesday at 10am.",
      "recipients": [
        "+12025550123",
        "+12025550124"
      ],
      "simSubscriptionId": 1,
      "scheduledAt": "2024-01-15T10:30:00Z",
      "receivers": [
        "+12025550123",
        "+12025550124"
      ]
    }
  ]
}

Response

The batch was accepted.

Example response

{
  "data": {
    "message": "SMS added to queue for processing",
    "estimatedCompletionAt": "2026-08-22T14:05:00.000Z",
    "warning": {
      "code": "SMS_PERMISSION_MISSING",
      "message": "The textbee app on this phone last reported the SMS permission as off. The message fails if it is still off."
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.