Webhook Receipt Field Details

This document describes the fields pushed in SMS receipt Webhook notifications.

Push Field Reference

Field	Type	Description
MsgType	int	Message type, fixed value: 2
Data	array	List of receipt data items

Data Item Fields

Field	Type	Description
SessionNo	string	Unique batch ID
Phone	string	Recipient phone number
CostCount	int	Number of SMS segments consumed
ReceiptTime	int	Receipt timestamp (Unix seconds)
ReceiptResult	string	Receipt result, Success indicates successful delivery
ReceiptCode	string	Receipt status code, 0 indicates success
ReceiptDesc	string	Receipt description

Push JSON Example

{
  "MsgType": 2,
  "Data": [
    {
      "SessionNo": "cbfaf1a2-9d12-4f8a-81c7-56f67ba708ea",
      "Phone": "123456",
      "CostCount": 1,
      "ReceiptTime": 1781580389,
      "ReceiptResult": "Success",
      "ReceiptCode": "0",
      "ReceiptDesc": "Message sent successfully"
    }
  ]
}

Push Mechanism

Configuration

• Method: HTTP POST
• Content-Type: application/json
• Retry: Up to 3 retries per callback URL
• Batch Push: Supports pushing multiple messages in one request
• Timeout: default 30 seconds

Response Format

The client must return the following JSON response:

{
  "code": 0,
  "message": "success"
}

• code = 0 indicates success
• code != 0 indicates failure and will trigger a retry