Batch SMS

Sending one message to multiple phone numbers

Send message to multiple recipients using the default or dedicated gateway number.

The default gateway number doesn't deliver messages to black listed number, however a dedicated gateway number can be purchased to overcome this limitation.

SMS Batch

POST https://api.bitel.rest/api/v2/sms/batch

Request Body

Name
Type
Description

gatewayNumber

string

Gateway number from which the SMS will be sent (up to 100 numbers)

message

string

Message ex. "Hi there"

phoneNumbers

array

Array containing user phone numbers

{
  "result": [
    {
      "id": "39011bf93c9d427fb853b441a73337da",
      "gatewayNumber": "10009909",
      "phoneNumber": "0912*******",
      "message": "Hello from Bitel!",
      "requestDate": 1564575254,
      "status": 0,
      "statusText": "Waiting",
      "partCount": 1,
      "price": 0.0
    },
    {
      "id": "8f0f3c9de6b2439aba6ba4a24e706a81",
      "gatewayNumber": "10009909",
      "phoneNumber": "0912*******",
      "message": "Hello from Bitel!",
      "requestDate": 1564575254,
      "status": 0,
      "statusText": "Waiting",
      "partCount": 1,
      "price": 0.0
    }
  ],
  "error": null
}

Sample Request

{
    "message": "Hi",
    "phoneNumbers": [
        "0912*******",
        "0936*******"
    ],
    "gatewayNumber": "10007200" // optional
}

Sample Response

{
  "result": [
    {
      "id": "39011bf93c9d427fb853b441a73337da",
      "gatewayNumber": "10009909",
      "phoneNumber": "0912*******",
      "message": "Hello from Bitel!",
      "requestDate": 1564575254,
      "status": 0,
      "statusText": "Waiting",
      "partCount": 1,
      "price": 0.0
    },
    {
      "id": "8f0f3c9de6b2439aba6ba4a24e706a81",
      "gatewayNumber": "10009909",
      "phoneNumber": "0912*******",
      "message": "Hello from Bitel!",
      "requestDate": 1564575254,
      "status": 0,
      "statusText": "Waiting",
      "partCount": 1,
      "price": 0.0
    }
  ],
  "error": null
}

Getting SMS Status

In order to get the detail of a request, including the delivery status, price and more please refer to Sms Status API.

Error Codes

Code

Description

InvalidRequest

Submitted data is invalid

InvalidGateway

Gateway number is invalid, or the client doesn't have access to it

Last updated