Skip to main content
Endpoint: https://BASE_URL/api/sms/otp/send/voice Request Type: POST Sample Response:
OptionsRequiredDescription
api*keyyes_string*
Your API key (It can be found on your Termii dashboard).
phone*numberyes_string*
The destination phone number. Phone number must be in the international format (Example: 23490126727)
pin*attemptsyesEnum: "NUMERIC" "ALPHANUMERIC" Type of PIN code that will be generated and sent as part of the OTP message. It has a minimum of one attempt.
pin_time_to_liveyes_integer*
Example: 1 Represents how long the PIN is valid before expiration. The time is in minutes. The minimum time value is 0 and the maximum time value is 60
pin*lengthyes_integer*
Example: 4
{
 "api_key" : "Your API key",
 "phone_number" : "23409800000000",
 "pin_attempts" : 10,
 "pin_time_to_live" :  5,
 "pin_length" : 6,
}
Sample Response:
  {
     "code": "ok",
     "message_id": "453166532802459832",
     "pinId": "29ae67c2-c8e1-4165-8a51-8d3d7c298081",
     "message": "Successfully Sent",
     "balance": 77.5,
     "user": "Termii Test"
  }