搜索消息 - 齐成云·IM消息服务

在指定会话中搜索包含关键字的消息

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer QC2b8fd0ca342c72f857f5f96

Appid

string

可选

默认值:

1001

ClientId

string

可选

默认值:

131231231223

TimeStamp

string

可选

默认值:

Client-Type

string

可选

默认值:

EnterpriseCenterWEB

Body 参数application/json

chatsKey

string

会话唯一标识

必需

>= 1 字符<= 200 字符

示例值:

friend_user1_user2

keyword

string

搜索关键字

必需

>= 1 字符<= 100 字符

示例值:

hello

messageType

string

可选

消息类型筛选（可选）

<= 50 字符

示例值:

text

示例

{
    "chatsKey": "friend_user1_user2",
    "keyword": "hello",
    "messageType": "text"
}

返回响应

🟢200成功

application/json

搜索成功

Body

success

boolean

操作是否成功

必需

message

string

响应消息

必需

code

integer

状态码

可选

data

array[object (MessageInfo) {16}]

可选

chats_message_id

integer

消息ID

可选

message_key

string

消息唯一标识

可选

chats_key

string

会话唯一标识

可选

send_user_id

string

发送者用户ID

可选

receive_user_id

string

接收者用户ID

可选

message_type

string

消息类型

可选

message_content

消息内容

可选

message_extra

消息扩展信息

可选

reply_to_message_key

string

回复的消息Key

可选

forward_from_message_key

string

转发的消息Key

可选

is_retracted

integer

可选

是否已撤回（0-否，1-是）

is_read

integer

可选

是否已读（0-否，1-是）

read_time

string <date-time>

阅读时间

可选

delivery_status

enum<string>

投递状态

可选

枚举值:

sendingsentdeliveredfailed

create_time

string <date-time>

创建时间

可选

update_time

string <date-time>

更新时间

可选

示例

{
    "success": true,
    "message": "string",
    "code": 0,
    "data": [
        {
            "chats_message_id": 0,
            "message_key": "string",
            "chats_key": "string",
            "send_user_id": "string",
            "receive_user_id": "string",
            "message_type": "string",
            "message_content": null,
            "message_extra": null,
            "reply_to_message_key": "string",
            "forward_from_message_key": "string",
            "is_retracted": 0,
            "is_read": 0,
            "read_time": "2019-08-24T14:15:22Z",
            "delivery_status": "sending",
            "create_time": "2019-08-24T14:15:22Z",
            "update_time": "2019-08-24T14:15:22Z"
        }
    ]
}

🟠400请求有误

🟠401没有权限

🔴500服务器错误