# 企微管理
# 群发创建
创建企微群发消息
调用说明
- 本接口只支持POST请求;
- 本接口请求Content-Type类型为:application/json;charset=utf-8;
- 本接口返回类型为JSON,同时进行UTF-8编码。
数据校验
参考通用说明-数据校验 (opens new window)
接口参数说明
使用该接口可以创建客户/客户群群发任务,并可以通过【群发结果查询】查询群发结果。
服务器收到的POST请求如下:
POST https://qiyukf.com/openapi/wxwork/createWxworkMsgTask?appKey=1064deea1c3624c9ee26d1de5ce8481f&time=1463217187&checksum=2f13932c4b7c6888b12360a85261a11b8b543f64
Content-Type:application/json;charset=utf-8
请求内容示例如下:
{
"requestId": "request id",
"sendUserId": "send staff user id",
"taskType": 1,
"targetIds": [
"target user id1", "target user id2"
],
"contents":
[{
"contentId":"content id",
"contentType":"image",
"text":"text",
"picUrl":"pic url",
"fileUrl":"file url",
"title":"title",
"videoUrl":"video url",
"videoIndexUrl":"video index url",
"desc":"desc",
"linkUrl":"link url"
}]
}
请求参数说明如下:
参数 | 是否必须 | 参数说明 |
---|---|---|
requestId | 是 | 请求id,有效期:10分钟 |
sendUserId | 是 | 企微微信员工id |
taskType | 是 | 1 客户群发 2 客户群群发 |
targetIds | 是 | 发送对象企微信id集合 |
contents.contentId | 是 | 内容id,不重复 |
contents.contentType | 是 | 枚举:text,image,file,video,link |
contents.text | 是 | 文本类型必填 |
contents.picUrl | 是 | 图片类型,图文类型必填 |
contents.fileUrl | 是 | 文件链接,文件类型必填 |
contents.title | 是 | 文件类型,图文类型必填 |
contents.videoUrl | 是 | 视频链接,视频类型必填 |
contents.videoIndexUrl | 是 | 视频首帧封面图,视频类型必填 |
contents.desc | 是 | 图文类型必填 |
contents.linkUrl | 是 | 图文类型必填 |
响应参数说明如下:
参数 | 参数说明 |
---|---|
code | 错误码。200表示设置成功。 |
message | 错误提示信息 |
data | 返回结果 |
data.taskId | 创建出的任务id |
返回数据示例如下:
{
"code": 200,
"message": "success",
"data": {
"taskId": "task id"
}
}
# 群发结果查询
调用说明
- 本接口只支持POST请求;
- 本接口请求Content-Type类型为:application/json;charset=utf-8;
- 本接口返回类型为JSON,同时进行UTF-8编码。
数据校验
参考通用说明-数据校验 (opens new window)
接口参数说明
使用该接口可以查询群发任务的发送结果。
服务器收到的POST请求如下:
POST https://qiyukf.com/openapi/wxwork/queryWxworkMsgTaskTargets?appKey=1064deea1c3624c9ee26d1de5ce8481f&time=1463217187&checksum=2f13932c4b7c6888b12360a85261a11b8b543f64
Content-Type:application/json;charset=utf-8
请求内容示例如下:
{
"taskId": "task id"
}
请求参数说明如下:
参数 | 是否必须 | 参数说明 |
---|---|---|
taskId | 是 | 任务id |
响应参数说明如下:
参数 | 参数说明 |
---|---|
code | 错误码。200表示设置成功。 |
message | 错误提示信息 |
data | 返回结果 |
data.targetId | 企微微信发送对象id |
data.taskId | 群发任务id |
data.results.contentId | 内容id |
data.results.sendStatus | 0 未知 1已发送 2发送失败 3发送成功 |
data.results.sendStatusName | 发送状态描述 |
data.results.failReason | 失败原因 |
返回数据示例如下:
{
"code": 200,
"message": "success",
"data": [
{
"targetId": "target id",
"taskId": "task id",
"results": [
{
"contentId": "content id",
"sendStatus": 1,
"sendStatusName": "send status name",
"failReason": "fail reason"
}
]
}
]
}