Transactional SMS Batch Reports

Overview

This endpoint will return reporting data for the category name that was used when sending the batch.

The Method

API	-	Method
REST	GET	https://[Your URL]/api/2.0/production/sms/report/category/{category name}

Your URL is the address of your install.

Parameters

Required Parameters

Property	Type	Description	Default	Required	Read Only
category_name	string	The category name that was used when sending the batch.	empty	Yes	N/A

Optional Parameters

You may include any of these optional parameters:

Property	Type	Description	Default	Required	Read Only
page	integer	Indicates which page of results you would like to fetch.	1	No	N/A
count	integer	Indicates how many results you would like to fetch.	1000	No	N/A

Code Samples

Example Request

GET /api/2.0/ production/sms/ report/category/{category name}
HTTP/1.1 Host: https://[Your URL] Authorization: Basic YWRtaW5pc3RyYXRvcjp2bE1lTGk2UlVJR21SQzNvaWRMZXBsc2J5RU5NRkY3Yl85OTk= Content-Type: application/json

Example Response

{
    [ 
        {
           "mobile_number": "+27721234568",
           "sent_date": "2019-06-23 15:11:01", 
           "delivered_date": "2019-06-23 17:11:06", 
           "status": "delivered",
           "transaction_message": "Hello Bob", 
           "reply_content": null, 
           "reply_received_date": null,
           “custom_id”: “custom_id_2”           
       } 
   ] 
}