更新消息

开发中

POST

/im/v2/messages/actions/modifyMsg

网易云信服务端支持对七天内已发送成功的消息进行二次编辑，从而更新消息。

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

operator

string

必需

更新（二次编辑）消息的用户账号 ID。operator 是更新消息的操作者，可能是发送者，也可能是群主、群管理员等有更新消息权限的用户。

extension

string

可选

开发者扩展字段，JSON 格式。例如："{"k":"v"}"。
该字段长度上限以使用的 IM 套餐为准。IM 旗舰版及以上套餐才支持配置字段上限。

type

integer

必需

待更新消息的原始会话类型。
1：单聊。
2：高级群。
3：超大群。
该参数设置必须和原始消息保持一致。

message

object

消息体

必需

消息体。

message_type

integer

消息类型

必需

消息类型。 0：文本消息 1：图片消息 2：语音消息 3：视频消息 4：地理位置消息 6：文件消息 10：提示消息 100：自定义消息对于未开通安全通（即易盾反垃圾）功能的应用，自定义消息不会过内容审核。

sub_type

integer

自定义消息子类型

可选

自定义消息子类型，大于 0。message_type = 100 时该字段才有效。

> 0

text

string

文本消息

可选

对于文本消息和提示消息，该字段必填，值为消息内容，长度上限 5000 位字符。对于非文本/提示消息，该字段非必填，值为描述信息，可用于全文关键字搜索历史消息，长度上限 500 位字符。

<= 500 字符

attachment

object

多媒体消息内容

可选

非文本消息/提示消息的属性或自定义消息内容，长度上限 5000 位字符。对于非文本消息/提示消息，该字段必填，每种消息的属性参数见：消息格式示例。

message_server_id

number

必需

待更新消息的原始 ID。

receiver_id

string

必需

待更新消息的原始接收者 ID 或群组 ID。

time

number

必需

待更新消息的原始发送时间，默认只能修改七天内已发送的消息。

sender_id

string

必需

待更新消息的原始发送者。

message_config

object

可选

conversation_update_enabled

boolean

更新会话

可选

是否将该消息更新至会话列表服务中本会话的最后一条消息。默认为 true（更新）。

默认值:

true

route_config

object

抄送配置

可选

抄送相关配置项。

route_enabled

boolean

可选

默认值:

true

route_environment

string

可选

push_config

object

推送配置

可选

推送相关配置项。

push_enabled

boolean

是否推送

可选

该消息是否需要 APNs 推送或 Android 系统通知栏推送，默认为 true（推送）。只有该字段为 true 时，推送相关参数才会生效。

默认值:

true

push_nick_enabled

boolean

推送是否带昵称

可选

推送文案是否需要带上昵称，默认为 true（带昵称）。

默认值:

true

push_content

string

推送文案

可选

推送文案，长度上限 500 位字符。如果不填，则使用默认推送文案。
推送文案的显示规则如下：
push_content 不为空且 push_nick_enabled = true，最终推送文案为：推送者昵称+ push_content
push_content 不为空且 push_nick_enabled = false，最终推送文案为：push_content
push_content 为空且 push_nick_enabled = true，最终推送文案为：推送者昵称+默认文案
push_content 为空且 push_nick_enabled = false，最终推送文案为：默认文案
其中，根据消息类型，默认文案分为以下几种：
文本消息默认文案：更新了一条消息
地理位置默认文案：更新了一个地理位置
语音消息默认文案：更新了一段语音
视频消息默认文案：更新了一段视频
文件消息默认文案：更新了一个文件
图片消息默认文案：更新了一张图片
Tip 消息默认文案：更新了一条提醒
语音聊天邀请消息默认文案：您收到一条消息更新
视频聊天邀请消息默认文案：您收到一条消息更新

<= 500 字符

push_payload

string

推送payload

可选

推送对应的 payload，必须是 JSON 格式，长度上限 2048 位字符。详情请参见推送 payload 配置。

<= 2048 字符

push_forcepush_all

boolean

是否强制推送

可选

该消息（群消息）是否强制推送（@操作），默认为 false。只有该字段为 true 时强制推送相关参数才会生效。

默认值:

false

push_forcepush_ids

array[string]

强推列表

