Single SMS

Send message to a single phone number

Send message to a single recipient 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 Single

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

Request Body

Name
Type
Description

gatewayNumber

string

Gateway number from which the SMS will be sent

message

string

Message ex. "Hi there"

phoneNumber

string

User phone number ex. 0912xxxxxxx

{
  "result": {
    "id": "5c6f6f7984d440d3a02663857447205a",
    "gatewayNumber": "10009909",
    "phoneNumber": "0912*******",
    "message": "Hello from Bitel!",
    "requestDate": 1564573464,
    "status": 0,
    "statusText": "Waiting",
    "partCount": 1,
    "price": 0.0 // price is 0 because the message is waiting
  },
  "error": null
}

Sample Request

{
    "message": "Hi there",
    "phoneNumber": "0912*******",
    "gatewayNumber": "10007200" // optional
}

Sample Response

{
  "result": {
    "id": "5c6f6f7984d440d3a02663857447205a",
    "gatewayNumber": "10009909",
    "phoneNumber": "0912*******",
    "message": "Hello from Bitel!",
    "requestDate": 1564573464,
    "status": 0,
    "statusText": "Waiting",
    "partCount": 1,
    "price": 0.0 // price is 0 because the message is waiting
  },
  "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