发送聊天室消息
开发中POST
/im/v2/chatrooms/{room_id}/messages请求参数
发送聊天室消息的账号 ID。
消息接收账号 ID 列表,例如["yx2","yx3"]。 该参数不为空即判定为定向消息,定向消息不存历史。 定向消息不支持 message_config 参数。 定向消息不支持空间坐标相关参数。
重发消息标记。 0(默认):非重发消息;1:重发消息(按照 message_client_id 进行去重)。
开发者扩展参数,JSON 格式,长度上限为 4096 位字符。例如:"{"k":"v"}"。
消息体。
消息客户端 ID。
消息类型。 0:文本消息 1:图片消息 2:语音消息 3:视频消息 4:地理位置消息 6:文件消息 10:提示消息 100:自定义消息
自定义消息子类型,大于 0。message_type = 100 时该参数才有效。
对于文本消息和提示消息,该字段必填,值为消息内容,长度上限 5000 位字符。 对于非文本/提示消息,该字段非必填,值为描述信息,可用于全文关键字搜索历史消息,长度上限 500 位字符。
非文本消息/提示消息的属性或自定义消息内容,长度上限 5000 位字符。 对于非文本消息/提示消息,该字段必填,每种消息的属性参数见:消息格式示例。
空间坐标 x,用于发送空间消息。
空间坐标 y,用于发送空间消息。
空间坐标 z,用于发送空间消息。
消息配置项。定向消息(receiver_ids 不为空)不支持该参数。
是否忽略聊天室的临时禁言。false(默认):不忽略,即消息发送者不能是临时禁言的聊天室成员。
该消息是否存云端历史。默认为 true(存储)。
云信会优先保障投递此类消息,默认为 false(低优先级)。 若需要重发高优先级消息,需要配置可以设置 need_high_priority_msg_resend 参数。 建议恰当使用该参数,以便在必要时,优先保障应用内的高优先级消息的投递。若全部设置为高优先级,则等于没有设置,单个聊天室最多支持每秒 10 条高优先级消息,超过的默认转为普通消息。
高优先级消息重发标记。默认为 false(不重发)。若设置为 true,当用户离开聊天室之后重新加入聊天室,在有效期内(30s)还会收到发送的此条消息。 该参数只有在 high_priority = true 时才生效。
消息丢弃的概率,取值范围 [0-9999]。0(默认):不丢弃消息;9999:99.99% 的概率丢弃消息。此参数可用于流控特定业务类型的消息。<note参数 type=note>若设置该参数,则 high_priority 参数设置无效。
目标标签表达式,用于设定聊天室消息提醒的投递对象,长度上限 128 位字符。
走 CDN 通道的消息的优先级,可选值:0(默认),1,2,3
高优先级消息被频控后是降级为普通消息还是返回错误码。 0(默认):降级为普通消息;1:返回 403 错误码。
抄送相关配置项。
该消息是否需要抄送至指定的应用服务器(需要为应用开通消息抄送功能),默认为 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。
数字人功能配置项。
数字人账号 ID,对应控制台提前设置好的数字人账号。
发起给数字人的查询请求的内容,结构体为:
{ "msg": "xxx",//内容 "type": 0//类型,当前仅支持 0 表示文本 }
如果为空且消息为文本消息,则提取消息中的 text 字段。
如果为空且不是文本消息,则返回 107336 错误。
数字人回溯的消息列表,结构体类似为:
[ { "msg": "hello", "type": 0, "role": "user" }, { "msg": "hello, I am your AI assistant", "type": 0, "role": "assistant" } ]
用于填充提示词中的变量,如果提示词中定义了变量,则该字段必填,结构体类似为:
{ "career":"chef" }
模型相关的配置参数,不同模型配置类型不同。结构体类似为:
{"maxTokens":1,"temperature":1,"prompt":"我是一个${{career}},请回答我的问题:","topP":0.5}
默认为 true,表示发送当前消息到聊天室。若设置为 false,则表示不发送当前消息到聊天室,只发送请求大模型后的消息。
{
"sender_id": "yx5",
"message": {
"message_client_id": "dsfjkldfsdlfskjdlfsdjlkfdskfsdj",
"message_type": 1,
"location_z": 34,
"text": "fugiat ullamco Duis nulla",
"attachment": {
"name": "器年众际根开以",
"md5": "esse Excepteur do",
"url": "http://zpcuedkr.nc/yjy",
"ext": "Excepteur consequat",
"width": 83,
"height": 56,
"size": 18
},
"sub_type": 72,
"location_x": 65,
"location_y": 94
},
"extension": "incididunt cupidatat",
"receiver_ids": [
"yx1",
"yx2",
"yx3"
],
"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\"}"
},
"resend_flag": 0,
"message_config": {
"high_priority": false,
"chat_msg_priority": 3,
"history_enabled": false,
"need_high_priority_msg_resend": true,
"ignore_chat_banned": false,
"notify_target_tags": "et sint aute anim",
"abandon_ratio": 21,
"forbidden_if_high_priority_msg_freq": 0
},
"route_config": {
"route_environment": "aute",
"route_enabled": true
}
}
示例代码
返回响应
{
"code": 200,
"msg": "success",
"data": {
"message": {
"attachment": {
"ext": "Excepteur consequat",
"size": 18,
"name": "器年众际根开以",
"width": 83,
"url": "http://zpcuedkr.nc/yjy",
"md5": "esse Excepteur do",
"height": 56
},
"message_client_id": "dsfjkldfsdlfskjdlfsdjlkfdskfsdj",
"create_time": 1709175731107,
"message_type": 1,
"sender_id": "yx5",
"sender_nick": "yx5",
"sender_avatar": "",
"room_id": 1605537145,
"high_priority": false,
"sub_type": 72
}
}
}