获取企业授权信息

说明

产品方案商为企业开发企业内部应用时调用本接口获取企业授权信息。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保对应用已经添加了接口权限。

应用类型	是否可调用	权限申请方式	API Explorer调试
企业内部应用	是（委托产品方案商开发时使用）	无需申请	调试
第三方企业应用	是	无需申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

accessKey

string

必需

第三方企业应用的SuiteKey，可在开发者后台的应用详情页获取。定制应用的CustomKey，可在开发者后台的应用详情页获取。

示例值:

6ed1bxxxx

timestamp

string

必需

当前时间戳，单位毫秒。

示例值:

1598359962000

suiteTicket

string

必需

第三方企业应用，使用钉钉推送的suiteTicket。定制应用，可指定任意值。

示例值:

test

signature

string

必需

签名。签名计算方式请参考第三方访问接口的签名计算方法。计算出签名以后，需要进行urlencode，才能把签名参数拼接到url中。

示例值:

xxx

Body 参数application/json

suite_key

string

可选

第三方应用的Suitekey。可在开发者后台的第三方应用详情页面获取。

auth_corpid

string

必需

授权方的CorpId。可在开发者后台首页获取。

示例

{
  "auth_corpid": "ding1234",
  "suite_key": "suitefcurkdvkc1xxxx"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

auth_info

object

授权信息。

可选

agent

array [object {5}]

授权的应用信息。

可选

auth_user_info

object

授权方管理员信息。

可选

userId

string

可选

管理员的userid。

auth_corp_info

object

授权方企业信息。

可选

corpid

string

可选

授权企业的CorpId。

invite_code

string

可选

邀请码，只有自己邀请的企业才会返回邀请码，可用该邀请码统计不同渠道的拉新，否则值为空字符串。

industry

string

企业所属行业。

可选

corp_name

string

授权方企业名称。

可选

license_code

string

序列号。

可选

auth_channel

string

渠道码。

可选

auth_channel_type

string

可选

渠道类型。为了避免渠道码重复，可与渠道码共同确认渠道。可能为空，非空时当前只有满天星类型，值为STAR_ACTIVITY。

is_authenticated

boolean

企业是否认证。

可选

auth_level

number

可选

企业认证等级：0：未认证1：高级认证2：中级认证3：初级认证

invite_url

string

企业邀请链接。

可选

corp_logo_url

string

企业logo。

可选

errmsg

string

返回码描述。

可选

errcode

number

返回码。

可选

channel_auth_info

object

可选

授权的服务窗应用信息列表。

channelAgent

array [object {4}]

授权方应用名字。

可选

示例

{
  "auth_info": {
    "agent": [
      {
        "agentid": 0,
        "logo_url": "string",
        "appid": 0,
        "admin_list": [
          "string"
        ],
        "agent_name": "string"
      }
    ]
  },
  "auth_user_info": {
    "userId": "string"
  },
  "auth_corp_info": {
    "corpid": "string",
    "invite_code": "string",
    "industry": "string",
    "corp_name": "string",
    "license_code": "string",
    "auth_channel": "string",
    "auth_channel_type": "string",
    "is_authenticated": true,
    "auth_level": 0,
    "invite_url": "string",
    "corp_logo_url": "string"
  },
  "errmsg": "string",
  "errcode": 0,
  "channel_auth_info": {
    "channelAgent": [
      {
        "agent_name": "string",
        "agentid": 0,
        "logo_url": "string",
        "appid": 0
      }
    ]
  }
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限