解析钉工牌电子码

说明

调用本接口解析钉工牌电子码，获取关联的企业、用户userid等信息，在获取用户信息之后，即可进行身份验证。
服务地址：api.dingtalk.com

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	暂不支持	钉钉付款码信息读权限	暂不支持
第三方企业应用	支持	钉钉付款码信息读权限	API Explorer
第三方个人应用	暂不支持	钉钉付款码信息读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	expiredPayCode	码已过期	码已过期
400	invalidParameter	请求对象为空	请求对象为空
400	invalidParameter	无效请求参数	无效请求参数
400	invalidParameter	存在空参数	存在空参数
400	missingParameter	缺少必填参数	缺少必填参数
400	invalidPayCode	无效的付款码	无效的付款码
400	dataNotConsist	数据不一致	数据不一致
400	moneyNotConsist	金额不一致	金额不一致
500	unknownError	未知错误	未知错误
500	callAlipayFail	调用支付宝异常	调用支付宝异常
500	callOrgFail	调用内部通讯录异常	调用内部通讯录异常
500	accessStorageFail	调用存储异常	调用存储异常

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

payCode

string

可选

付款码，硬件设置扫面获取码值。
解码接口仅支持钉钉侧生成的码值。目前不支持标准码解析，标准码是由支付宝生成的。

requestId

string

可选

请求ID，幂等号。

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

corpId

string

可选

企业的corpId。

userId

string

可选

员工的userid。

userInCorp

boolean

可选

用户是否还在组织内。

codeType

string

付款码类型，取值。

可选

alipayCode

string

支付宝付款码。

可选

userCorpRelationType

string

可选

用户和企业关系，取值：

示例

{
  "corpId": "string",
  "userId": "string",
  "userInCorp": true,
  "codeType": "string",
  "alipayCode": "string",
  "userCorpRelationType": "string"
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码