创建钉工牌电子码

POST

http://127.0.0.1/v1.0/badge/codes/userInstances

新版服务端API（DingTalk OpenAPI）/钉工牌/使用AccessToken调用

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

责任人：未设置

说明

调用本接口，为用户创建钉工牌电子码实例，主要用于访客、会展等临时证场景。
服务地址：api.dingtalk.com

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉工牌基础数据写权限	API Explorer
第三方企业应用	支持	钉工牌基础数据写权限	API Explorer
第三方个人应用	暂不支持	钉工牌基础数据写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	userNotInExtContact	用户不在外部联系人	用户不在外部联系人
400	invalidCodeIdentity	非法的码标识	非法的码标识
400	corpNotOpen	企业未开通指定的码	企业未开通指定的码
400	noAuthority	无权限调用	无权限调用
400	userCodeExist	用户码已存在	用户码已存在
400	userNotExist	用户不存在	用户不存在
400	invalidMobileFormat	手机号格式非法	手机号格式非法
400	notCorpStaff	非企业内部员工	非企业内部员工
400	invalidAvailableTime	有效时间非法	有效时间非法
500	unknownError	未知错误	未知错误

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

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

Body 参数application/json

requestId

string

必需

业务幂等ID，由调用方随机生成。

codeIdentity

string

码标识，取值：

必需

codeValue

string

可选

码值，由调用方生成。

status

string

必需

状态，传入关闭状态需要用户手动开启后才会渲染二维码。

corpId

string

企业corpId。

必需

userCorpRelationType

string

必需

用户和企业的关系类型，用于区分内部员工，外部联系人，无关系普通用户。

userIdentity

string

必需

用户身份标识。取值和userCorpRelationType值有关：

gmtExpired

string

必需

临时码过期时间，格式：yyyy-MM-dd HH:mm:ss。

availableTimes

array [object {2}]

必需

有效时间列表，对于连续时间段，只需传入一个对象即可。
过期时间必须晚于最晚结束时间。

gmtStart

string

必需

开始时间，格式：yyyy-MM-dd HH:mm:ss。例如：2021-10-20 00:00:00。

gmtEnd

string

必需

结束时间，格式：yyyy-MM-dd HH:mm:ss。例如：2021-11-20 00:00:00。

extInfo

object

必需

扩展参数。
以下四个字段必传：示例：

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v1.0/badge/codes/userInstances' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

codeId

string

码ID。

可选

示例

{
  "codeId": "string"
}

更新钉工牌电子码

创建钉工牌电子码

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码