# 频道私信
机器人可与同一频道内的成员建立私信会话，通过私信接口收发消息。
# 创建私信会话
# 接口
POST /users/@me/dms
1
# 功能描述
用于机器人和在同一个频道内的成员创建私信会话。
- 机器人和用户存在共同频道才能创建私信会话。
- 创建成功后，返回创建成功的频道
id，子频道id和创建时间。
# Content-Type
application/json
1
# 参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| recipient_id | string | 接收者 id |
| source_guild_id | string | 源频道 id |
# 返回
返回DMS对象。
# 错误码
详见错误码。
# 示例
请求数据包
{
"recipient_id": "123456",
"source_guild_id": "112233"
}
1
2
3
4
2
3
4
响应数据包
{
"guild_id": "xxxxxx",
"channel_id": "xxxxxx",
"create_time": "1642545606"
}
1
2
3
4
5
2
3
4
5
# 发送私信
# 接口
POST /dms/{guild_id}/messages
1
# 功能描述
用于发送私信消息，前提是已经创建了私信会话。
- 私信的
guild_id在创建私信会话时以及私信消息事件中获取。 - 私信场景下，每个机器人每天可以对一个用户发
2条主动消息。 - 私信场景下，每个机器人每天累计可以发
200条主动消息。 - 私信场景下，被动消息没有条数限制。
# Content-Type
application/json
1
# 参数
和发送子频道消息参数一致。
# 返回
和发送子频道消息返回一致。
# 错误码
详见错误码。
# 示例
参见发送子频道消息示例。
# 撤回私信
# 接口
DELETE /dms/{guild_id}/messages/{message_id}?hidetip=false
1
# 参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| hidetip | bool | 选填，是否隐藏提示小灰条，true 为隐藏，false 为显示。默认为false |
# 功能描述
用于撤回私信频道 guild_id 中 message_id 指定的私信消息。只能用于撤回机器人自己发送的私信。
注意
- 公域机器人暂不支持申请，仅私域机器人可用，选择私域机器人后默认开通。
- 注意: 开通后需要先将机器人从频道移除，然后重新添加，方可生效。
# Content-Type
application/json
1
# 返回
成功返回 HTTP 状态码 200。
# 错误码
详见错误码。
# 示例
请求数据包
DELETE /dms/123456/messages/112233
1
# DMS 对象
# DMS
| 字段名 | 类型 | 描述 |
|---|---|---|
| guild_id | string | 私信会话关联的频道 id |
| channel_id | string | 私信会话关联的子频道 id |
| create_time | string | 创建私信会话时间戳 |
