SEND OTP

This endpoint is used to send OTP (One-Time Password) to a recipient. It can also be used to send transactional messages such as payment alerts.

Caution

This endpoint is strictly for sending OTP and transactional messages only. Any misuse, such as sending promotional messages, is a violation and may result in access restrictions.

Tip

Checkout code examples in Send SMS.

GET Method

Endpoint:

https://{{url}}/api/services/sendotp

Parameters:

Parameter	Description
apikey	Your valid API key
partnerID	Your Partner ID
message	URL-encoded OTP message (GSM7)
shortcode	Sender ID/Shortcode
mobile	Recipient Mobile number

Example Request (GET):

https://{{url}}/api/services/sendotp?apikey={{apikey}}&partnerID={{partnerID}}&message={{message}}&shortcode={{shortcode}}&mobile={{mobile}}

POST Method

Endpoint:

https://{{url}}/api/services/sendotp

Request Body:

{
    "apikey": "{{apikey}}",
    "partnerID": "{{partnerID}}",
    "mobile": "{{mobile}}",
    "message": "{{message}}",
    "shortcode": "{{shortcode}}"
  }

Sample Success Response:

{
    "responses":[
      {
        "response-code":200,
        "response-description":"Success",
        "mobile": "xxxxxxxxxxxxx",
        "messageid": "xxxxxxxxxxx",
        "networkid":1
      }
    ]
  }

Sample Error Response:

{
    "response-code":1006,
    "response-description":"Invalid credentials"
  }