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

发送消息

POST
/im/v2/conversations/{conversation_id}/messages

请求参数

Path 参数

Header 参数

Body 参数application/json

示例
{
    "sender_no_sense": false,
    "receiver_no_sense": false,
    "extension": "dolore dolor sint qui voluptate",
    "message": {
        "message_type": 0,
        "sub_type": 26357002,
        "text": "Lorem laboris cillum ut exercitation",
        "attachment": {
            "name": "器年众际根开以",
            "md5": "esse Excepteur do",
            "url": "http://zpcuedkr.nc/yjy",
            "ext": "Excepteur consequat",
            "width": 83,
            "height": 56,
            "size": 18
        }
    },
    "message_config": {
        "unread_enabled": false,
        "mutil_sync_enabled": true,
        "offline_enabled": true,
        "history_enabled": false,
        "roaming_enabled": true,
        "conversation_update_enabled": true
    },
    "route_config": {
        "route_enabled": true,
        "route_environment": "Lorem anim quis"
    },
    "push_config": {
        "push_enabled": true,
        "push_nick_enabled": false,
        "push_content": "id do in velit",
        "push_payload": null,
        "push_forcepush_all": true,
        "push_forcepush_ids": [
            "22"
        ],
        "push_forcepush_content": "nostrud veniam dolore esse"
    },
    "antispam_config": {
        "antispam_enabled": false,
        "antispam_business_id": "44",
        "antispam_extension": null,
        "antispam_custom_message_enabled": true,
        "antispam_custom_message": "laborum non irure et",
        "antispam_cheating": "{\"email\":\"123@126.com\"}"
    },
    "p2p_option": {
        "check_friend": true
    },
    "team_option": {
        "mark_as_read": true,
        "ignore_chat_banned": false
    },
    "superteam_option": {
        "ignore_chat_banned": false
    },
    "robot_config": {
        "robot_account_id": null,
        "robot_topic": "http://dummyimage.com/400x400",
        "robot_function": "ex nisi pariatur qui do",
        "robot_custom_content": "quis Lorem"
    }
}

请求示例代码

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/apifoxtest1|1|accid4/messages' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sender_no_sense": false,
    "receiver_no_sense": false,
    "extension": "dolore dolor sint qui voluptate",
    "message": {
        "message_type": 0,
        "sub_type": 26357002,
        "text": "Lorem laboris cillum ut exercitation",
        "attachment": {
            "name": "器年众际根开以",
            "md5": "esse Excepteur do",
            "url": "http://zpcuedkr.nc/yjy",
            "ext": "Excepteur consequat",
            "width": 83,
            "height": 56,
            "size": 18
        }
    },
    "message_config": {
        "unread_enabled": false,
        "mutil_sync_enabled": true,
        "offline_enabled": true,
        "history_enabled": false,
        "roaming_enabled": true,
        "conversation_update_enabled": true
    },
    "route_config": {
        "route_enabled": true,
        "route_environment": "Lorem anim quis"
    },
    "push_config": {
        "push_enabled": true,
        "push_nick_enabled": false,
        "push_content": "id do in velit",
        "push_payload": null,
        "push_forcepush_all": true,
        "push_forcepush_ids": [
            "22"
        ],
        "push_forcepush_content": "nostrud veniam dolore esse"
    },
    "antispam_config": {
        "antispam_enabled": false,
        "antispam_business_id": "44",
        "antispam_extension": null,
        "antispam_custom_message_enabled": true,
        "antispam_custom_message": "laborum non irure et",
        "antispam_cheating": "{\"email\":\"123@126.com\"}"
    },
    "p2p_option": {
        "check_friend": true
    },
    "team_option": {
        "mark_as_read": true,
        "ignore_chat_banned": false
    },
    "superteam_option": {
        "ignore_chat_banned": false
    },
    "robot_config": {
        "robot_account_id": null,
        "robot_topic": "http://dummyimage.com/400x400",
        "robot_function": "ex nisi pariatur qui do",
        "robot_custom_content": "quis Lorem"
    }
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 200,
    "msg": "success",
    "data": {
        "text": "Lorem laboris cillum ut exercitation",
        "attachment": {
            "ext": "Excepteur consequat",
            "size": 18,
            "name": "器年众际根开以",
            "width": 83,
            "url": "http://zpcuedkr.nc/yjy",
            "md5": "esse Excepteur do",
            "height": 56
        },
        "message_server_id": 9899821270208,
        "sender_id": "apifoxtest1",
        "conversation_type": 1,
        "receiver_id": "accid4",
        "create_time": 1707035841692,
        "message_type": 0,
        "sub_type": 26357002
    }
}
🟢200请求参数错误
🟢200服务器错误
修改于 2025-03-17 03:27:49
上一页
分页查询聊天室历史消息
下一页
批量发送单聊消息
Built with