Template SMS

Send SMS using predefined templates

In order to use predefined templates, register a template in your panel. once the template has been reviewed you can use the template using the following API

Template SMS

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

Request Body

Name	Type	Description
PhoneNumber	string	The target phone number
Params	array	The parameters to replace variables in template
TemplateId	number	The id of the template in Bitel panel

200

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

Sample Request

{
	"phoneNumber": "0912*******",
	"params": ["Bitel", "is", "awesome"],
	"templateId": 1234
}

Sample Response

{
  "result": {
    "id": "5c6f6f7984d440d3a02663857447205a",
    "gatewayNumber": "10009909",
    "phoneNumber": "0912*******",
    "message": "Truth: Bitel is awesome",
    "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 or missing, most likely the phone number
TemplateFormatError	The template variables don't match the given parameters, usually the number of parameters is less than the variables
InvalidTemplate	The template doesn't exist
TemplatePending	The template hasn't yet been reviewed