Voice OTP Generation

Generate Voice OTP for phone verification.

https://frogapi.wigal.com.gh/api/v3/voice/otp/generate

Request Object

Field	Type	Description
number	string	The recipient's phone number.
expiry	integer	The time duration before the OTP expires (in minutes).
length	integer	The length of the OTP code.
messagetemplate	string	The message template with placeholders.
type	string	Type of OTP (NUMERIC/ALPHA/ALPHANUMERIC).
callerid	string	Caller ID for the voice call (optional). If null, A Generic phone number will be used. You can also purchase a dedicated callerid.
ttsvoicename	string	Text-to-Speech voice name (optional). Available options: Male: "Charon", "Fenrir", "Orus", "Puck" Female: "Achernar", "Aoede", "Erinome", "Gacrux", "Kore", "Leda", "Sulafat", "Zephyr"

Placeholders

Available placeholders: %EXPIRY%, %OTPCODE%, %SERVICE%, %LENGTH%, %TYPE%.

%EXPIRY%	Expiry time in minutes
%OTPCODE%	Generated OTP code
%SERVICE%	Service/Application name
%LENGTH%	OTP code length
%TYPE%	OTP code type

Responses

Field	Type	Description
status	string	Returns "SUCCESS" when OTP is generated
message	string	Confirmation message

Field	Type	Description
status	string	Error status ("ERROR")
message	string	Error description ("Insufficient Balance")

Field	Type	Description
status	string	Error status code
message	string	Error description

Field	Type	Description
status	string	Error status code ("ERROR")
message	string	Error description ("Message template must contain %OTPCODE% placeholder")

Field	Type	Description
status	string	Server error status
message	string	Internal server error message

Endpoint

Content type

application/json

curl -X POST 'https://frogapi.wigal.com.gh/api/v3/voice/otp/generate'
-H "API-KEY: your_api_key_here"
-H "USERNAME: your_username_here"
-d '{"your_request_body_here"}'

const apiKey = 'your_api_key_here'; // Replace with your API Key
const username = 'your_username_here'; // Replace with your Username

const postData = {
    number: "0541234567",
    expiry: 15,
    length: 5,
    messagetemplate: "Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins. The code again: %OTPCODE%, for the last time: %OTPCODE%",
    type: "NUMERIC",
    callerid: null,
    ttsvoicename: null
};

fetch('https://frogapi.wigal.com.gh/api/v3/voice/otp/generate', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'API-KEY': apiKey,
        'USERNAME': username
    },
    body: JSON.stringify(postData)
})
.then(response => response.json())
.then(data => {
    console.log(data);
})
.catch(error => {
    console.error('Error:', error);
});

import requests
import json

api_key = 'your_api_key_here' # Replace with your API Key
username = 'your_username_here' # Replace with your Username

post_data = {
    "number": "0541234567",
    "expiry": 15,
    "length": 5,
    "messagetemplate": "Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins. The code again: %OTPCODE%, for the last time: %OTPCODE%",
    "type": "NUMERIC",
    "callerid": None,
    "ttsvoicename": None
}

headers = {
    'Content-Type': 'application/json',
    'API-KEY': api_key,
    'USERNAME': username
}

response = requests.post('https://frogapi.wigal.com.gh/api/v3/voice/otp/generate', headers=headers, data=json.dumps(post_data))

print(response.json())



$apiKey = 'your_api_key_here'; // Replace with your API Key
$username = 'your_username_here'; // Replace with your Username

$postData = array(
    'number' => '0541234567',
    'expiry' => 15,
    'length' => 5,
    'messagetemplate' => 'Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins. The code again: %OTPCODE%, for the last time: %OTPCODE%',
    'type' => 'NUMERIC',
    'callerid' => null,
    'ttsvoicename' => null
);

$ch = curl_init('https://frogapi.wigal.com.gh/api/v3/voice/otp/generate');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'API-KEY: ' . $apiKey,
    'USERNAME: ' . $username
));

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($postData));

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);

?>

Request Object

200

Content type

application/json

{
  "number": "0541234567",
  "expiry": 15,
  "length": 5,
  "messagetemplate": "Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins. The code again: %OTPCODE%, for the last time: %OTPCODE%",
  "type": "NUMERIC",
  "callerid": null,
  "ttsvoicename": null
}

Response Object

Content type

application/json

{
              "status": "SUCCESS",
              "message": "Voice OTP processed for delivery"
            }

{
                "status": "ERROR",
                "message": "Insufficient balance to process request"
              }

{
              "status": "ERROR",
              "message": "Invalid phone number format"
            }

{
                "status": "ERROR",
                "message": "Message template must contain %OTPCODE% placeholder"
              }

{
              "status": "ERROR",
              "message": "Internal server error"
            }