Message Status Report Push

Home > API Center > API interface guide

Get Started

1. Document Guidance
2. Global Status Code
Quick Start
1. IVR Group Call Task - Task-based Approach
2. IVR Group Call Task - TTS-based Approach
Voice API
1. TTS Bulk Call
1. Bulk IVR Call Using Voice File
Quick Start
Agent Groups API
1. Generate SDK Credentials
1. Initiate Call
Management Side API
1. Active Push
2. Batch Query
1. Document Guidance
2. Global Status Code
Quick Start
1. Quick Start - AI Agent Group Call
AI Agent API
1. Status Report Push
2. Get The Call Recording File Address

POST

The callback address provided by the client, through which the message status is pushed back to the client

Push Parameters

Parameters	Description	Type
appId	Application id	String
channelType	Channel type: 0-WhatsApp, send 0 by default	Integer
messageId	Message id	String
eventType	Event type: message-status-event (downlink message event)	String
billable	Whether billing: true- billing, false- no billing	String
form	Message sender number	String
recipient	Message recipient number	String
recipientUserId	recipient BSUID	String
recipientParentUserId	recipient parent BSUID	String
recipientUsername	recipient user name	String
status	Message status:failed (failed to send), sent (sent), delivered (successfully sent), read (read), deleted (deleted)	String
failure	Failure reason (failed	String
conversationId	Conversation id (message status is:Sent, delivered only return	String
expiresAt	Conversation expiration timestamp (second level, message status issent	Long
conversationType	Dialog type: authentication (authentication), marketing (marketing), utility (transaction-related), service (service), referral_conversion (free access point)	String
timestamp	Push status timestamp (second level)	Long

Push Example

{
    "appId": "aiwanff",
    "channelType": 0,
    "conversationId": "9bfc551ba79a4e63b712b9a24e9b7149",
    "conversationType": "marketing",
    "eventType": "message-status-event",
    "expiresAt": 1693621620,
    "form": "8613487000260",
    "messageId": "5eb2462b086848fcbe9cac921d838141",
    "recipient": "8610000584927",
    "recipientUserId": "US.1052200954250283",
    "recipientParentUserId": "US.ENT.11815799212886844830",
    "recipientUsername": "king112",
    "status": "delivered",
    "timestamp": 1693535298
}