Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

获取通讯录权限范围

获取当前身份的通讯录权限范围,目前仅支持应用身份

请求说明

请求地址https://openapi.wps.cn/v7/contacts/permissions_scope
请求方法GET
签名方式KSO-1
权限要求查询和管理通讯录信息(应用授权) kso.contact.readwrite
查询通讯录信息(应用授权) kso.contact.read

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

查询参数(Query)

名称参数类型是否必填说明
scopesarray[string]权限范围
org:组织架构内;partner:关联组织。目前仅支持查询 org(组织架构范围内)
格式为 scopes={string_1}&scopes={string_2}

请求地址示例

[GET] https://openapi.wps.cn/v7/contacts/permissions_scope?scopes={string_1}&scopes={string_2}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]通讯录权限信息列表
∟ ∟ dept_idsarray[string]部门 id 列表
∟ ∟ permission_typestring[enum]权限类型
visitsearch
目前仅支持返回:visit
∟ ∟ scopestring[enum]权限范围
org:组织架构内;partner:关联组织
目前仅支持返回:org
∟ ∟ user_idsarray[string]用户 id 列表

响应体示例

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "dept_ids": ["string"],
        "permission_type": "string[enum]",
        "scope": "string[enum]",
        "user_ids": ["string"]
      }
    ]
  },
  "msg": "string"
}
回到旧版