更新消息
开发中POST
/im/v2/messages/actions/modifyMsg网易云信服务端支持对七天内已发送成功的消息进行二次编辑,从而更新消息。
请求参数
更新(二次编辑)消息的用户账号 ID。operator 是更新消息的操作者,可能是发送者,也可能是群主、群管理员等有更新消息权限的用户。
开发者扩展字段,JSON 格式。例如:"{"k":"v"}"。
该字段长度上限以使用的 IM 套餐为准。IM 旗舰版及以上套餐才支持配置字段上限。
待更新消息的原始会话类型。
1:单聊。
2:高级群。
3:超大群。
该参数设置必须和原始消息保持一致。
消息体。
消息类型。 0:文本消息 1:图片消息 2:语音消息 3:视频消息 4:地理位置消息 6:文件消息 10:提示消息 100:自定义消息 对于未开通安全通(即易盾反垃圾)功能的应用,自定义消息不会过内容审核。
自定义消息子类型,大于 0。message_type = 100 时该字段才有效。
对于文本消息和提示消息,该字段必填,值为消息内容,长度上限 5000 位字符。 对于非文本/提示消息,该字段非必填,值为描述信息,可用于全文关键字搜索历史消息,长度上限 500 位字符。
非文本消息/提示消息的属性或自定义消息内容,长度上限 5000 位字符。 对于非文本消息/提示消息,该字段必填,每种消息的属性参数见:消息格式示例。
待更新消息的原始 ID。
待更新消息的原始接收者 ID 或群组 ID。
待更新消息的原始发送时间,默认只能修改七天内已发送的消息。
待更新消息的原始发送者。
是否将该消息更新至会话列表服务中本会话的最后一条消息。默认为 true(更新)。
抄送相关配置项。
该消息是否需要抄送至指定的应用服务器(需要为应用开通消息抄送功能),默认为 true(抄送)。
抄送相关配置项。
推送相关配置项。
该消息是否需要 APNs 推送或 Android 系统通知栏推送,默认为 true(推送)。只有该字段为 true 时,推送相关参数才会生效。
推送文案是否需要带上昵称,默认为 true(带昵称)。
推送文案,长度上限 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 消息默认文案:更新了一条提醒
语音聊天邀请消息默认文案:您收到一条消息更新
视频聊天邀请消息默认文案:您收到一条消息更新
推送对应的 payload,必须是 JSON 格式,长度上限 2048 位字符。详情请参见推送 payload 配置。
该消息(群消息)是否强制推送(@操作),默认为 false。只有该字段为 true 时强制推送相关参数才会生效。
该消息(群消息)的强推(@操作)账号列表,格式为 JSONArray,如["account1","account2"]。若 push_forcepush_all 为 true,则该字段无效,该消息会强制推送(@操作)给群组中所有有效成员(除消息发送者)。 最多可强推 100 个用户。
强制推送的文案,仅针对强推列表 push_forcepush_ids 中的账号,长度上限 500 位字符。
该消息(群消息)是否强制推送(@操作),默认为 false。只有该字段为 true 时强制推送相关参数才会生效。
安全通相关配置项。
该消息(除自定义消息)是否需要过审核。 若已在控制台开通安全通,该字段默认为 true(过审核),若需要设置单条消息不经过审核,则设置为 fasle。 若未开通安全通,该字段无效。
安全通业务 ID,可以指定当前消息过安全通某个检测策略。 默认情况下云信控制后台会生成默认业务,开通安全通后,客户端不需要配置业务 ID 就能默认走该策略,若需要自定义检测策略,请联系技术支持进行配置,配置好后传入对应的安全通业务 ID,表示当前消息过安全通的指定检测策略。
透传给易盾的反垃圾增强版的检测参数,格式为 JSON,长度限制 1024 位字符(具体请参见易盾的反垃圾增强版用户可扩展参数)。反作弊相关的 email、phone、token、extension,抄送到 antispam_cheating 字段中。其他用户增值信息,抄送到 antispam_extension 字段。
是否对自定义消息的指定内容(antispam_custom_message)进行审核。 若已在控制台开通安全通,该字段默认为 false(不过审核),若需要设置该条自定义消息经过审核,则设置为 true。 若未开通安全通,该字段无效。
自定义的安全通检测内容, JSON 格式,长度限制同 text 字段。格式如下: {"type":1,"data":"custom content"} 字段说明: type: 1 为文本;2 为图片;3 为视频;(TODO 音频) data: 文本内容或图片地址。 该参数只对自定义消息(message_type = 100 )且 ntispam_custom_message_enabled = true 时才生效。
透传给易盾的反作弊检测参数,格式为 JSON,长度限制 1024 位字符(具体请参见易盾的反垃圾防刷版专属参数)。反作弊相关的 email、phone、token、extension,抄送到antispam_cheating 字段中。其他用户增值信息,抄送到 antispam_extension 字段。 antispam_extension 传入的值默认覆盖 extension。
单聊消息功能配置项。
该消息是否只发给好友(与消息发送者为好友关系的账号),默认为 false。 若需要设置为好友关系才能发送消息,需先在云信控制台完成配置,再将该字段设置为 true。
高级群消息功能配置项。
更新高级群消息时,是否忽略群禁言。默认为 false(不忽略)。若设置为 true(忽略),那么高级群内被禁言的情况下也可以更新消息。
超大群消息功能配置项。
更新超大群消息时,是否忽略成员禁言。默认为 false(不忽略)。若设置为 true(忽略),那么超大群内被禁言的用户也可以更新消息。
更新超大群消息时,是否忽略成员禁言。默认为 false(不忽略)。如设置为 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
},
"superteam_option": {
"ignore_chat_banned": false,
"ignore_member_chat_banned": false
}
}
示例代码
返回响应
消息更新者的用户账号 ID。
只有消息被更新才会返回该字段。
消息的更新时间。
只有消息被更新才会返回该字段。
消息类型。 0:文本消息 1:图片消息 2:语音消息 3:视频消息 4:地理位置消息 6:文件消息 10:提示消息 100:自定义消息 对于未开通安全通(即易盾反垃圾)功能的应用,自定义消息不会过内容审核。
自定义消息子类型,大于 0。message_type = 100 时该字段才有效。
对于文本消息和提示消息,该字段必填,值为消息内容,长度上限 5000 位字符。 对于非文本/提示消息,该字段非必填,值为描述信息,可用于全文关键字搜索历史消息,长度上限 500 位字符。
非文本消息/提示消息的属性或自定义消息内容,长度上限 5000 位字符。 对于非文本消息/提示消息,该字段必填,每种消息的属性参数见:消息格式示例。
{
"code": 0,
"msg": "string",
"data": {
"message_server_id": 0,
"sender_id": "string",
"receiver_id": "string",
"create_time": 0
}
}