调用该接口前提是开启通讯录迁移,收到授权成功通知后可调用。企业注册初始化安装应用后,应用默认可见范围为根部门。如需修改应用可见范围,服务商可以调用该接口设置授权应用的可见范围。该接口只能使用注册完成回调事件或者查询注册状态返回的access_token,调用设置通讯录同步完成后或者access_token超过30分钟失效(即解除通讯录锁定状态)则不能继续调用该接口。
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/agent/set_scope?access_token=ACCESS_TOKEN
请求包体:
{
"agentid":1 ,
"allow_user":["zhansan","lisi"],
"allow_party":[1,2,3],
"allow_tag":[1,2,3]
}
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
access_token | 是 | 查询注册状态接口返回的access_token(跟注册完成回调事件的AccessToken参数一致,请注意与provider_access_token的区别) |
agentid | 是 | 授权方应用id |
allow_user | 否 | 应用可见范围(成员)若未填该字段,则清空可见范围中成员列表 |
allow_party | 否 | 应用可见范围(部门)若未填该字段,则清空可见范围中部门列表 |
allow_tag | 否 | 应用可见范围(标签)若未填该字段,则清空可见范围中标签列表 |
返回结果:
{
"errcode":0,
"errmsg":"ok",
"invaliduser":["zhangshan","lisi"],
"invalidparty":[2,3],
"invalidtag":[2,3]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 错误码 |
errmsg | 错误码对应的描述 |
invaliduser | 非法成员列表 |
invalidparty | 非法部门列表 |
invalidtag | 非法标签列表 |