设置授权应用可见范围

POST

/cgi-bin/agent/set_scope

调用该接口前提是开启通讯录迁移，收到授权成功通知后可调用。企业注册初始化安装应用后，应用默认可见范围为根部门。如需修改应用可见范围，服务商可以调用该接口设置授权应用的可见范围。该接口只能使用注册完成回调事件或者查询注册状态返回的access_token，调用设置通讯录同步完成后或者access_token超过30分钟失效（即解除通讯录锁定状态）则不能继续调用该接口。
文档ID: 14936
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/90583
https://open.work.weixin.qq.com/api/doc/90002/90151/90807

请求参数

Query 参数

Body 参数application/json

示例

{"agentid":1,"allow_user":["zhansan","lisi"],"allow_party":[1,2,3],"allow_tag":[1,2,3]}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/cgi-bin/agent/set_scope?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{"agentid":1,"allow_user":["zhansan","lisi"],"allow_party":[1,2,3],"allow_tag":[1,2,3]}'

返回响应

🟢200成功

application/json

Body

示例

{
    "errcode": 0,
    "errmsg": "ok",
    "invaliduser": [
        "zhangshan",
        "lisi"
    ],
    "invalidparty": [
        2,
        3
    ],
    "invalidtag": [
        2,
        3
    ]
}

修改于 2025-03-26 09:11:31

查询注册状态

设置通讯录同步完成