Send Voice

Send voice messages

https://frogapi.wigal.com.gh/api/v3/voice/send

Request Object

Field	Type	Description
callerid	string	The caller ID used for the voice call. Note: If you don't add a caller ID, a default one will be used. If you want a specific caller ID, you must subscribe to it.
soundurl	string	URL to the sound file to be played. Accepted sound: WAV file (Channels: mono, Format: wav(a-law), Sample rate: 8KHz, Bit rate: 64kbps)
servicetype	string	The type of service. Default is "CALL"
destinations	array	Array of destination objects containing destination phone number and message ID
destinations[].destination	string	Recipient Phone Number
destinations[].msgid	string	Your message ID

Response Object

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

Responses

Field	Type	Description
status	string	Returns "ACCEPTD" when voice message is successfully accepted for processing
message	string	Returns "Message Accepted For Processing" on successful request

Field	Type	Description
status	string	Error status code ("INVALID_REQUEST")
message	string	Detailed error message explaining the issue

Field	Type	Description
status	string	Error status code ("UNAUTHORIZED")
message	string	Message Response

Field	Type	Description
status	string	Error status code ("FORBIDDEN")
message	string	Message Response

Field	Type	Description
status	string	Error status code
message	string	Detailed error message explaining the issue

Field	Type	Description
status	string	Returns "ERROR" for server errors
message	string	Generic error message "Internal server error"

Endpoint

Content type

application/json

Example

Send Voice Message

curl -X POST 'https://frogapi.wigal.com.gh/api/v3/voice/send'
-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 = {
    "callerid": "your_caller_id",
    "soundurl": "https://example.com/sound.wav",
    "servicetype": "CALL",
    "destinations": [{
        "destination": "0276128936",
        "msgid": "MSG123456789"
    }]
};

fetch('https://frogapi.wigal.com.gh/api/v3/voice/send', {
    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 = {
    'callerid': 'your_caller_id',
    'soundurl': 'https://example.com/sound.wav',
    'servicetype': 'CALL',
    'destinations': [{
        'destination': '0276128936',
        'msgid': 'MSG123456789'
    }]
}

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

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

print(response.json())

<?php
$apiKey = 'your_api_key_here'; // Replace with your API Key
$username = 'your_username_here'; // Replace with your Username
$postData = array(
    'callerid' => 'your_caller_id',
    'soundurl' => 'https://example.com/sound.wav',
    'servicetype' => 'CALL',
    'destinations' => array(
        array(
            'destination' => '0276128936',
            'msgid' => 'MSG123456789'
        )
    )
);

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

{
              "callerid": "your_caller_id",
              "soundurl": "https://example.com/sound.wav",
              "servicetype": "CALL",
              "destinations": [
                {
                  "destination": "0276128936",
                  "msgid": "MSG123456789"
                }
              ]
            }

Response Object

Content type

application/json

{
              "status": "ACCEPTD",
              "message": "Message Accepted For Processing"
            }

{
                "status": "ERROR",
                "message": "Invalid request parameters"
              }

{
              "status": "UNAUTHORIZED",
              "message": "Authentication failed"
            }

{
                "status": "FORBIDDEN",
                "message": "Insufficient permissions"
              }

{
              "status": "ERROR",
              "message": "Resource not found"
            }

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