OTP SMS

The message that is sent to user has the following format:

به {appName} خوش آمدید
 کد یکبار مصرف  شما: {code}

The appName and the code is required and must be provided when calling the api.

Send OTP

POST https://api.bitel.rest/api/v1/sms/otp

Request Body

Name	Type	Description
PhoneNumber	string	The target phone number
AppName	string	The name of application, example: Bitel
Code	string	The code that is displayed in the message, example: 1234Ma

200 Result contain the request id

{
    "result": "963551a72f794190ad4fc42fed01aabc",
    "error": null
}

Sample Request

{
	"code": "1234",
	"phoneNumber": "0912*******",
	"appName": "bitel"
}

Error Codes

Code	Description
InvalidRequest	Submitted data is invalid, most likely the phone number

Getting SMS Detail

In order to get the detail of a request, including the delivery status, balance subtracted, delivery time and more please refer to SMS Detail API.