发信息给企业通讯录好友

[异步回调] 机器人私聊发信息给企业通讯录好友

关联文档:

• 小程序说明
• 消息发送频率限制

通过机器人私聊企业通讯录（企业内部好友）发送消息。

小程序小技能： 获取小程序json文档，可以通过给机器人转发一个小程序，然后会收到小程序的消息内容回调，里面就包含了这个小程序的json文档了（需要base64解码）。

其中，以下为小程序json数据部分参数说明：

① appName：小程序名称 ② appid：小程序的appid ③ pagepath：页面路径 ④ username：小程序原始id ⑤ weappIconUrl：小程序头像图标地址

请求方式：POST

请求地址：https://$basehost/gateway/qopen/SendMessagesToCompanyContact

body参数：

{
    "robot_id": "机器人id",
    "contact_id": "企业通讯录好友id",
    "message_list": [
        {
            "msg_num": 1,
            "msg_type": 1,
            "msg_content": "",
            "voice_time": 0,
            "href": "",
            "title": "",
            "desc": ""
        }
    ]
}

字段	类型	必填	说明
robot_id	string	是	机器人id
contact_id	string	是	企业通讯录好友id

msg_list说明

消息类型

• 点击查看：小程序说明
• 点击查看：消息类型详细说明

消息类型概述

字段	类型	必填	说明
msg_num	int	是	消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type	int	是	消息类型：1 文字；2 图文链接； 3 图片 ；4 视频； 5语音 ；6 文件；7 好友名片；8 小程序；注：普通图片（普通图片是指jpg、png等静态图片格式的 ）大小超过10M将以文件形式发送 ；GIF动图超过5M将以文件形式发送
msg_content	string	否	消息内容，最长20000个字符。文字内容 1.若是图片或者链接则传图片地址[链接的图片不宜过大，建议160x160px，小于10k])； 2.若是语音,则传语音的地址（仅支持silk格式）（示例：http://downsc.chinaz.net/Files/DownLoadsound1/201910/12087.silk）； 3.若是个人名片，则传被分享的好友编号； 4.若是小程序，需是json格式文件，进行base64编码后传入； 5.其中Windows扫码号发送视频消息时，视频封面图必传
voice_time	int	否	语音时长/视频时长，时长单位：秒；必须 传时长且时长要正确，当时长不正确时可能会有很大的封禁风险
href	string	否	当消息为图文链接或视频时，传入链接URL，视频格式限制为mp4且最大时长不可超过30秒； 发送小程序时，此处传入小程序封面图 当消息为文件时，此处传文件的链接地址；
title	string	否	当消息为图文链接时，填写图文链接的标题；当消息为文件时，填写文件名； 当平台号发送小程序时，必须传入小程序标题(扫码号暂不支持)
desc	string	否	当消息为图文链接时，填写图文链接的描述

返回值：

{
    "data": {
        "serial_no": "操作序列号"
    },
    "errcode": 0,
    "errmsg": "",
    "hint": ""
}

返回说明

字段	类型	说明
errcode	int	状态码，0为正常，非0代表错误
errmsg	string	错误信息
data	json	json返回值
serial_no	string	请求序列号
hint	string	请求日志ID

处理结果，异步返回值：

{
    "event_type": 400001,
    "serial_no": "操作序列号",
    "err_code": 0,
    "err_msg": "success",
    "robot_id": "机器人id",
    "data": {
        "msg_num": 1,
        "contact_id": "企业通讯录联系人id",
        "msg_id": "消息id"
    }
}

返回说明

字段	类型	说明
event_type	int	事件类型，400001
serial_no	string	操作序列号
err_code	int	状态码，0为正常，非0代表错误
err_msg	string	错误信息
robot_id	string	机器人id
data	object	返回数据
data.msg_num	int	消息编号(整型,用于区分同一组的消息)
data.contact_id	string	企业通讯录联系人id
data.msg_id	string	消息id

完整请求示例：

curl -X POST \
  https://$basehost/gateway/qopen/SendMessagesToCompanyContact \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
    "robot_id": "机器人id",
    "contact_id": "企业通讯录好友id",
    "message_list": [
        {
            "msg_num": 1,
            "msg_type": 1,
            "msg_content": "",
            "voice_time": 0,
            "href": "",
            "title": "",
            "desc": ""
        }
    ]
}'