Operator_Account
and Peer_Account
in the request and the query is performed from the perspective of the party specified by Operator_Account
. The query result contains the messages sent between both parties. The specific sender and recipient of each message are specified by From_Account
and To_Account
respectively.ClearRamble
being set to 1
.SyncOtherMachine
is set to 2
, indicating that specified messages are not synced to the message history of the other party of the conversation.MsgFlagBits
field.IsPeerRead
field in the query result indicates whether the recipient sends the read receipt of the message. The field value is 1
only when the recipient calls the sendMessageReadReceipts (Android / iOS and Mac / Windows) or sendMessageReadReceipt (Web&) API.MsgKey
of the message and then call the RESTful API for recalling one-to-one messages to recall the message.Complete
field in the response.https://xxxxxx/v4/openim/admin_getroammsg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/openim/admin_getroammsg | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json . |
user1
and user2
had a conversation, and you want to query the conversation history from 2020-03-20 10:00:00 to 2020-03-20 11:00:00 from the perspective of user2.{"Operator_Account":"user2","Peer_Account":"user1","MaxCnt":100,"MinTime":1584669600,"MaxTime":1584673200}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Complete": 0,"MsgCnt": 12, //12 messages were returned for the pull."LastMsgTime": 1584669680,"LastMsgKey": "549396494_2578554_1584669680","MsgList": [{"From_Account": "user1","To_Account": "user2","MsgSeq": 549396494,"MsgRandom": 2578554,"MsgTimeStamp": 1584669680,"MsgFlagBits": 0,"IsPeerRead": 0,"MsgKey": "549396494_2578554_1584669680","MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "msg 1"}}],"CloudCustomData": "your cloud custom data"},{"From_Account": "user2","To_Account": "user1","MsgSeq": 1054803289,"MsgRandom": 7201,"MsgTimeStamp": 1584669689,"MsgFlagBits": 0,"IsPeerRead": 0,"MsgKey": "1054803289_7201_1584669689","MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "msg 2"}}],"CloudCustomData": "your cloud custom data"},{ ... } // The remaining ten messages are not listed for simplicity.]}
"Complete": 0
indicates that not all messages generated within the time range have been pulled. Therefore, continued pulling is required.
In the continued pulling request, the value of MaxTime
must be changed to the value of LastMsgTime
in the response, and the LastMsgKey
in the response must be entered, as shown below:{"Operator_Account":"user2","Peer_Account":"user1","MaxCnt":100,"MinTime":1584669600,"MaxTime":1584669680,"LastMsgKey": "549396494_2578554_1584669680"}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Complete": 1,"MsgCnt": 5, // Five messages were returned for the pull."LastMsgTime": 1584669601,"LastMsgKey": "1456_23287_1584669601","MsgList": [{"From_Account": "user1","To_Account": "user2","MsgSeq": 1456,"MsgRandom": 23287,"MsgTimeStamp": 1584669601,"MsgFlagBits": 0,"IsPeerRead": 1,"MsgKey": "1456_23287_1584669601","MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "msg 13"}}],"CloudCustomData": "your cloud custom data"},{"From_Account": "user2","To_Account": "user1","MsgSeq": 9806,"MsgRandom": 14,"MsgTimeStamp": 1584669602,"MsgFlagBits": 0,"IsPeerRead": 1,"MsgKey": "9806_14_1584669602","MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "msg 14"}}],"CloudCustomData": "your cloud custom data"},{ ... } // The remaining three messages are not listed for simplicity.]}
"Complete": 1
indicates that all messages generated within the time range have been pulled.
If the value of Complete
in the response is 0
, you need to continue pulling messages until the value of Complete
becomes 1
.Field | Type | Required | Description |
Operator_Account | String | Yes | UserID of one party of the conversation for which messages are queried. The result may be different if you query messages for the other party of the same conversation. For more information, see the API description section. |
Peer_Account | String | Yes | UserID of the other party in the conversation |
MaxCnt | Integer | Yes | Number of messages to query |
MinTime | Integer | Yes | Minimum value of the time range for message query, in seconds |
MaxTime | Integer | Yes | Maximum value of the time range for message query, in seconds |
LastMsgKey | String | No | MsgKey of the last message that was pulled previously. This field is required for continued pulling. For more information, see the preceding sample. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Complete": 1,"MsgCnt": 1,"LastMsgTime": 1584669680,"LastMsgKey": "549396494_2578554_1584669680","MsgList": [{"From_Account": "user1","To_Account": "user2","MsgSeq": 549396494,"MsgRandom": 2578554,"MsgTimeStamp": 1584669680,"MsgFlagBits": 0,"IsPeerRead": 0,"MsgKey": "549396494_2578554_1584669680","MsgBody": [{"MsgType": "TIMTextElem","MsgContent": {"Text": "1"}}],"CloudCustomData": "your cloud custom data"}]}
{"ActionStatus": "FAIL","ErrorInfo": "Fail to Parse json data of body, Please check it","ErrorCode": 90001}
Field | Type | Description |
ActionStatus | String | Request result. OK : Successful; FAIL : Failed |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Error information |
Complete | Integer | Whether all messages have been pulled. 0 : no, continued pulling is required; 1 : yes |
MsgCnt | Integer | Number of messages that were pulled this time |
LastMsgTime | Integer | Time when the last message was pulled this time |
LastMsgKey | String | Identifier of the last message pulled this time |
MsgList | Array | List of returned messages |
MsgFlagBits | Integer | Message attribute. 0 : normal message; 8 : recalled message |
IsPeerRead | Integer | Whether the recipient has sent the read receipt of this message. Valid values: 0 for no and 1 for yes. For details, see the feature description of this API. |
MsgBody | Array | Message body. For details on formats, see Message Formats. (Note: A message can contain multiple message elements, in which case MsgBody is an array.) |
CloudCustomData | String | Custom message data. It is saved in the cloud and will be sent to the peer end. Such data can be pulled after the app is uninstalled and reinstalled. |
MsgKey | String | Message identifier. You can use this field when calling the RESTful API for recalling one-to-one messages. |
ErrorCode
and ErrorInfo
respectively.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:Error Code | Description |
90001 | Failed to parse the JSON request. Make sure the format is valid. |
90003 | The To_Account field is missing in the JSON request or it is not a string. |
90008 | The From_Account field is missing in the JSON request or the account it specifies does not exist. |
90009 | The request requires app admin permissions. |
91000 | Internal service error. Try again. |
Was this page helpful?