Reporting

Each message sent to a user gets a reportid. When the message is delivered and when it is read, notifications are sent to the service using this reportid. The service must be authorized to receive reports; contact the bipussu super admin for permission. Reports differ by synchronous/asynchronous sends:

Synchronous reporting: The response to the request contains the report.
Asynchronous reporting: The report is sent to the service callback URL + /report.

Synchronous reporting

The report is in the response. Supported when sending to all followers in sendmsgserv (receiver: 1).

Request/Response

{  
    "txnid": "Broadcast-1Content",  
    "resultcode": 0,  
    "list": [{  
        "resultcode": 0,  
        "receiver": "9053XXXXXXXX",  
        "reportid": "6a7Q8-1502",  
        "numberofmessage": 1,  
        "totalnumberofmessage": 1  
    }]  
}

Fields

Field	Value	Description
*txnid	string	Request id value
*resultcode	string	Send result
*list	object	User list
*resultcode	long	Result for this message
*receiver	string	Recipient result. 0: Success, others: Failure
*reportid	string	If `resultcode` is 0, the id of the message sent to the user. Delivered/read info will be sent later using this id
*numberofmessage	int	Message index
*totalnumberofmessage	int	Order among messages sent to the user. If multiple messages are sent, this indicates the sequence.

Asynchronous reporting

The report is not in the immediate response. After sending, a response is posted to the service callback URL + /report.

Callback Payload

{  
    "reqid": 12,
    "txnid": "Broadcast-1Content",
    "resultcode": 0,
    "list": [
        {  
            "receiver": "9053XXXXXXXX",
            "resultcode": 0,
            "reportid": "6a7Q8-1502",
            "numberofmessage": 1,
            "totalnumberofmessage": 1 
        }, {  
            "receiver": "9053XXXXXXXX",
            "resultcode": 312,
            "reportid": null, 
            "numberofmessage": null,
            "totalnumberofmessage": 1
        }  
    ]  
}

Fields

Field	Value	Description
*reqid	string	Id of the report delivery
*txnid	string	Request id value
*resultcode	string	Send result
*list	object	User list
*resultcode	long	Result for this message
*receiver	string	Recipient result. 0: Success, others: Failure
*reportid	string	If `resultcode` is 0, the id of the message sent to the user. Delivered/read info will be sent later using this id
*numberofmessage	int	Message index
*totalnumberofmessage	int	Order among messages sent to the user.

Tracking reportid

When the user receives the message, delivered and read notifications are sent to your callback URL with the same reportid. Match the reportid returned when sending with the reportid coming to the callback URL to track delivered/read status. See User Actions for details.