即时通信
  1. 消息管理
即时通信
  • API在线调试指南
  • IM账号管理
    • 注册云信IM账号
      POST
    • 更新账号属性
      PATCH
    • 刷新 Token
      PATCH
    • 封禁账号
      PATCH
    • 更新移动端推送配置
      PATCH
    • 查询账号属性
      GET
    • 批量查询账号信息
      GET
    • 强制账号退出登录
      POST
  • 用户名片管理
    • 更新用户名片
    • 查询用户名片
    • 批量查询用户名片
    • 批量获取账号在线状态
  • 好友管理
    • 添加好友
    • 删除好友
    • 更新好友信息
    • 查询好友信息
    • 分页查询好友列表
    • 同意/拒绝添加好友
  • 静音管理
    • 分页查询静音列表
    • 解除静音
    • 设置静音
  • 黑名单管理
    • 列入黑名单
    • 移出黑名单
    • 分页查询黑名单列表
  • 消息管理
    • 发送消息
      POST
    • 批量发送单聊消息
      POST
    • 撤回/删除消息
      DELETE
    • 删除会话中漫游/历史消息
      DELETE
    • 发送单聊已读回执
      POST
    • 发送高级群已读回执
      POST
    • 查询群消息已读未读详情
      GET
    • 查询单条消息
      GET
    • 分页查询历史消息
      GET
    • 发送聊天室消息
      POST
    • 批量发送聊天室消息
      POST
    • 撤回/删除聊天室历史消息
      DELETE
    • 分页查询聊天室历史消息
      GET
    • 更新消息
      POST
    • 根据消息 ID 查询历史消息
      POST
    • 查询 Thread 消息
      GET
    • 添加快捷评论
      PATCH
    • 删除快捷评论
      DELETE
    • 查询快捷评论
      POST
    • 检索历史消息
      GET
    • 发送流式消息
      POST
  • 会话功能
    • 会话管理
      • 创建会话
      • 更新会话
      • 删除会话
      • 批量删除会话
      • 查询会话信息
      • 批量查询会话信息
      • 分页查询账号的所有会话列表
    • 会话未读数管理
      • 获取会话总未读数
    • 会话分组
      • 创建会话分组
      • 更新会话分组
      • 删除会话分组
      • 查询会话分组信息
      • 批量查询会话分组信息
      • 查询所有会话分组信息
  • 群组功能
    • 群成员
      • 拉人入群
      • 踢人出群
      • 主动退群
      • 更新群成员信息
      • 批量禁言群成员
      • 分页查询指定账号已加入的群组信息
    • 群组管理
      • 创建群组
      • 更新群组信息
      • 转让群主
      • 添加管理员
      • 移除管理员
      • 解散群组
      • 查询群组信息
      • 批量查询群组信息列表
      • 查询高级群在线成员列表
      • 批量查询高级群的在线成员数
      • 分页查询群成员列表
  • 聊天室功能
    • 聊天室管理
      • 创建聊天室
      • 获取聊天室地址
      • 查询聊天室信息
      • 更新聊天室信息
      • 开放/关闭聊天室
      • 聊天室禁言
      • 开启/关闭进出聊天室事件通知
      • 查询开放状态的聊天室
      • 分页查询聊天室在线成员列表
      • 查询聊天室固定成员列表
    • 聊天室成员
      • 设置聊天室成员角色
      • 更新聊天室在线成员信息
      • 禁言聊天室成员
      • 临时禁言聊天室成员
      • 查询聊天室的禁言列表
      • 拉黑聊天室成员
      • 聊天室标签禁言
      • 查询聊天室黑名单列表
      • 聊天室标签禁言
      • 修改聊天室在线成员标签
      • 查询标签下的在线成员数
      • 分页查询标签下的在线成员列表
      • 批量查询聊天室固定成员信息
      • 添加聊天室虚构用户
      • 删除聊天室虚构用户
      • 清空聊天室虚构用户
      • 查询聊天室虚构用户
    • 聊天室队列
      • 初始化聊天室队列
      • 删除聊天室队列
      • 更新聊天室队列
      • 查询聊天室队列元素
      • 从聊天室队列中取出元素
  • 广播消息管理
    • 发送广播消息
    • 删除广播消息
    • 查询广播消息
    • 分页查询广播消息
    • 发送聊天室全服广播消息
  • 系统通知管理
    • 发送自定义系统通知
    • 批量发送自定义系统通知
  • 发布订阅
    • 订阅在线状态事件
    • 查询在线状态事件订阅关系
    • 取消在线状态事件订阅
  • 翻译
    • 文本翻译
  1. 消息管理

