企业微信API开发笔记
获取应用程序:
(1)提供:corpid(企业id)例如:xxxxxxxxxxxx
(2)提供:secret(应用程序secret)例如:xxxxxxxxxxxxxxxxxxxxxxxx
(3)通过corpid和secret 获取access_token
格式如下地址:
https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=xxxxxxxxxxxx&corpsecret=xxxxxxxxxxxxxxxxxxxxxxxx
返回结果格式如下:
{"errcode":0,
"errmsg":"ok",
"access_token":"VQHDlRYf1JMENrmtZjhc3jmsVnnbhTXZvuJUuYeR3UHI9mtIsrgnOaKOwP48h21NU4Cw11pBDF3pWAJ5uqwQgp75ZMS78HJQXVmmagfCifzT9IbQzSJGlBqNMEYWoCQDVMBQlmomY3q8G7udhZ_WWwsKDNVPfx31DqEyIOvsqfwP9ptQZCkitqqb9Alkmcq89e8RcGLUIMZhu_Qe68u15w",
"expires_in":7200}
获取其中的access_token为VQHDlRYf1JMENrmtZjhc3jmsVnnbhTXZvuJUuYeR3UHI9mtIsrgnOaKOwP48h21NU4Cw11pBDF3pWAJ5uqwQgp75ZMS78HJQXVmmagfCifzT9IbQzSJGlBqNMEYWoCQDVMBQlmomY3q8G7udhZ_WWwsKDNVPfx31DqEyIOvsqfwP9ptQZCkitqqb9Alkmcq89e8RcGLUIMZhu_Qe68u15w
(4)获取部门列表:(首先提供总部门id)例如 id=1
https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=VQHDlRYf1JMENrmtZjhc3jmsVnnbhTXZvuJUuYeR3UHI9mtIsrgnOaKOwP48h21NU4Cw11pBDF3pWAJ5uqwQgp75ZMS78HJQXVmmagfCifzT9IbQzSJGlBqNMEYWoCQDVMBQlmomY3q8G7udhZ_WWwsKDNVPfx31DqEyIOvsqfwP9ptQZCkitqqb9Alkmcq89e8RcGLUIMZhu_Qe68u15w&id=1
返回结果:
{"errcode":0,
"errmsg":"ok",
"department":[{"id":1,"name":"塞北之家","parentid":0,"order":100000000},{"id":2,"name":"测试部门1","parentid":1,"order":100000000},{"id":3,"name":"测试部门2","parentid":1,"order":99999000},{"id":4,"name":"测试部门3",
"parentid":1,
"order":99998000}]}
(5)获取部门成员(首先知道部门id)例如:2 fetch_child表示为是否递归获取子部门下面的成员:1-递归获取,0-只获取本部门
https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=VQHDlRYf1JMENrmtZjhc3jmsVnnbhTXZvuJUuYeR3UHI9mtIsrgnOaKOwP48h21NU4Cw11pBDF3pWAJ5uqwQgp75ZMS78HJQXVmmagfCifzT9IbQzSJGlBqNMEYWoCQDVMBQlmomY3q8G7udhZ_WWwsKDNVPfx31DqEyIOvsqfwP9ptQZCkitqqb9Alkmcq89e8RcGLUIMZhu_Qe68u15w&department_id=2&fetch_child=0
返回结果:
{"errcode":0,
"errmsg":"ok",
"userlist":[{"userid":"XiGang","name":"小刚",
"department":[2]}]}
(6)给用户推送消息(首先知道用户id)
传送参数如下:
{
"touser" : "UserID1|UserID2|UserID3",
"toparty" : "PartyID1|PartyID2",
"totag" : "TagID1 | TagID2",
"msgtype" : "text",
"agentid" : 1,
"text" : {
"content" : "你的快递已到,请携带工卡前往邮件中心领取。\n出发前可查看<a href=\"http://work.weixin.qq.com\">邮件中心视频实况</a>,聪明避开排队。"
},
"safe":0,
"enable_id_trans": 0,
"enable_duplicate_check": 0,
"duplicate_check_interval": 1800
}
touser 否 指定接收消息的成员,成员ID列表(多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为”@all”,则向该企业应用的全部成员发送
toparty 否 指定接收消息的部门,部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为”@all”时忽略本参数
totag 否 指定接收消息的标签,标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为”@all”时忽略本参数
msgtype 是 消息类型,此时固定为:text
agentid 是 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
content 是 消息内容,最长不超过2048个字节,超过将截断(支持id转译)
safe 否 表示是否是保密消息,0表示否,1表示是,默认0
enable_id_trans 否 表示是否开启id转译,0表示否,1表示是,默认0
enable_duplicate_check 否 表示是否开启重复消息检查,0表示否,1表示是,默认0
duplicate_check_interval 否 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时