可选

该消息（群消息）的强推（@操作）账号列表，格式为 JSONArray，如["account1","account2"]。若 push_forcepush_all 为 true，则该字段无效，该消息会强制推送（@操作）给群组中所有有效成员（除消息发送者）。最多可强推 100 个用户。

push_forcepush_content

string

强推文案

可选

强制推送的文案，仅针对强推列表 push_forcepush_ids 中的账号，长度上限 500 位字符。

<= 500 字符

push_forcepush_enable

boolean

可选

该消息（群消息）是否强制推送（@操作），默认为 false。只有该字段为 true 时强制推送相关参数才会生效。

antispam_config

object

安全通

可选

安全通相关配置项。

antispam_enabled

boolean

安全通开关

可选

该消息（除自定义消息）是否需要过审核。若已在控制台开通安全通，该字段默认为 true（过审核），若需要设置单条消息不经过审核，则设置为 fasle。若未开通安全通，该字段无效。

默认值:

true

antispam_business_id

string

安全通业务ID

可选

安全通业务 ID，可以指定当前消息过安全通某个检测策略。默认情况下云信控制后台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请联系技术支持进行配置，配置好后传入对应的安全通业务 ID，表示当前消息过安全通的指定检测策略。

antispam_extension

string

安全通增强参数

可选

透传给易盾的反垃圾增强版的检测参数，格式为 JSON，长度限制 1024 位字符（具体请参见易盾的反垃圾增强版用户可扩展参数）。反作弊相关的 email、phone、token、extension，抄送到 antispam_cheating 字段中。其他用户增值信息，抄送到 antispam_extension 字段。

antispam_custom_message_enabled

boolean

自定义内容审核开关

可选

是否对自定义消息的指定内容（antispam_custom_message）进行审核。若已在控制台开通安全通，该字段默认为 false（不过审核），若需要设置该条自定义消息经过审核，则设置为 true。若未开通安全通，该字段无效。

默认值:

false

antispam_custom_message

string

自定义安全通检测内容

可选

