This API is used by the app backend to view one-to-one message reads in real time.
SDKAppID
contained in the request URL is the SDKAppID
of the app.After a one-to-one message is marked as read
In the following sample, the callback URL configured in the app is https://www.example.com
.
Sample:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Parameter | Description |
---|---|
https | The request protocol is HTTPS and the request method is POST. |
www.example.com | Callback URL |
SdkAppid | SDKAppID assigned by the IM console when the app is created |
CallbackCommand | Always C2C.CallbackAfterMsgReport |
contenttype | Always json |
ClientIP | Client IP, such as 127.0.0.1 |
OptPlatform | Client platform. For valid values, see the description of OptPlatform in the Callback Protocols section of Third-Party Callback Overview. |
{
"CallbackCommand": "C2C.CallbackAfterMsgReport", // Callback command
"Report_Account": "jared", // Read reporter
"Peer_Account": "Jonh", // The other party in the conversation
"LastReadTime": 1614754606, // Read time
"UnreadMsgNum": 7 // Total number of unread one-to-one messages of `Report_Account`
}
Field | Type | Description |
---|---|---|
CallbackCommand | String | Callback command |
Report_Account | String | UserID of the read reporter |
Peer_Account | String | UserID of the other party in the conversation |
LastReadTime | Integer | Read time |
UnreadMsgNum | Integer | Total number of unread one-to-one messages of Report_Account (including all one-to-one conversations) |
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // `0`: callback succeeds; `1`: an error occurs during callback.
}
Field | Type | Required | Description |
---|---|---|---|
ActionStatus | String | Yes | Request result. OK : successful; FAIL : failed |
ErrorCode | Integer | Yes | Error code. 0 : callback succeeds; 1 : an error occurs during callback. |
ErrorInfo | String | Yes | Error information |
Was this page helpful?