企微管理
创建企微群发任务
创建企微客户/客户群群发任务,返回创建的任务 ID。并可以通过【群发结果查询】查询群发结果。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| requestId | string | 是 | 请求追踪 ID,用于幂等和排重,有效期:10分钟 | req_20240601_001 |
| wxworkCorpGuid | string | 否 | 企微企业主体 ID;不传时取默认主体 | wx1234567890 |
| sendUserId | string | 是 | 发送者企微用户 ID,必须已绑定企微助手 | zhangsan |
| taskName | string | 否 | 任务名称,最长 30 个字符 | 618大促通知 |
| taskType | int32 | 是 | 任务类型:1-客户群发,2-群群发 | 1 |
| contents | object[] | 是 | 消息内容列表,至少 1 条且最多 9 条;每条消息的 contentType 及对应媒体字段也必须满足消息类型要求 | |
| └num | int32 | 否 | 序号,由服务端按内容顺序自动生成,非必填 | 1 |
| └contentId | string | 否 | 内容 ID(素材库素材 ID),非必填;不传时由服务端自动生成 | material_001 |
| └contentType | string | 是 | 内容类型:text-文本,image-图片,file-文件,video-视频,link-链接,必填 | text |
| └text | string | 否 | 文本消息内容;contentType=text 时必填,最长 5000 个字符 | 您好,618大促开始了! |
| └title | string | 否 | 标题;contentType=file 时必填,最长 100 个字符;使用小 U 助手发送 contentType=link 时也必填 | 618大促活动 |
| └fileUrl | string | 否 | 文件 URL;contentType=file 时必填,最长 1000 个字符 | https://example.com/file.pdf |
| └picUrl | string | 否 | 图片 URL;contentType=image 时必填,最长 1000 个字符 | https://example.com/pic.jpg |
| └linkUrl | string | 否 | 链接 URL;contentType=link 时必填,最长 1000 个字符 | https://example.com/activity |
| └desc | string | 否 | 描述;contentType=link 时必填 | 点击查看618活动详情 |
| └videoUrl | string | 否 | 视频 URL;contentType=video 时必填,最长 1000 个字符 | https://example.com/video.mp4 |
| └videoIndexUrl | string | 否 | 视频封面 URL;contentType=video 时必填,最长 1000 个字符 | https://example.com/video_cover.jpg |
| targetIds | string[] | 是 | 目标客户/群 ID 列表,至少 1 个且最多 1000 个,调用企微接口获取。开发文档:企微接口调用开发步骤 单聊:发送对象为企微 external_userid 集合 参考文档:获取客户信息 群聊:发送对象为群 chat_id 参考文档:获取客户群信息 | ["wmxxxx001","wmxxxx002"] |
| priority | int32 | 否 | 优先级,范围 1-9,数字越小优先级越高;不传时使用默认值 9 | 5 |
| retryCount | int32 | 否 | 自定义重试次数,范围 0-5;不传时使用原有重试策略,传入后优先于原有重试策略 | 3 |
| retryInterval | int32 | 否 | 自定义重试间隔(秒),范围 1-600;仅在 retryCount 传入时生效。只传 retryInterval 时会被忽略,传 retryCount 未传 retryInterval 时默认使用 300 秒 | 60 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | string | 提示信息 | success |
| data | object | 创建企微群发任务响应数据 | |
| └taskId | string | 创建的任务 ID | 12345 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体 JSON 格式错误;没有可用账号;无权限 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/wxwork/createWxworkMsgTaskcurl -X POST "https://qiyukf.com/openapi/wxwork/createWxworkMsgTask?appKey=string&time=0&checksum=string" \ -H "Content-Type: application/json" \ -d '{ "requestId": "req_20240601_001", "sendUserId": "zhangsan", "taskType": 1, "contents": [ { "contentType": "text" } ], "targetIds": [ "wmxxxx001", "wmxxxx002" ] }'{
"code": 200,
"message": "success",
"data": {
"taskId": "12345"
}
}{
"code": 14001,
"message": "AppKey 不存在"
}{
"code": 14002,
"message": "checksum 校验失败"
}{
"code": 14003,
"message": "请求时间戳与服务器时间误差超过 10 分钟"
}{
"code": 14004,
"message": "请求体 JSON 格式错误;没有可用账号;无权限"
}{
"code": 14500,
"message": "服务内部异常"
}这篇文档有帮助吗?