设置授权应用可见范围

POST

http://127.0.0.1/cgi-bin/agent/set_scope

智慧硬件开发/推广二维码/调用接口

最后修改时间：2022-08-30 03:03:36

责任人：未设置

调用该接口前提是开启通讯录迁移，收到授权成功通知后可调用。企业注册初始化安装应用后，应用默认可见范围为根部门。如需修改应用可见范围，服务商可以调用该接口设置授权应用的可见范围。该接口只能使用注册完成回调事件或者查询注册状态返回的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 参数

access_token

string

必需

查询注册状态接口返回的access_token（跟注册完成回调事件的AccessToken参数一致，请注意与provider_access_token的区别）

示例值:

Body 参数application/json

agentid

integer <int32>

授权方应用id

必需

allow_tag

array[integer <int32>]

可选

应用可见范围（标签）若未填该字段，则清空可见范围中标签列表

allow_user

array[string]

可选

应用可见范围（成员）若未填该字段，则清空可见范围中成员列表

allow_party

array[integer <int32>]

可选

应用可见范围（部门）若未填该字段，则清空可见范围中部门列表

示例

{
  "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 'http://127.0.0.1/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

integer <int32>

错误码

可选

invalidtag

array[integer <int32>]

非法标签列表

可选

errmsg

string

错误码对应的描述

可选

invalidparty

array[integer <int32>]

非法部门列表

可选

invaliduser

array[string]

非法成员列表

可选

示例

{
  "errcode": 0,
  "invalidtag": [
    0
  ],
  "errmsg": "string",
  "invalidparty": [
    0
  ],
  "invaliduser": [
    "string"
  ]
}

修改于 2022-08-30 03:03:36

查询注册状态

设置通讯录同步完成