Sent Message History

Retrieve all sent message history using the REST API.

https://frogtestapi.wigal.com.gh/api/v3/sms/history

Request Object

Field	Type	Description
service	string	The service. SMS \| USSD \| VOICE \| SIMACTIVE \| KYCVERIFY .
servicetype	string	The service type. TEXT \| FLASH \| CALL \| RECORD \| IVR \| TEXT2SPEECH \| OTP \| SIMACTIVE \| KYCVALIDATE .
datefrom	string	The begin date to filter the history range. (Date difference must not be more than 3 months).
dateto	string	The end date to filter the history range. (Date difference must not be more than 3 months).
senderid	string	The senderID used for sending message. Approved SenderIDs only
status	string	The status to filter message history by. DELETED \| UNKNOWN \| EXPIRED \| WAITING \| FAILED \| REJECTD \| UNDELIV \| ACCEPTD \| DELIVRD \| BUSY \| ANSWERED
msgid	string	Message ID.

Response Object

Field	Type	Description
status	string	The status of the request.
message	string	The message response.
data	object	Content Data.
content	array	An array of items

Responses

Field	Type	Description
status	string	Returns "ACCEPTD" when message is successfully queued
message	string	Returns "success"
data	object	Provides content data
content	array	Provides an array of data

Field	Type	Description
status	string	Returns "UNAUTHORIZED"
message	string	"Invalid API credentials"
data	null	No data returned

Field	Type	Description
status	string	Error status code (e.g., "SENDER_ID_NOT_FOUND")
message	string	Detailed error message explaining the issue
data	null	No data returned for error responses

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

Endpoint

Content type

application/json

Example

Message History

curl  -G 'https://frogtestapi.wigal.com.gh/api/v3/sms/history'
-H "API-KEY: your_api_key_here"
-H  "USERNAME: your_username_here"
-d   '{request_body_here}'

const url = 'https://frogtestapi.wigal.com.gh/api/v3/sms/history';

const headers = {
    'Content-Type': 'application/json',
    'API-KEY': 'your_api_key_here', // Replace with your API key
    'USERNAME': 'your_username_here' // Replace with your username
};

const payload = {
    "service": "SMS",
    "servicetype": "TEXT",
    "datefrom": "2024-04-01",
    "dateto": "2024-06-26",
    "senderid": "OGK1243",
    "status": "DELIVRD",
    "msgid": "MGS1010101"
};

fetch(url, {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => {
    console.log('Success:', data);
})
.catch(error => {
    console.error('Error:', error);
});

import requests
import json

url = "https://frogtestapi.wigal.com.gh/api/v3/sms/history"

headers = {
    'Content-Type': 'application/json',
    'API-KEY': 'your_api_key_here', # Replace with your API key
    'USERNAME': 'your_username_here' # Replace with your username
}

payload = {
    "service": "SMS",
    "servicetype": "TEXT",
    "datefrom": "2024-04-01",
    "dateto": "2024-06-26",
    "senderid": "OGK1423",
    "status": "DELIVRD",
    "msgid": "MGS1010101"
}

response = requests.post(url, headers=headers, data=json.dumps(payload))

if response.status_code == 200:
    print("Request was successful.")
    print("Response:", response.json())
else:
    print(f"Failed to send request. Status code: {response.status_code}")
    print("Response:", response.text)



$url = 'https://frogtestapi.wigal.com.gh/api/v3/sms/history';

$headers = [
    'Content-Type: application/json',
    'API-KEY: your_api_key_here', // Replace with your API key
    'USERNAME: your_username_here' // Replace with your username
];

$payload = [
    "service" => "SMS",
    "servicetype" => "TEXT",
    "datefrom" => "2024-04-01",
    "dateto" => "2024-06-26",
    "senderid" => "OGK1423",
    "status" => "DELIVRD",
    "msgid" => "MGS1010101"
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array_map(function($key, $value) {
    return "$key: $value";
}, array_keys($headers), $headers)));
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));

$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

{
              "service": "SMS",
              "servicetype": "Text",
              "datefrom": "2024-04-01",
              "dateto": "2024-06-18",
              "senderid": "OGK1234",
              "status": "DELIVRD",
              "msgid": "MGS1010101"
            }

Response Object

Content type

application/json

{
              "status": "SUCCESS",
              "message": "Success",
              "data": {
                "content": [
                  {
                    "apimessageid": "MGS1010101",
                    "status": "DELIVRD",
                    "statusreason": "DELIVRD",
                    "recipient": "233542709210",
                    "statusdate": "2024-06-26T13:06:14.087856",
                    "bundlecredits": 0,
                    "charge": 0.03,
                    "service": "SMS",
                    "servicetype": "TEXT",
                    "messagecount": 1,
                    "charactercount": 53
                  },
                  {
                    "apimessageid": "MGS1010101",
                    "status": "DELIVRD",
                    "statusreason": "DELIVRD",
                    "recipient": "233542409410",
                    "statusdate": "2024-06-26T13:12:55.771246",
                    "bundlecredits": 0,
                    "charge": 0.03,
                    "service": "SMS",
                    "servicetype": "TEXT",
                    "messagecount": 1,
                    "charactercount": 55
                  },
                  {
                    "apimessageid": "MGS1010101",
                    "status": "DELIVRD",
                    "statusreason": "DELIVRD",
                    "recipient": "233542909410",
                    "statusdate": "2024-06-26T13:14:23.801293",
                    "bundlecredits": 0,
                    "charge": 0.03,
                    "service": "SMS",
                    "servicetype": "TEXT",
                    "messagecount": 1,
                    "charactercount": 46
                  }
                ],
                "pageable": {
                  "pageNumber": 0,
                  "pageSize": 50,
                  "sort": {
                    "sorted": false,
                    "empty": true,
                    "unsorted": true
                  },
                  "offset": 0,
                  "unpaged": false,
                  "paged": true
                },
                "last": true,
                "totalElements": 3,
                "totalPages": 1,
                "size": 50,
                "number": 0,
                "sort": {
                  "sorted": false,
                  "empty": true,
                  "unsorted": true
                },
                "first": true,
                "numberOfElements": 3,
                "empty": false
              }
            }