SMS OTP Implementation

Generate SMS OTP.

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

Request Object

Field	Type	Description
number	string	The recipient's phone number.
expiry	integer	The time duration before the OTP expires.
length	integer	The length of the OTP code.
messagetemplate	string	The message template with placeholders.
type	string	Type of OTP (NUMERIC/ALPHA/ALPHANUMERIC).
senderid	string	Approved Sender ID.

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

SMS OTP Verification

Verify SMS OTP code.

https://frogapi.wigal.com.gh/api/v3/sms/otp/verify

Request Object

Field	Type	Description
otpcode	string	The OTP code to be verified.
number	string	The recipient's phone number.

Response Object

Field	Type	Description
status	string	The status of the request.
message	string	The message response.

Responses

Field	Type	Description
status	string	Verification success status
message	string	Confirmation message

Field	Type	Description
status	string	Status Message ("ERROR")
message	string	Error description ("Missing required fields")

Field	Type	Description
status	string	Verification error status
message	string	Error description

Field	Type	Description
status	string	Status Message ("ERROR")
message	string	Error description ("OTP code has expired")

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

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

Endpoint

Content type

application/json

curl -X POST 'https://frogapi.wigal.com.gh/api/v3/sms/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: "0276128036",
    expiry: 1,
    length: 5,
    messagetemplate: "Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins",
    type: "ALPHANUMERIC",
    senderid: "Stevkky"
};

fetch('https://frogapi.wigal.com.gh/api/v3/sms/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": "0276128036",
    "expiry": 1,
    "length": 5,
    "messagetemplate": "Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins",
    "type": "ALPHANUMERIC",
    "senderid": "Stevkky"
}

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

response = requests.post('https://frogapi.wigal.com.gh/api/v3/sms/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' => '0276123036',
    'expiry' => 1,
    'length' => 5,
    'messagetemplate' => 'Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins',
    'type' => 'ALPHANUMERIC',
    'senderid' => 'Stevkky'
);

$ch = curl_init('https://frogapi.wigal.com.gh/api/v3/sms/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": "0276128936",
  "expiry": 1,
  "length": 5,
  "messagetemplate": "Hello, your OTP is : %OTPCODE%. It will expire after %EXPIRY% mins",
  "type": "ALPHANUMERIC",
  "senderid": "Stevkky"
}

Response Object

Content type

application/json

{
              "status": "SUCCESS",
              "message": "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"
            }

POST https://frogapi.wigal.com.gh/api/v3/sms/otp/verify

Endpoint

Content type

application/json

curl -X POST 'https://frogapi.wigal.com.gh/api/v3/sms/otp/verify'
-H "API-KEY: your_api_key_here"
-H "USERNAME: your_username_here"
-d '{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 = {
    otpcode: 'otp_code_here',
    number: 'recipient_phone_number'
};

fetch('https://frogapi.wigal.com.gh/api/v3/sms/otp/verify', {
    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 = {
    'otpcode': 'otp_code_here',
    'number': 'recipient_phone_number'
}

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

response = requests.post('https://frogapi.wigal.com.gh/api/v3/sms/otp/verify', 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(
    'otpcode' => 'otp_code_here',
    'number' => 'recipient_phone_number'
);

$ch = curl_init('https://frogapi.wigal.com.gh/api/v3/sms/otp/verify');
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

{
              "otpcode": "8a2b3",
              "number": "0276128936"
            }

Response Object

Content type

application/json

{
              "status": "SUCCESS",
              "message": "OTP verified successfully"
            }

{
                "status": "ERROR",
                "message": "Missing required fields"
              }

{
              "status": "ERROR",
              "message": "Invalid OTP code"
            }

{
                "status": "ERROR",
                "message": "OTP code has expired"
              }

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