获取第三方企业应用的suiteAccessToken

POST

http://127.0.0.1/v1.0/oauth2/suiteAccessToken

新版服务端API（DingTalk OpenAPI）/获取访问凭证/获取应用身份相关访问凭证

最后修改时间：2022-08-30 09:19:23

责任人：未设置

说明

调用本接口获取第三方企业应用的suiteAccessToken。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

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

错误码

HttpCode	错误码	错误信息	说明
400	invalidSuiteTicket	suiteTicket无效	suiteTicket无效
400	invalidClientIdOrSecret	clientId或者clientSecret错误	clientId或者clientSecret错误

请求参数

Body 参数application/json

suiteKey

string

必需

已创建的第三方企业应用的SuiteKey。

suiteSecret

string

必需

已创建的第三方企业应用的SuiteSecret。

suiteTicket

string

必需

钉钉开放平台会向应用的回调URL推送的suite_ticket（约5个小时推送一次），详细内容请参考推送suite_ticket事件。

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v1.0/oauth2/suiteAccessToken' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

accessToken

string

可选

第三方企业应用的凭证。

expireIn

integer

可选

第三方企业应用的凭证过期时间，单位秒。suiteAccessToken有效期为7200秒，过期之前建议服务端做定时器主动更新，而不是依赖钉钉的定时推送。

示例

{
  "accessToken": "string",
  "expireIn": 0
}

获取第三方应用授权企业的accessToken

获取第三方企业应用的suiteAccessToken

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码