You can call this method to import historical one-to-one messages in chronological order from another instant messaging service to ZEGO Instant Messaging (ZIM).
A one-to-one chat is between two users (user A and user B). If user A deletes some messages, the message list of user A will differ from that of user B. Therefore, you need to call this method for user A and user B separately.
The following table describes only the method-specific request parameters and some common request parameters. For the complete list of common request parameters, see Accessing Server APIs.
Parameter | Type | Required | Description |
---|---|---|---|
FromUserId |
String |
Yes |
The ID of the message sender (registered). |
ToUserId |
String |
Yes |
The ID of the message recipient (registered). |
MessageType |
Number |
Yes |
Message type. For more information about message types applicable to a one-to-one chat, see MessageBody Introduction. Signaling messages are not supported. |
Priority |
Number |
Yes |
Message priority. Valid values:
|
MessageBody |
Object |
Yes |
Message content. For more information about the format, see MessageBody Introduction-Applicable types of one-to-one chats. Offline push is not supported. |
SubMsgType |
Number |
No (Yes if MessageType is 200 ) |
Custom message type. Value range: [0,200]. |
SearchedContent |
String |
No |
The searched content of the custom message. This field is required only if MessageType is 200 and can contain up to 64 bytes in length. This field is required to search for associated custom messages on the client. |
SendMessageTime |
Number |
No |
The Unix timestamp when the message was sent. Unit: ms. Import messages based on their sending timestamps in chronological order.
- If a value other than `0` is specified, it cannot be earlier than "the current time - message retention days specified in the package × 86400000 (for more information, see [计费说明 - 版本说明|_blank](/404))" or later than the current time.
|
ImportedUserId |
String |
Yes |
It must be either the FromUserId or the ToUserId , indicating the user whose message list is to be imported. |
The FromUserId
and ToUserId
parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', '{', '}', '|', '~'.
FromUserId
and ToUserId
parameters can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', '{', '}', '|', '~'.MessageType
is 1
, the version of the receiving ZIM SDK needs to be 2.7.0 or later.MessageType
is 200
, the version of the sending and receiving ZIM SDKs needs to be 2.8.0 or later.Request URL:
https://zim-api.zego.im/?Action=ImportPeerMsg
&<Common request parameters>
Request body:
{
"FromUserId": "u1",
"ToUserId": "u2",
"MessageType": 200,
"Priority": 1,
"MessageBody": {
"Message": "hello world",
"ExtendedData": "s"
},
"SubMsgType": 110,
"SearchedContent": "ex",
"SendMessageTime": 123,
"ImportedUserId": "u1"
}
Parameter | Type | Description |
---|---|---|
Code |
Number |
The return code. |
Message |
String |
The description of the request result. |
RequestId |
String |
The request ID. |
MsgId |
String |
The message ID. |
MsgSeq |
Number |
The message sequence. |
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782",
"MsgId": "6654861479614",
"MsgSeq": 1
}
After messages are imported successfully, call the ZIM server API Query the message list of one-on-one chats
to check whether all one-to-one messages are imported.
The following table describes only the return codes related to the business logic of the method. For the complete list of return codes, see Return codes.
Return code | Description | Solution |
---|---|---|
660400001 |
The message size exceeds the limit. |
Check the message size. |