post https://api.verihubs.com/v1/otp/send
This method helps you to generate and send sms containing one-time password to destination number
Rate limit of 50 RPS is applied to SMS service. Verihubs also apply rate limit divided into several categories based on product. More explanation link
Callback Description
When you want to use callback_url payload, you only need to put for example
your-callback-url.com/callback
Example callback that we'll send
your-callback-url.com/callback?session_id=d0f5fb5c-2d50-4d3f-aea7-20018ab15806&status=1
Payload | Description |
---|---|
session_id | ID of the specific message |
status | Latest status of the request |
Status Description
Status | Description | Condition |
---|---|---|
0 | Requested | SMS OTP has been requested. |
1 | Delivered | SMS OTP has been delivered to destination number. This status will be charged. |
2 | Verified | SMS OTP has been verified using verify OTP API. This status will be charged. |
3 | Not Verified | SMS OTP has not been verified after the time limit. This status will be charged. |
4 | Failed | Operator cannot send SMS OTP to destination number |
5 | Request Error | Verihubs cannot reach Operator |
6 | Rejected | Request rejected due to Too Many Requests |
7 | Undelivered | SMS OTP has not been delivered to destination number (response received from Operator). This status will be charged. |
8 | No Delivery Report | Delivered without Delivery Report from Operator after certain period. This status will be charged. |
9 | Blocked | Destination Number has been blocked by Verihubs's system |