获取企业邀请信息

说明

调用本接口获取企业的邀请信息。
服务地址：api.dingtalk.com

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	通讯录基本数据读权限	API Explorer
第三方企业应用	支持	通讯录基本数据读权限	API Explorer
第三方个人应用	暂不支持	通讯录基本数据读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter.param.empty	参数为空	参数为空
400	invalidParameter.param.orgIdInvalid	企业不存在或者已经解散	企业不存在或者已经解散
500	invalid.system.errror	系统错误	系统错误

请求参数

Query 参数

inviterUserId

string

可选

邀请者的userid。

deptId

string

可选

获取部门邀请链接的部门ID。

Header 参数

x-acs-dingtalk-access-token

string

必需

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

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

inviteSwitch

boolean

是否开启邀请。

可选

searchNameInvite

boolean

可选

是否开启通过企业名称搜索申请。

orgApplyCodeInvite

boolean

可选

是否开启通过团队号申请加入。

linkInvite

boolean

可选

是否开启通过链接邀请加入。

inviteUrl

string

邀请链接。

可选

auditType

integer

可选

审核类型。
仅部门邀请有效。

empApplyJoinDept

boolean

可选

是否允许员工扫码加入部门。
仅在无需审核的时候有效，已经在组织内的成员通过扫描部门二维码加入某个部门。

示例

{
    "inviteSwitch": true,
    "searchNameInvite": true,
    "orgApplyCodeInvite": true,
    "linkInvite": true,
    "inviteUrl": "string",
    "auditType": 0,
    "empApplyJoinDept": true
}

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码