gateway

Get a send batch

The batch returned by a send, plus one message per recipient. The batch status and counts are calculated from the messages, so they follow each status report from the phone. Poll this to see how a send is progressing.

get/api/v1/gateway/devices/{id}/sms-batch/{smsBatchId}

Request

  • Base URL: https://api.textbee.dev
  • URL: https://api.textbee.dev/api/v1/gateway/devices/{id}/sms-batch/{smsBatchId}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Device id, from GET /gateway/devices.

smsBatchIdstring required

Batch id, returned as smsBatchId by the send endpoints.

Response

The batch and its messages.

Example response

{
  "data": {
    "batch": {
      "recipientPreview": "+12025550123 and 3 others",
      "successCount": 3,
      "failureCount": 1,
      "sentCount": 1,
      "deliveredCount": 2,
      "status": "partial_success"
    },
    "messages": [
      {
        "device": {
          "name": "Office phone",
          "brand": "google",
          "model": "Pixel 7"
        },
        "simUsed": {
          "subscriptionId": 19,
          "slotIndex": 1
        }
      }
    ]
  }
}

Changes

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