发送聊天室自定义消息
更新时间： 2024/11/04 15:22:15
本文介绍如何通过 NERoom 服务端接口发送自定义消息，您可以通过自定义消息实现礼物等功能。
接口请求地址
- 请求方法：POST
- URL：https://roomkit.netease.im/apps/v2/sendChatRoomCustomMessage
请求参数
- 请求 Header 的设置请参见 请求结构。
- 请求 Body 的设置如下：
| 参数名称 | 类型 | 是否必选 | 示例 | 描述 |
|---|---|---|---|---|
| roomUuid | String | 是 | NE***10 | 房间ID，最大长度64个字符，传空值，则随机生成一个房间ID。 支持以下字符类型：
|
| message | String | 是 | - | 消息体，最大长度为 500 字符。 |
返回参数
| 参数名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| code | int | 0 | 状态码，0表示成功，具体请参见具体请参见错误码。 |
| msg | String | Success | 业务结果描述，Success表示成功。 |
| ts | Long | 1648021056815 | NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。 |
| requestId | String | 7c4b6d9c3e9d42*****cc6e3a4d995 | 请求的唯一标识。 |
| cost | String | 48ms | 处理该请求所消耗的时间。 |
示例
请求示例
curl --request POST 'https://roomkit.netease.im/apps/v2/sendChatRoomCustomMessage' \
--header 'AppKey: xxx' \
--header 'Nonce: xxx' \
--header 'CurTime: 1677050511' \
--header 'CheckSum: xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
"roomUuid":"89786343321",
"message": "xxxxxx"
}'
返回示例
{
"code":0,
"msg":"Success",
"ts":1619068087795,
"requestId":"6e507107d1f4447ea731f651dc6d2432",
"cost":"66ms"
}
此文档是否对你有帮助？