自定义的安全通检测内容, JSON 格式，长度限制同 text 字段。格式如下： {"type":1,"data":"custom content"} 字段说明： type: 1 为文本；2 为图片；3 为视频；4 为音频；5 为图文。 data: type 为 1、2、3、4 时，data 为字符串，分别传入文本内容、图片地址、视频/音频地址。 type 为 5 时，data 为 JSON 格式。例如：{"text":""，//1 个文本必填"images":["url1,"url2"], //最大 6 个图片必填"textbid":"", //文本检测业务 ID 选填"picbid":"" //图片检测业务 ID 选填}。该参数只对自定义消息（message_type = 100 ）且 ntispam_custom_message_enabled = true 时才生效。

antispam_cheating

string

反作弊检测参数

可选

透传给易盾的反作弊检测参数，格式为 JSON，长度限制 1024 位字符（具体请参见易盾的反垃圾防刷版专属参数）。反作弊相关的 email、phone、token、extension，抄送到antispam_cheating 字段中。其他用户增值信息，抄送到 antispam_extension 字段。 antispam_extension 传入的值默认覆盖 extension。

p2p_option

object

单聊消息配置

可选

单聊消息功能配置项。

check_friend

boolean

是否校验好友关系

必需

该消息是否只发给好友（与消息发送者为好友关系的账号），默认为 false。若需要设置为好友关系才能发送消息，需先在云信控制台完成配置，再将该字段设置为 true。

team_option

object

高级群消息功能配置项。

可选

高级群消息功能配置项。

ignore_chat_banned

boolean

可选

更新高级群消息时，是否忽略群禁言。默认为 false（不忽略）。若设置为 true（忽略），那么高级群内被禁言的情况下也可以更新消息。

默认值:

false

check_team_member_valid

boolean

可选

更新高级群消息时，是否需要验证群成员身份，true：需要；false：不需要，默认为 true

默认值:

true

superteam_option

object

超大群消息功能配置项。

可选

超大群消息功能配置项。

ignore_chat_banned

boolean

可选

更新超大群消息时，是否忽略成员禁言。默认为 false（不忽略）。若设置为 true（忽略），那么超大群内被禁言的用户也可以更新消息。

默认值:

false

ignore_member_chat_banned

boolean

可选

更新超大群消息时，是否忽略成员禁言。默认为 false（不忽略）。如设置为 true（忽略），那么超大群内被禁言的用户也可以更新消息。

默认值:

false

check_team_member_valid

boolean

可选

更新超大群消息时，是否需要验证群成员身份，true：需要；false：不需要，默认为 true

默认值:

true

示例

{
    "operator": "string",
    "extension": "string",
    "type": 0,
    "message": {
        "message_type": 0,
        "sub_type": 1,
        "text": "string",
        "attachment": {},
        "message_server_id": 0,
        "receiver_id": "string",
        "time": 0,
        "sender_id": "string"
    },
    "message_config": {
        "conversation_update_enabled": "true"
    },
    "route_config": {
        "route_enabled": true,
        "route_environment": "string"
    },
    "push_config": {
        "push_enabled": "true",
        "push_nick_enabled": "true",
        "push_content": "string",
        "push_payload": "string",
        "push_forcepush_all": "false",
        "push_forcepush_ids": [
            "string"
        ],
        "push_forcepush_content": "string",
        "push_forcepush_enable": true
    },
    "antispam_config": {
        "antispam_enabled": true,
        "antispam_business_id": "string",
        "antispam_extension": "string",
        "antispam_custom_message_enabled": false,
        "antispam_custom_message": "string",
        "antispam_cheating": "string"
    },
    "p2p_option": {
        "check_friend": true
    },
    "team_option": {
        "ignore_chat_banned": false,
        "check_team_member_valid": true
    },
    "superteam_option": {
        "ignore_chat_banned": false,
        "ignore_member_chat_banned": false,
        "check_team_member_valid": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.yunxinapi.com/im/v2/messages/actions/modifyMsg' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operator": "string",
    "extension": "string",
    "type": 0,
    "message": {
        "message_type": 0,
        "sub_type": 1,
        "text": "string",
        "attachment": {},
        "message_server_id": 0,
        "receiver_id": "string",
        "time": 0,
        "sender_id": "string"
    },
    "message_config": {
        "conversation_update_enabled": "true"
    },
    "route_config": {
        "route_enabled": true,
        "route_environment": "string"
    },
    "push_config": {
        "push_enabled": "true",
        "push_nick_enabled": "true",
        "push_content": "string",
        "push_payload": "string",
        "push_forcepush_all": "false",
        "push_forcepush_ids": [
            "string"
        ],
        "push_forcepush_content": "string",
        "push_forcepush_enable": true
    },
    "antispam_config": {
        "antispam_enabled": true,
        "antispam_business_id": "string",
        "antispam_extension": "string",
        "antispam_custom_message_enabled": false,
        "antispam_custom_message": "string",
        "antispam_cheating": "string"
    },
    "p2p_option": {
        "check_friend": true
    },
    "team_option": {
        "ignore_chat_banned": false,
        "check_team_member_valid": true
    },
    "superteam_option": {
        "ignore_chat_banned": false,
        "ignore_member_chat_banned": false,
        "check_team_member_valid": true
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

modify_account_id

string

可选

消息更新者的用户账号 ID。
只有消息被更新才会返回该字段。

modify_time

number

可选

消息的更新时间。
只有消息被更新才会返回该字段。

message_type

integer

消息类型

必需

sub_type

integer

自定义消息子类型

可选

自定义消息子类型，大于 0。message_type = 100 时该字段才有效。

> 0

text

string

文本消息

可选

<= 500 字符

attachment

object

多媒体消息内容

可选

message_server_id

number

服务端消息 ID。

可选

sender_id

string

消息发送方账号 ID。

可选

receiver_id

string

消息接收者账号 ID。

可选

create_time

number

消息发送时间戳。

可选

示例

{
    "code": 0,
    "msg": "string",
    "data": {
        "modify_account_id": "string",
        "modify_time": 0,
        "message_type": 0,
        "sub_type": 1,
        "text": "string",
        "attachment": {},
        "message_server_id": 0,
        "sender_id": "string",
        "receiver_id": "string",
        "create_time": 0
    }
}

分页查询聊天室历史消息

根据消息 ID 查询历史消息