Send SMS with an OTP code

This endpoint allows you to send an SMS with an OTP code to a given phone number. During send operation, template and OTP code format are determined from your OTP settings. Language and callback URL can be provided in request body, otherwise they are determined from OTP settings. If language is not set in request and settings, the default language is English. This endpoint can send a callback request to your API, for documentation refer to the Callback section.

Header Parameters

Authorization*string

Your API token

Request Body

application/json

Send OTP parameters

callback_url?string

Optional field. It determines the URL for callback. Callback will be sent after SMS reached its final state (DELIVRD, UNDELIV or EXPIRED). If this parameter is not sent, value from the settings will be used.

company?string

Defines sender's name for the SMS.

language?string

Optional field. The value must be an ISO alpha-2 country code in lowercase format (for example: "en", "de", "fr"). If this parameter is sent, language setting will be ignored, and language from this input will be used. If not sent, default language from the settings will be used.

otp_code?string

Optional field. If in your settings otp code generation side is yours, you must send this parameter. If generation side is service, this value will be ignored.

phone_number?string

Defines receiver's phone number.

request_data_send_back?boolean

Optional field. It determines whether response and callback payload should contain request data (this input). If this parameter is not sent, value from the settings will be used.

Response Body

`application/json`

curl -X POST "https://dev-refactor-api-e.voipenv.uk/api/v1/sms/otp/send" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "code": 0,
  "data": {
    "creation_date": "string",
    "otp_code": "string",
    "send_request": {
      "callback_url": "string",
      "company": "string",
      "language": "string",
      "otp_code": "string",
      "phone_number": "string",
      "request_data_send_back": true
    },
    "status": "string"
  },
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "ok"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

Send SMS with an OTP code

Header Parameters

Request Body

Response Body

200application/json

400application/json

500application/json

Contact us

`application/json`

`application/json`

`application/json`