获取授权应用的基本信息

说明

调用本接口获取已授权开通的企业的指定应用的基本信息包括LOGO、名称、描述等。
服务地址：https://oapi.dingtalk.com

权限

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

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	否	—	—
第三方企业应用	是	无需申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

suite_access_token

string

必需

第三方企业应用的suite_access_token，可通过获取第三方应用的suite_access_token接口获取。

示例值:

68fbxxxx

timestamp

string

必需

当前时间戳, 单位毫秒。使用SDK调用时，不需要传递此参数。

示例值:

1598359962000

suiteTicket

string

必需

钉钉开放平台向应用的回调URL推送的suite_ticket，详细内容请参考推送suite_ticket事件。

示例值:

test

signature

string

必需

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

示例值:

xxxx

Body 参数application/json

agentid

string

必需

授权企业方应用ID。

auth_corpid

string

必需

授权企业的CorpId，可在企业授权开通应用事件中获取。

suite_key

string

必需

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

示例

{
  "agentid": "852381775",
  "auth_corpid": "ding1234",
  "suite_key": "suitezx8sttxxx"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

agentid

number

企业应用ID。

可选

name

string

企业应用名称。

可选

logo_url

string

企业应用头像。

可选

description

string

企业应用描述。

可选

number

可选

授权方企业应用是否被禁用：0：禁用1：正常 2：待激活

errmsg

string

返回码描述。

可选

errcode

number

返回码。

可选

示例

{
  "agentid": 0,
  "name": "string",
  "logo_url": "string",
  "description": "string",
  "close": 0,
  "errmsg": "string",
  "errcode": 0
}

获取授权应用的基本信息

说明#

权限#

请求参数

示例代码

返回响应

说明

权限