批量发送消息
用于应用通过WPS协作给用户发送消息,支持多种消息类型,使用时需注意以下几点:
- 接收者需要在应用可用范围内。应用可用范围可通过获取应用可用范围接口获取
- 应用机器人发送的消息最多不超过 5000 个字符
- 支持向 4 类对象发送消息:指定用户、指定部门、指定企业、关联组织。但需注意的是,单次调用里面,不同类别的接收对象,其所属的企业必须为同一个,即授权企业(即不支持同时向不同企业的接收对象发送同一条消息)
- 请注意:
请求说明
请求地址 | https://openapi.wps.cn/v7/messages/batch_create |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理会话消息(应用授权) kso.chat_message.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
type | string | 是 | 消息类型 text :文本;rich_text :富文本;image :图片;file :文件;audio :音频;video :视频;card :卡片消息 |
receivers | array | 是 | 消息接收者 |
∟ partner_id | string | 否 | 关联组织 id,当接收者为关联组织时传 |
∟ receiver_ids | array | 是 | 接收者 id 列表,企业列表最多不能超过1个,部门列表最多不能超过50个,用户列表最多不能超过200个 |
∟ type | string | 是 | 接收者类型 company :企业;dept :部门;user :企业成员;enterprise_partner_dept :关联组织部门;enterprise_partner_user :关联组织成员 |
mentions | array | 否 | 被 at 的人员列表,最多不能超过100个,具体用法详见:消息内容(content)结构说明 “如何在消息内@人” 部分说明 |
∟ id | string | 是 | 指定聊天消息中 at 操作的实体索引 id。与消息正文中相应 <at id={index}> 标记中的 {index} 值匹配 |
∟ identity | object | 否 | 被 at 的用户信息,当 at 所有人时该值为空 |
∟ ∟ company_id | string | 是 | 用户所属企业id |
∟ ∟ id | string | 是 | 用户id |
∟ ∟ type | string | 是 | 身份类型 user :用户; |
∟ type | string | 是 | at 操作对象类型 all :所有人;user :用户 |
content | object | 是 | 消息内容,需要根据发送的消息类型 type ,传递不同的对象。详见:消息内容(content)结构说明 |
请求地址示例
[POST] https://openapi.wps.cn/v7/messages/batch_create
1
请求体示例
json
{
"type": "string",
"receivers": [
{
"partner_id": "string",
"receiver_ids": [
"string"
],
"type": "string"
}
],
"mentions": [
{
"id": "string",
"identity": {
"company_id": "string",
"id": "string",
"type": "user"
},
"type": "user"
}
],
"content": {
// 注意:根据不同 type,传递不同消息内容结构
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ message_id | string | 消息 id |
∟ invalid_receivers | array[object] | 不合法的接收者ID列表 |
∟∟ partner_id | string | 关联组织 id |
∟∟ receiver_ids | array[string] | 接收者 id 列表 |
∟∟ type | string[enum] | 接收者类型 company :企业;dept :部门;user :企业成员; |
响应体示例
json
{
"data": {
"message_id": "string",
"invalid_receivers": [
{
"partner_id": "string",
"receiver_ids": [
"string"
],
"type": "string[enum]"
}
]
},
"code": 0,
"msg": "string"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16