选择应用类型
第三方企业应用开发

更新钉工牌电子码新版SDK

更新于 2023-01-18调用本接口,更新用户钉工牌码的相关信息。

调用本接口,可更新钉工牌电子码。接口调用成功后,钉工牌电子码如下图所示。

权限

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

应用类型

是否支持

权限

API Explorer调试

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

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Body参数

名称

类型

是否必填

描述

codeId

String

用户码ID。

codeIdentity

String

码标识,取值:

  • DT_VISITOR:访客码
  • DT_CONFERENCE:会展码

codeValue

String

码值,由调用方生成。

说明

  • 如果是固定码,则此参数必填。
  • 如果是动态码,则此参数不填。

status

String

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

  • OPEN:开启
  • CLOSED:关闭
  • INVALID:失效

corpId

String

企业corpId。可在钉钉开发者后台首页查看。

userCorpRelationType

String

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

  • INTERNAL_STAFF:企业内部员工
  • EXTERNAL_CONTACT:外部联系人
  • NO_RELATION:普通用户与组织无关

userIdentity

String

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

  • 如果是企业内部用户传用户的userId。

  • 如果是外部联系人传外部联系人的userid。

  • 如果是无关系用户需传入用户手机号,手机号需带有国家码,例如86-xxxxxxxxxxx。

gmtExpired

String

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

availableTimes

Array

有效时间列表,对于连续时间段,只需传入一个对象即可。

说明

 过期时间必须晚于最晚结束时间。

gmtStart

String

开始时间,格式:yyyy-MM-dd HH:mm:ss。

gmtEnd

String

结束时间,格式:yyyy-MM-dd HH:mm:ss。

extInfo

Map

扩展参数。 以下四个字段必传:

  • applicantName:申请人名称
  • applyTime:申请时间,格式:yyyy-MM-dd HH:mm:ss
  • visitorName:访客名称
  • visitorMobile:访客手机号

示例:

Loading...

返回参数

名称

类型

描述

codeId

String

码ID。

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

HttpCode

错误码

错误信息

说明

400

invalidCodeIdentity

非法的码标识

非法的码标识

400

codeNotExist

用户码不存在

用户码不存在

400

noAuthority

无权限调用

无权限调用

400

userNotExist

用户不存在

用户不存在

400

invalidMobileFormat

手机号格式非法

手机号格式非法

400

notCorpStaff

非企业员工

非企业员工

400

invalidAvailableTime

有效时间非法

有效时间非法

500

unknownError

未知错误

未知错误

点击纠错