发送流式消息

开发中
POST
/im/v2/conversations/{conversation_id}/messages/actions/stream_message

请求参数

Path 参数
conversation_id
string 
必需
Header 参数
AppKey
string 
必需
默认值:
{{AppKey}}
X-custom-traceid
string 
可选
默认值:
{% mock 'uuid' %}
Nonce
string 
必需
默认值:
{{Nonce}}
CurTime
string 
必需
默认值:
{{CurTime}}
CheckSum
string 
必需
默认值:
{{CheckSum}}
Body 参数application/json
extension
string 
必需
message
object 
必需
sub_type
integer 
必需
text
string 
必需
attachment
object 
必需
message_client_id
string 
必需
message_server_id
number  | null 
必需
message_config
object 
必需
unread_enabled
string 
必需
mutil_sync_enabled
string 
必需
conversation_update_enabled
string 
必需
route_config
object 
必需
route_enabled
boolean 
必需
route_environment
string 
必需
push_config
object 
必需
push_enabled
string 
必需
push_nick_enabled
string 
必需
push_content
string 
必需
push_payload
string 
必需
push_forcepush_all
string 
必需
push_forcepush_ids
array[string]
必需
push_forcepush_content
string 
必需
p2p_option
object 
必需
check_friend
boolean 
必需
示例
{
    "type": "object",
    "properties": {
        "thread_config": {
            "properties": {
                "thread_root": {
                    "type": "object",
                    "properties": {
                        "sender_id": {
                            "type": "string",
                            "description": "根消息的发送者。"
                        },
                        "receiver_id": {
                            "type": "string",
                            "description": "根消息的接收者。"
                        },
                        "create_time": {
                            "type": "number",
                            "description": "根消息的发送时间。"
                        },
                        "message_server_id": {
                            "type": "number",
                            "description": "根消息的服务器消息 ID。"
                        },
                        "message_client_id": {
                            "type": "string",
                            "description": "根消息的客户端消息 ID。"
                        }
                    },
                    "x-apifox-orders": [
                        "sender_id",
                        "receiver_id",
                        "create_time",
                        "message_server_id",
                        "message_client_id"
                    ],
                    "description": "Thread 根消息对象。"
                },
                "thread_reply": {
                    "type": "object",
                    "properties": {
                        "sender_id": {
                            "type": "string",
                            "description": "被回复消息的发送者。"
                        },
                        "receiver_id": {
                            "type": "string",
                            "description": "被回复消息的接收者。"
                        },
                        "create_time": {
                            "type": "number",
                            "description": "被回复消息的发送时间。"
                        },
                        "message_server_id": {
                            "type": "number",
                            "description": "被回复消息的服务器消息 ID。"
                        },
                        "message_client_id": {
                            "type": "string",
                            "description": "被回复消息的客户端消息 ID。"
                        }
                    },
                    "x-apifox-orders": [
                        "sender_id",
                        "receiver_id",
                        "create_time",
                        "message_server_id",
                        "message_client_id"
                    ],
                    "description": "被回复的消息对象。"
                }
            },
            "x-apifox-orders": [
                "thread_root",
                "thread_reply"
            ],
            "description": "Thread 消息配置项。",
            "$ref": "#/definitions/139509451"
        },
        "sender_no_sense": {
            "type": "boolean",
            "title": "发送方无感知",
            "description": "发送方是否无感知,默认为 false。若设置为无感知(true),则消息发送者无该消息的多端、漫游、历史记录等信息。 查询历史消息时可设置是否在历史记录查询结果中包含无感知消息,具体参见分页查询历史消息。 发送者和接收者必须有一方感知,即不能将两者都设置为无感知。",
            "default": "false"
        },
        "receiver_no_sense": {
            "type": "boolean",
            "title": "接收方无感知",
            "description": "接收方是否无感知,默认为 false。若设置为无感知(true),则消息接收者无该消息的多端、漫游、历史记录等信息。 查询历史消息时可设置是否在历史记录查询结果中包含无感知消息,具体参见分页查询历史消息。",
            "default": "false"
        },
        "extension": {
            "type": "string",
            "description": "开发者扩展字段,JSON 格式,长度上限为 1024 位字符。例如:\"{\"k\":\"v\"}\"",
            "title": "开发者扩展字段"
        },
        "message": {
            "type": "object",
            "properties": {
                "message_client_id": {
                    "type": "string",
                    "title": "客户端消息id(不传则自动生成)",
                    "description": "客户端消息id(不传则自动生成)"
                }
            },
            "x-apifox-orders": [
                "01HNSRBA5HQWQYKJ8C5C2WHBBZ",
                "message_client_id"
            ],
            "title": "消息体",
            "x-apifox-refs": {
                "01HNSRBA5HQWQYKJ8C5C2WHBBZ": {
                    "$ref": "#/definitions/81970145",
                    "x-apifox-overrides": {
                        "attachment": {
                            "type": "object",
                            "properties": {},
                            "x-apifox-orders": [],
                            "description": "非文本消息/提示消息的属性或自定义消息内容,长度上限 5000 位字符。 对于非文本消息/提示消息,该字段必填,每种消息的属性参数见:消息格式示例。",
                            "title": "多媒体消息内容"
                        },
                        "text": {
                            "type": "string",
                            "description": "对于文本消息和提示消息,该字段必填,值为消息内容,长度上限 5000 位字符。 对于非文本/提示消息,该字段非必填,值为描述信息,可用于全文关键字搜索历史消息,长度上限 500 位字符。",
                            "maxLength": 500,
                            "title": "文本消息"
                        },
                        "sub_type": {
                            "type": "integer",
                            "description": "自定义消息子类型,大于 0。message_type = 100 时该字段才有效。",
                            "minimum": 0,
                            "exclusiveMinimum": 0,
                            "title": "自定义消息子类型"
                        },
                        "message_type": {
                            "type": "integer",
                            "description": "消息类型。 0:文本消息 1:图片消息 2:语音消息 3:视频消息 4:地理位置消息 6:文件消息 10:提示消息 100:自定义消息 对于未开通安全通(即易盾反垃圾)功能的应用,自定义消息不会过内容审核。",
                            "title": "消息类型"
                        }
                    },
                    "required": [
                        "message_type"
                    ]
                }
            },
            "description": "消息体。"
        },
        "message_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1GJ1KRDV2WKZJYMV4150C"
            ],
            "title": "消息配置",
            "description": "消息配置项。",
            "x-apifox-refs": {
                "01HNS1GJ1KRDV2WKZJYMV4150C": {
                    "$ref": "#/definitions/81871495"
                }
            }
        },
        "route_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1HHNQC0KHGVJK70HXW0SH"
            ],
            "description": "抄送相关配置项。",
            "title": "抄送配置",
            "x-apifox-refs": {
                "01HNS1HHNQC0KHGVJK70HXW0SH": {
                    "$ref": "#/definitions/81873802"
                }
            }
        },
        "push_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1JHHJQ5DM8VJE69DRJWS9"
            ],
            "description": "推送相关配置项。",
            "title": "推送配置",
            "x-apifox-refs": {
                "01HNS1JHHJQ5DM8VJE69DRJWS9": {
                    "$ref": "#/definitions/81874011"
                }
            }
        },
        "antispam_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNRYHRCV38S3B9R2V8A92FCA"
            ],
            "description": "安全通相关配置项。",
            "title": "安全通配置",
            "x-apifox-refs": {
                "01HNRYHRCV38S3B9R2V8A92FCA": {
                    "$ref": "#/definitions/81855284"
                }
            }
        },
        "p2p_option": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1K8WX52R9S593BZ3RTRF7"
            ],
            "description": "单聊消息功能配置项。",
            "title": "单聊消息配置",
            "x-apifox-refs": {
                "01HNS1K8WX52R9S593BZ3RTRF7": {
                    "$ref": "#/definitions/81874107"
                }
            }
        },
        "team_option": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1KWD9WH314966NXZ9BYJF"
            ],
            "description": "高级群消息功能配置项。",
            "x-apifox-refs": {
                "01HNS1KWD9WH314966NXZ9BYJF": {
                    "$ref": "#/definitions/81874148"
                }
            },
            "title": "高级群消息配置"
        },
        "superteam_option": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1MAVJXR5Q9MV93GMA4DZC"
            ],
            "description": "超大群消息功能配置项。",
            "x-apifox-refs": {
                "01HNS1MAVJXR5Q9MV93GMA4DZC": {
                    "$ref": "#/definitions/81874164"
                }
            },
            "title": "超大群消息配置"
        },
        "robot_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNRYXG18FJK06M1K1VBKBDAQ"
            ],
            "description": "机器人功能配置项。",
            "x-apifox-refs": {
                "01HNRYXG18FJK06M1K1VBKBDAQ": {
                    "$ref": "#/definitions/81857819"
                }
            },
            "title": "机器人功能配置"
        },
        "target_option": {
            "type": "object",
            "properties": {
                "receiver_account_ids": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "description": "账号 ID"
                    },
                    "title": "群定向消息成员列表,即指定接收群消息的群成员列表。",
                    "description": "当 inclusive 为 true,当前列表为可见(接收)列表。\n当 inclusive 为 false,当前列表为不可见(不接收)列表。\n列表中不能包含消息发送者,消息发送者默认为可见。\n列表中不能包含非法账号、非群成员账号。\n列表中最多可以传入 100 个用户账号。"
                },
                "inclusive": {
                    "type": "boolean",
                    "title": "是否为可见列表",
                    "description": "群定向消息成员列表是否为可见列表。默认为 true,即 receiver_account_ids 为可见(接收)列表。\n发送超大群消息时,不能将 inclusive 设置为 false。",
                    "default": true
                },
                "visible_to_new_member": {
                    "type": "boolean",
                    "default": false,
                    "description": "新进群成员是否可见该消息。默认为 false,即新进群成员不可以查看该定向消息。若设置为 true,则新进群成员若可以查询该定向消息,可以通过云端历史相关接口查询到该消息。\n当 inclusive 为 true 时,不能同时设置 visible_to_new_member 为 true。即发送定向列表为可见的定向消息时,只能由定向列表中成员接收和查看。\n发送超大群消息时,不能将 visible_to_new_member 设置为 true。",
                    "title": "新进群成员是否可见该消息"
                }
            },
            "x-apifox-orders": [
                "receiver_account_ids",
                "inclusive",
                "visible_to_new_member"
            ],
            "title": "群定向消息配置项。",
            "description": "该功能需要单独开通。"
        },
        "check_team_member_valid": {
            "type": "boolean",
            "description": "发送群定向消息时,是否需要验证定向成员的群成员身份。默认为 true,即需要验证群成员身份。",
            "title": "是否校验定向成员合法性"
        }
    },
    "x-apifox-orders": [
        "sender_no_sense",
        "receiver_no_sense",
        "extension",
        "message",
        "message_config",
        "route_config",
        "push_config",
        "antispam_config",
        "p2p_option",
        "team_option",
        "superteam_option",
        "robot_config",
        "01JFSCQ2KZSC3XXJ3PE5DD5S86",
        "target_option",
        "check_team_member_valid",
        "thread_config"
    ],
    "x-apifox-refs": {
        "01JFSCQ2KZSC3XXJ3PE5DD5S86": {
            "$ref": "#/definitions/138813602"
        }
    },
    "required": [
        "message",
        "check_team_member_valid"
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.yunxinapi.com/im/v2/conversations//messages/actions/stream_message' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "object",
    "properties": {
        "thread_config": {
            "properties": {
                "thread_root": {
                    "type": "object",
                    "properties": {
                        "sender_id": {
                            "type": "string",
                            "description": "根消息的发送者。"
                        },
                        "receiver_id": {
                            "type": "string",
                            "description": "根消息的接收者。"
                        },
                        "create_time": {
                            "type": "number",
                            "description": "根消息的发送时间。"
                        },
                        "message_server_id": {
                            "type": "number",
                            "description": "根消息的服务器消息 ID。"
                        },
                        "message_client_id": {
                            "type": "string",
                            "description": "根消息的客户端消息 ID。"
                        }
                    },
                    "x-apifox-orders": [
                        "sender_id",
                        "receiver_id",
                        "create_time",
                        "message_server_id",
                        "message_client_id"
                    ],
                    "description": "Thread 根消息对象。"
                },
                "thread_reply": {
                    "type": "object",
                    "properties": {
                        "sender_id": {
                            "type": "string",
                            "description": "被回复消息的发送者。"
                        },
                        "receiver_id": {
                            "type": "string",
                            "description": "被回复消息的接收者。"
                        },
                        "create_time": {
                            "type": "number",
                            "description": "被回复消息的发送时间。"
                        },
                        "message_server_id": {
                            "type": "number",
                            "description": "被回复消息的服务器消息 ID。"
                        },
                        "message_client_id": {
                            "type": "string",
                            "description": "被回复消息的客户端消息 ID。"
                        }
                    },
                    "x-apifox-orders": [
                        "sender_id",
                        "receiver_id",
                        "create_time",
                        "message_server_id",
                        "message_client_id"
                    ],
                    "description": "被回复的消息对象。"
                }
            },
            "x-apifox-orders": [
                "thread_root",
                "thread_reply"
            ],
            "description": "Thread 消息配置项。",
            "$ref": "#/definitions/139509451"
        },
        "sender_no_sense": {
            "type": "boolean",
            "title": "发送方无感知",
            "description": "发送方是否无感知,默认为 false。若设置为无感知(true),则消息发送者无该消息的多端、漫游、历史记录等信息。 查询历史消息时可设置是否在历史记录查询结果中包含无感知消息,具体参见分页查询历史消息。 发送者和接收者必须有一方感知,即不能将两者都设置为无感知。",
            "default": "false"
        },
        "receiver_no_sense": {
            "type": "boolean",
            "title": "接收方无感知",
            "description": "接收方是否无感知,默认为 false。若设置为无感知(true),则消息接收者无该消息的多端、漫游、历史记录等信息。 查询历史消息时可设置是否在历史记录查询结果中包含无感知消息,具体参见分页查询历史消息。",
            "default": "false"
        },
        "extension": {
            "type": "string",
            "description": "开发者扩展字段,JSON 格式,长度上限为 1024 位字符。例如:\"{\"k\":\"v\"}\"",
            "title": "开发者扩展字段"
        },
        "message": {
            "type": "object",
            "properties": {
                "message_client_id": {
                    "type": "string",
                    "title": "客户端消息id(不传则自动生成)",
                    "description": "客户端消息id(不传则自动生成)"
                }
            },
            "x-apifox-orders": [
                "01HNSRBA5HQWQYKJ8C5C2WHBBZ",
                "message_client_id"
            ],
            "title": "消息体",
            "x-apifox-refs": {
                "01HNSRBA5HQWQYKJ8C5C2WHBBZ": {
                    "$ref": "#/definitions/81970145",
                    "x-apifox-overrides": {
                        "attachment": {
                            "type": "object",
                            "properties": {},
                            "x-apifox-orders": [],
                            "description": "非文本消息/提示消息的属性或自定义消息内容,长度上限 5000 位字符。 对于非文本消息/提示消息,该字段必填,每种消息的属性参数见:消息格式示例。",
                            "title": "多媒体消息内容"
                        },
                        "text": {
                            "type": "string",
                            "description": "对于文本消息和提示消息,该字段必填,值为消息内容,长度上限 5000 位字符。 对于非文本/提示消息,该字段非必填,值为描述信息,可用于全文关键字搜索历史消息,长度上限 500 位字符。",
                            "maxLength": 500,
                            "title": "文本消息"
                        },
                        "sub_type": {
                            "type": "integer",
                            "description": "自定义消息子类型,大于 0。message_type = 100 时该字段才有效。",
                            "minimum": 0,
                            "exclusiveMinimum": 0,
                            "title": "自定义消息子类型"
                        },
                        "message_type": {
                            "type": "integer",
                            "description": "消息类型。 0:文本消息 1:图片消息 2:语音消息 3:视频消息 4:地理位置消息 6:文件消息 10:提示消息 100:自定义消息 对于未开通安全通(即易盾反垃圾)功能的应用,自定义消息不会过内容审核。",
                            "title": "消息类型"
                        }
                    },
                    "required": [
                        "message_type"
                    ]
                }
            },
            "description": "消息体。"
        },
        "message_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1GJ1KRDV2WKZJYMV4150C"
            ],
            "title": "消息配置",
            "description": "消息配置项。",
            "x-apifox-refs": {
                "01HNS1GJ1KRDV2WKZJYMV4150C": {
                    "$ref": "#/definitions/81871495"
                }
            }
        },
        "route_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1HHNQC0KHGVJK70HXW0SH"
            ],
            "description": "抄送相关配置项。",
            "title": "抄送配置",
            "x-apifox-refs": {
                "01HNS1HHNQC0KHGVJK70HXW0SH": {
                    "$ref": "#/definitions/81873802"
                }
            }
        },
        "push_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1JHHJQ5DM8VJE69DRJWS9"
            ],
            "description": "推送相关配置项。",
            "title": "推送配置",
            "x-apifox-refs": {
                "01HNS1JHHJQ5DM8VJE69DRJWS9": {
                    "$ref": "#/definitions/81874011"
                }
            }
        },
        "antispam_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNRYHRCV38S3B9R2V8A92FCA"
            ],
            "description": "安全通相关配置项。",
            "title": "安全通配置",
            "x-apifox-refs": {
                "01HNRYHRCV38S3B9R2V8A92FCA": {
                    "$ref": "#/definitions/81855284"
                }
            }
        },
        "p2p_option": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1K8WX52R9S593BZ3RTRF7"
            ],
            "description": "单聊消息功能配置项。",
            "title": "单聊消息配置",
            "x-apifox-refs": {
                "01HNS1K8WX52R9S593BZ3RTRF7": {
                    "$ref": "#/definitions/81874107"
                }
            }
        },
        "team_option": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1KWD9WH314966NXZ9BYJF"
            ],
            "description": "高级群消息功能配置项。",
            "x-apifox-refs": {
                "01HNS1KWD9WH314966NXZ9BYJF": {
                    "$ref": "#/definitions/81874148"
                }
            },
            "title": "高级群消息配置"
        },
        "superteam_option": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNS1MAVJXR5Q9MV93GMA4DZC"
            ],
            "description": "超大群消息功能配置项。",
            "x-apifox-refs": {
                "01HNS1MAVJXR5Q9MV93GMA4DZC": {
                    "$ref": "#/definitions/81874164"
                }
            },
            "title": "超大群消息配置"
        },
        "robot_config": {
            "type": "object",
            "properties": {},
            "x-apifox-orders": [
                "01HNRYXG18FJK06M1K1VBKBDAQ"
            ],
            "description": "机器人功能配置项。",
            "x-apifox-refs": {
                "01HNRYXG18FJK06M1K1VBKBDAQ": {
                    "$ref": "#/definitions/81857819"
                }
            },
            "title": "机器人功能配置"
        },
        "target_option": {
            "type": "object",
            "properties": {
                "receiver_account_ids": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "description": "账号 ID"
                    },
                    "title": "群定向消息成员列表,即指定接收群消息的群成员列表。",
                    "description": "当 inclusive 为 true,当前列表为可见(接收)列表。\n当 inclusive 为 false,当前列表为不可见(不接收)列表。\n列表中不能包含消息发送者,消息发送者默认为可见。\n列表中不能包含非法账号、非群成员账号。\n列表中最多可以传入 100 个用户账号。"
                },
                "inclusive": {
                    "type": "boolean",
                    "title": "是否为可见列表",
                    "description": "群定向消息成员列表是否为可见列表。默认为 true,即 receiver_account_ids 为可见(接收)列表。\n发送超大群消息时,不能将 inclusive 设置为 false。",
                    "default": true
                },
                "visible_to_new_member": {
                    "type": "boolean",
                    "default": false,
                    "description": "新进群成员是否可见该消息。默认为 false,即新进群成员不可以查看该定向消息。若设置为 true,则新进群成员若可以查询该定向消息,可以通过云端历史相关接口查询到该消息。\n当 inclusive 为 true 时,不能同时设置 visible_to_new_member 为 true。即发送定向列表为可见的定向消息时,只能由定向列表中成员接收和查看。\n发送超大群消息时,不能将 visible_to_new_member 设置为 true。",
                    "title": "新进群成员是否可见该消息"
                }
            },
            "x-apifox-orders": [
                "receiver_account_ids",
                "inclusive",
                "visible_to_new_member"
            ],
            "title": "群定向消息配置项。",
            "description": "该功能需要单独开通。"
        },
        "check_team_member_valid": {
            "type": "boolean",
            "description": "发送群定向消息时,是否需要验证定向成员的群成员身份。默认为 true,即需要验证群成员身份。",
            "title": "是否校验定向成员合法性"
        }
    },
    "x-apifox-orders": [
        "sender_no_sense",
        "receiver_no_sense",
        "extension",
        "message",
        "message_config",
        "route_config",
        "push_config",
        "antispam_config",
        "p2p_option",
        "team_option",
        "superteam_option",
        "robot_config",
        "01JFSCQ2KZSC3XXJ3PE5DD5S86",
        "target_option",
        "check_team_member_valid",
        "thread_config"
    ],
    "x-apifox-refs": {
        "01JFSCQ2KZSC3XXJ3PE5DD5S86": {
            "$ref": "#/definitions/138813602"
        }
    },
    "required": [
        "message",
        "check_team_member_valid"
    ]
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
object 
必需
message_server_id
integer 
必需
message_client_id
string 
必需
message_type
integer 
必需
text
string 
必需
attachment
object 
必需
sub_type
integer 
必需
sender_id
string 
必需
conversation_type
integer 
必需
receiver_id
string 
必需
create_time
integer 
必需
示例
{
    "code": 0,
    "msg": "string",
    "data": {
        "message_server_id": 0,
        "message_client_id": "string",
        "message_type": 0,
        "text": "string",
        "attachment": {
            "index": 0,
            "text": "string",
            "finish": 0
        },
        "sub_type": 0,
        "sender_id": "string",
        "conversation_type": 0,
        "receiver_id": "string",
        "create_time": 0
    }
}
🟢200成功
🟢200请求参数错误
🟢200服务器错误
上一页
检索历史消息
下一页
创建会话
Built with