# 在朋友圈分享视频号(平台号)
[异步回调]发送朋友圈
说明:因企业微信朋友圈的呈现目前是依托于微信客户端,所以朋友圈发送完成后会有2次回调。
先接收到推送至企业微信服务端成功的回调(回调码:401001),再接受到推送至微信客户端成功的回调(回调码:401002)。
当接收到第二条回调,才代表推送至客户的微信端成功了,因此企业微信发送后会生成2个编号,执行朋友圈相关操作需传入2个朋友圈编号。平台号“无客户联系使用权限,联系管理员开通”无法发送朋友圈。且遵循微信规则“每位客户的朋友圈每天最多可展示3条你发表的内容”。
请求方式:POST
请求地址:https://$basehost/gateway/qopen/ShareChannelMessageInMoments
body参数:
{
"robot_id": "机器人id",
"allowed_type": 1,
"contact_id_list": ["若可见的客户选择部分可见,则需传入可见的好友编号"],
"channel_type": 1,
"content": "朋友圈文字内容",
"msg_content": "消息回调的msg_content 如:接收客户私聊消息-40023的msg_content",
"msg_serial_no": "消息回调的msg_serial_no 如:接收客户私聊消息-40023的msg_serial_no"
}
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
robot_id | string | 是 | 机器人id |
allowed_type | int | 是 | 可见的客户: 1 全部可见 2 部分可见 |
contact_id_list | array | 否 | 若可见的客户选择部分可见,则需传入可见的好友编号 |
channel_type | int | 是 | 朋友圈类型 1. 普通视频号 2.视频号直播 |
content | string | 否 | 朋友圈文字内容 |
msg_content | string | 否 | 消息回调的msg_content 如:接收客户私聊消息-40023的msg_content |
msg_serial_no | string | 是 | 消息回调的msg_serial_no 如:接收客户私聊消息-40023的msg_serial_no |
接口返回值:
{
"data": {
"serial_no": "请求序列号"
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
字段 | 类型 | 说明 |
---|---|---|
errcode | int | 状态码,0为正常,非0代表错误 |
errmsg | string | 错误信息 |
data | json | json返回值 |
serial_no | string | 操作序列号 |
hint | string | 请求日志ID |
处理结果,异步返回值:
{
"event_type": 401001,
"err_code": 0,
"err_msg": "",
"serial_no": "请求序列号",
"robot_id": "机器人id",
"data": {
"post_id": "推送至企业微信成功返回的朋友圈id",
"fail_contacts": ["发送失败的客户id"]
}
}
字段 | 类型 | 说明 |
---|---|---|
event_type | int | 事件类型,401001 |
err_code | int | 状态码,0为正常,非0代表错误 |
err_msg | string | 错误信息 |
serial_no | string | 请求序列号 |
robot_id | string | 机器人id |
post_id | string | 推送至企业微信成功返回的朋友圈id |
fail_contacts | array | 发送失败的客户id |
处理结果,异步返回值 2:
{
"event_type": 401002,
"err_code": 0,
"err_msg": "",
"serial_no": "请求序列号",
"robot_id": "机器人id",
"data": {
"post_id": "推送至企业微信成功返回的朋友圈id",
"moment_id": "推送至微信客户端成功的朋友圈id",
"fail_contacts": ["发送失败的客户id"]
}
}
字段 | 类型 | 说明 |
---|---|---|
event_type | int | 事件类型,401002 |
err_code | int | 状态码,0为正常,非0代表错误 |
err_msg | string | 错误信息 |
serial_no | string | 请求序列号 |
robot_id | string | 机器人编号 |
post_id | string | 推送至企业微信成功返回的朋友圈id |
moment_id | string | 推送至微信客户端成功的朋友圈id |
fail_contacts | array | 发送失败的客户编号 |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/PublishMoment \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "机器人id",
"allowed_type": 1,
"contact_id_list": ["若可见的客户选择部分可见,则需传入可见的好友编号"],
"moment_type": 2001,
"content": "朋友圈文字内容",
"medias": [
{
"href": "图片或视频链接",
"video_time": 20
}
]
}'