# 客户联系群发助手接口
目前不支持版本2扫码号 （当前企业使用的版本，请与运营沟通获取）
[异步回调] 客户联系群发助手接口
请求方式：POST
请求地址：https://$basehost/gateway/qopen/SendBroadCastMessages
body参数：
{
"robot_id": "机器人id",
"contact_id_list": [
"群发的客户id"
],
"all_type": true,
"content": "群发的文字消息",
"messages": [
{
"msg_num": 1,
"msg_type": 3,
"msg_content": "图片链接",
"voice_time": 0,
"href": "",
"title": "",
"desc": ""
},
{
"msg_num": 3,
"msg_type": 4,
"msg_content": "",
"voice_time": 4,
"href": "视频链接",
"title": "",
"desc": ""
},
{
"msg_num": 4,
"msg_type": 2,
"msg_content": "链接封面图",
"voice_time": 0,
"href": "链接",
"title": "标题",
"desc": "描述"
},
{
"msg_num": 5,
"msg_type": 8,
"msg_content": "小程序base64加密的json",
"voice_time": 0,
"href": "小程序封面图",
"title": "小程序标题",
"desc": ""
}
]
}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| robot_id | string | 是 | 机器人id |
| contact_id_list | array | 否 | 群发的客户id列表,最大支持2000 |
| all_type | bool | 否 | 群发的客户范围是否为全部客户 ：true 是 false否（当不是对全部客户可见时，需传入可见的客户列表） |
| content | string | 否 | 群发的文字消息 |
messages说明
# 消息类型
# 消息类型概述
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| msg_num | int | 是 | 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增 |
| msg_type | int | 是 | 消息类型：1 文字；2 图文链接； 3 图片 ；4 视频； 6 文件；8 小程序；注：群发不支持发送语音及名片消息。普通图片（普通图片是指jpg、png等静态图片格式的 ）大小超过10M将以文件形式发送 ；GIF动图超过5M将以文件形式发送 |
| msg_content | string | 否 | 消息内容，最长20000个字符。文字内容 1.若是图片或者链接则传图片地址[链接的图片不宜过大，建议160x160px，小于10k])； 4.若是小程序，需是json格式文件，进行base64编码后传入； 5.其中Windows扫码号发送视频消息时，视频封面图必传 |
| voice_time | int | 否 | 语音时长/视频时长，时长单位：秒；必须 传时长且时长要正确，当时长不正确时可能会有很大的封禁风险 |
| href | string | 否 | 当消息为图文链接或视频时，传入链接URL，视频格式限制为mp4； 发送小程序时，此处传入小程序封面图 当消息为文件时，此处传文件的链接地址； |
| title | string | 否 | 当消息为图文链接时，填写图文链接的标题；当消息为文件时，填写文件名； 当平台号发送小程序时，必须传入小程序标题(扫码号暂不支持) |
| desc | string | 否 | 当消息为图文链接时，填写图文链接的描述 |
返回值：
{
"data": {
"serial_no": "xxxxxx"
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
返回说明
| 字段 | 类型 | 说明 |
|---|---|---|
| errcode | int | 状态码，0为正常，非0代表错误 |
| errmsg | string | 错误信息 |
| data | json | json返回值 |
| serial_no | string | 请求序列号 |
| hint | string | 请求日志ID |
处理结果，异步返回值：
{
"event_type": 705010,
"serial_no": "操作序列号",
"robot_id": "机器人id",
"err_code": 0,
"err_msg": "success",
"data": {
"contact_id_list": [
"发送成功的客户id"
],
"failed_contact_id_list": [
"发送失败的客户id"
],
"msg_id": "",
"fail_info_list": [
{
"contact_id": "客户id",
"fail_type": 2
}
]
}
}
返回说明
| 字段 | 类型 | 说明 |
|---|---|---|
| event_type | int | 事件类型，705010 |
| serial_no | string | 操作序列号 |
| err_code | int | 状态码，0为正常，非0代表错误 |
| err_msg | string | 错误信息 |
| robot_id | string | 机器人编号 |
| data | string | 返回数据 |
| data.contact_id_list | array | 群发成功的客户列表 |
| data.failed_contact_id_list | array | 群发失败的客户列表 |
| data.msg_id | string | 消息id，可用于【查询单个群发消息客户接收结果】接口查询消息发送状态 |
| data.fail_info_list | json | json返回值 |
| data.fail_info_list.contact_id | string | 客户id |
| data.fail_info_list.fail_type | int | 报错原因, 2:客户已拒收, 3:客户接收已达上限 |
完整请求示例：
curl -X POST \
https://$basehost/gateway/qopen/SendBroadCastMessages \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "机器人id",
"contact_id_list": [
"xxxxxxaaa"
],
"all_type": true,
"content": "文本内容",
"messages": [
{
"msg_num": 1,
"msg_type": 3,
"msg_content": "图片链接",
"voice_time": 0,
"href": "",
"title": "",
"desc": ""
},
{
"msg_num": 3,
"msg_type": 4,
"msg_content": "",
"voice_time": 4,
"href": "视频链接",
"title": "",
"desc": ""
},
{
"msg_num": 4,
"msg_type": 2,
"msg_content": "链接封面图",
"voice_time": 0,
"href": "链接",
"title": "标题",
"desc": "描述"
},
{
"msg_num": 5,
"msg_type": 8,
"msg_content": "小程序base64加密的json",
"voice_time": 0,
"href": "小程序封面图",
"title": "小程序标题",
"desc": ""
}
]
}'