https://BASE_URL/api/sms/otp/send
Request Type: POST
Sample Response:
| Options | Required | Description |
|---|---|---|
| api*key | yes | _string* Your API key (It can be found on your Termii dashboard). |
| message*type | yes | Enum: "NUMERIC" "ALPHANUMERIC" Type of message that will be generated and sent as part of the OTP message. You can set message type to numeric or alphanumeric |
| to | yes | _string* Represents the email address if the channel is set to email ( Example: testshola@termii.com). It represents the destination phone number if other channels are selected. Phone number must be in the international format (Example: 23490126727) |
| from | yes | string Represents the configuration ID if the channel is set to email ( Example: 0a53c416-uocj-95af-ab3c306aellc). It can be found on your Termii dashboard. If other channels are selected, it represents a sender ID which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example: CompanyName) |
| channel | yes | string This is the route through which the message is sent. It is either dnd, WhatsApp, or generic or email |
| pin*attempts | yes | _integer* Example: 3 Represents the number of times the PIN can be attempted before expiration. It has a minimum of one attempt |
| pin*times_to_live | yes | _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*length | yes | _integer* Example: 4 The length of the PIN code. It has a minimum of 4 and maximum of 8. |
| pin*placeholder | yes | _string* Example: "< 1234 >" PIN placeholder. Right before sending the message, PIN code placeholder will be replaced with generate PIN code. |
| message*text | yes | _string* Text of a message that would be sent to the destination phone number |
{
"api_key" : "Your API key",
"message_type" : "NUMERIC",
"to" : "eg. 2348109077743",
"from" : "Approved Sender ID or Configuration ID",
"channel" : "dnd",
"pin_attempts" : 10,
"pin_time_to_live" : 5,
"pin_length" : 6,
"pin_placeholder" : "< 1234 >",
"message_text" : "Your pin is < 1234 >",
"pin_type" : "NUMERIC"
}
var data = {
"api_key" : "Your API key",
"message_type" : "NUMERIC",
"to" : "eg. 2348109077743",
"from" : "Approved Sender ID or Configuration ID",
"channel" : "dnd",
"pin_attempts" : 10,
"pin_time_to_live" : 5,
"pin_length" : 6,
"pin_placeholder" : "< 1234 >",
"message_text" : "Your pin is < 1234 >",
"pin_type" : "NUMERIC"
};
var data = JSON.stringify(data);
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://BASE_URL/api/sms/otp/send");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
var request = require('request');
var data = {
"api_key" : "Your API key",
"message_type" : "NUMERIC",
"to" : "eg. 2348109077743",
"from" : "Approved Sender ID or Configuration ID",
"channel" : "dnd",
"pin_attempts" : 10,
"pin_time_to_live" : 5,
"pin_length" : 6,
"pin_placeholder" : "< 1234 >",
"message_text" : "Your pin is < 1234 >",
"pin_type" : "NUMERIC"
};
var options = {
'method': 'POST',
'url': 'https://BASE_URL/api/sms/otp/send',
'headers': {
'Content-Type': ['application/json', 'application/json']
},
body: JSON.stringify(data)
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://BASE_URL/api/sms/otp/send"
payload = {
"api_key" : "Your API key",
"message_type" : "NUMERIC",
"to" : "eg. 2348109077743",
"from" : "Approved Sender ID or Configuration ID",
"channel" : "dnd",
"pin_attempts" : 10,
"pin_time_to_live" : 5,
"pin_length" : 6,
"pin_placeholder" : "< 1234 >",
"message_text" : "Your pin is < 1234 >",
"pin_type" : "NUMERIC"
}
headers = {
'Content-Type': 'application/json',
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)
RestClient restClient = new RestClient("https://BASE_URL/api/sms/otp/send");
//Creating Json object
JObject objectBody = new JObject();
objectBody.Add("api_key","Your API Key");
objectBody.Add("message_type","NUMERIC");
objectBody.Add("to","+2348109077743");
objectBody.Add("from","Approved Sender ID or Configuration ID");
objectBody.Add("channel","dnd");
objectBody.Add("pin_attempts", 3);
objectBody.Add("pin_time_to_live", 0);
objectBody.Add("pin_length", 6);
objectBody.Add("pin_placeholder", "< 1234 >");
objectBody.Add("message_text", "Your pin is < 1234 >");
objectBody.Add("pin_type","NUMERIC");
RestRequest restRequest = new RestRequest(Method.POST);
restRequest.AddHeader("Content-Type", "application/json");
restRequest.AddParameter("application/json", objectBody, ParameterType.RequestBody);
IRestResponse restResponse = restClient.Execute(restRequest);
Console.WriteLine(restResponse.Content);
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://BASE_URL/api/sms/otp/send")
.header("Content-Type", "application/json")
.body("{\r\n \"api_key\" : \"Your API key\",\r\n \"message_type\" : \"NUMERIC\",\r\n \"to\" : \"eg. 2348109077743\",\r\n \"from\" : \"Approved Sender ID or Configuration ID\",\r\n \"channel\" : \"dnd\",\r\n \"pin_attempts\" : 10,\r\n \"pin_time_to_live\" : 5,\r\n \"pin_length\" : 6,\r\n \"pin_placeholder\" : \"< 1234 >\",\r\n \"message_text\" : \"Your pin is < 1234 >\",\r\n \"pin_type\" : \"NUMERIC\"\r\n }\r\n ")
.asString();
$curl = curl_init();
$data = array( "api_key" => "Your API key",
"message_type" => "NUMERIC",
"to" => "eg. 2348109077743",
"from" => "Approved Sender ID or Configuration ID",
"channel" => "dnd",
"pin_attempts" => 10,
"pin_time_to_live" => 5,
"pin_length" => 6,
"pin_placeholder" => "< 1234 >",
"message_text" => "Your pin is < 1234 >",
"pin_type" => "NUMERIC");
$post_data = json_encode($data);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://BASE_URL/api/sms/otp/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $post_data,
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"pinId": "29ae67c2-c8e1-4165-8a51-8d3d7c298081",
"to": "2348109077743",
"smsStatus": "Message Sent"
}