Sign in

v1

latestOpenAPI 3.0.22026-07-2432112226.7 KB
SMS & OTP

SMS Block Number V2

SMS OTP version change is by introducing a new API version release.<br>

Version changes usually need to be applied immediately to the latest version, in order to get a better API usage experience than the previous version.<br>

The benefits you get if you use a newer version are as follows.

  • Decreasing processing time in API Request and Response
  • Improve feature in SMS: Blocking Request, Spam Check, Sequential Phone Number, and Blocked Numbers
  • Increase RPS in SMS (before 30rps to 50rps)
  • Better developer environment to support future developments
  • Improve logging and monitoring on our side
  • Improved dependencies and improved service stability<br>

This method helps you to block phone numbers to not be able to receive message from SMS OTP & SMS Notifications and Promotions services

post/v2/sms-otp/blocked-numbers

Headers

App-IDstring required
API-Keystring required

Request body

msisdnstring required

Destination Phone Number. You need to include international prefix number.

descriptionstring required

Describe reason for blocking specific phone number.

Example request

{
  "msisdn": "62839102839",
  "description": "Fake number"
}

Response

Successful Response

codeinteger required

Code (to be deleted on November 30, 2022)

messagestring required

Message

Example response

{
  "code": 201,
  "message": "Number successfully added to block list"
}