1. 接口描述
接口请求域名: organization.tencentcloudapi.com 。
邀请组织成员
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:InviteOrganizationMember。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
MemberUin | 是 | Integer | 被邀请账号Uin。 示例值:111111111111 |
Name | 是 | String | 成员名称。最大长度为25个字符,支持英文字母、数字、汉字、符号+@、&.[]-:, 示例值:membername |
PolicyType | 是 | String | 关系策略。取值:Financial 示例值:Finical |
PermissionIds.N | 是 | Array of Integer | 成员财务权限ID列表。取值:1-查看账单、2-查看余额、3-资金划拨、4-合并出账、5-开票、6-优惠继承、7-代付费,1、2 默认必须 示例值:[1,2] |
NodeId | 是 | Integer | 成员所属部门的节点ID。可以通过DescribeOrganizationNodes获取 示例值:1001 |
Remark | 否 | String | 备注。 示例值:"" |
IsAllowQuit | 否 | String | 是否允许成员退出。允许:Allow,不允许:Denied。 示例值:Allow |
PayUin | 否 | String | 代付者Uin。成员代付费时需要 示例值:"" |
RelationAuthName | 否 | String | 互信实名主体名称。 示例值:"" |
AuthFile.N | 否 | Array of AuthRelationFile | 互信主体证明文件列表。 示例值:[] |
Tags.N | 否 | Array of Tag | 成员标签列表。最大10个 示例值:[] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 邀请成员
邀请成员
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InviteOrganizationMember
<公共请求参数>
{
"Remark": "",
"MemberUin": 111111111111,
"Name": "member_name",
"NodeId": 1001,
"PermissionIds": [
1,
2
],
"PolicyType": "Financial",
"PayUin": ""
}
输出示例
{
"Response": {
"RequestId": "9be34d82-b614-4010-8cd8-d907b4d303f2"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ApplyExist | 申请已存在。 |
FailedOperation.AuthInfoEmpty | 用户未实名。 |
FailedOperation.AuthInfoNotSame | 企业实名不一样。 |
FailedOperation.AuthNotEnterprise | 用户非企业实名。 |
FailedOperation.CreateBillingPermissionErr | 添加计费权限失败。 |
FailedOperation.ExistOtherOrganizationMemberShared | 存在共享资源给其他组织成员或被其他组织成员共享资源。 |
FailedOperation.GetAccountRegion | 获取账号地域属性错误。 |
FailedOperation.ImportFileIllegal | 上传文件不合法。 |
FailedOperation.InvitationExist | 邀请已存在。 |
FailedOperation.MemberExistInOtherOrganization | 成员已存其他组织中。 |
FailedOperation.MemberNameUsed | 名字已经被使用。 |
FailedOperation.NotSameRegion | 只能邀请同一个站点内的账号。 |
FailedOperation.OperateBillingPermissionErr | 操作计费侧成员权限错误。 |
FailedOperation.OrganizationAuthRelationExist | 实名认证关系已经存在。 |
FailedOperation.OrganizationMemberExist | 成员已存在。 |
FailedOperation.OrganizationMemberNameUsed | 成员名已存在。 |
FailedOperation.OrganizationNodeNotExist | 组织节点不存在。 |
FailedOperation.OrganizationPermissionIllegal | 组织权限不合法。 |
FailedOperation.OrganizationPolicyIllegal | 组织策略不合法。 |
FailedOperation.PayUinIllegal | 代付者不合法。 |
FailedOperation.ReSentInvitation | 重复发送邀请。 |
FailedOperation.TagResourcesError | 打标签异常。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.TagError | 标签值错误。 |
LimitExceeded.InvitationOverLimit | 邀请超过上限。 |
LimitExceeded.OrganizationMemberOverLimit | 成员超过上限。 |
ResourceNotFound.OrganizationNodeNotExist | 组织节点不在。 |
ResourceNotFound.OrganizationNotExist | 企业组织不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.AbnormalFinancialStatusOfAdmin | 代付者财务状态异常,不支持代付费。 |
UnsupportedOperation.AbnormalFinancialStatusOfMember | 成员财务状态异常,不支持代付费。 |
UnsupportedOperation.AddDelegatePayerNotAllow | 不允许添加代付关系。 |
UnsupportedOperation.AddDiscountInheritNotAllow | 不允许添加优惠继承关系。 |
UnsupportedOperation.AgentNotSame | 管理员和成员的经销商不一致。 |
UnsupportedOperation.ExistedAgent | 成员或者代付者存在经销商。 |
UnsupportedOperation.ExistedClient | 成员或者代付者存在经销商子客。 |
UnsupportedOperation.InconsistentUserTypes | 用户类型不一致。 |
UnsupportedOperation.ManagementSystemError | 调用经管系统报错。 |
UnsupportedOperation.MemberAccountArrears | 成员账户欠费。 |
UnsupportedOperation.MemberDiscountInheritExisted | 成员存在优惠继承。 |
UnsupportedOperation.MemberExistAccountLevelDiscountInherit | 成员存在账户级优惠。 |
UnsupportedOperation.MemberHasVoucher | 成员存在代金劵,不支持代付费。 |
UnsupportedOperation.MemberIsAgent | 账号是代理商或代客。 |
UnsupportedOperation.MemberIsNotClient | 成员不是经销子客。 |
UnsupportedOperation.OrderInProgressExisted | 存在在途订单。 |
UnsupportedOperation.OwnerDiscountInheritExisted | 管理员存在优惠继承。 |
UnsupportedOperation.PayerArrearsAndNoCreditAccount | 代付者欠费且未开通信用账户。 |
UnsupportedOperation.PayerExistAccountLevelDiscountInherit | 代付者存在账户级优惠。 |
UnsupportedOperation.SecondaryDistributorSubClientExisted | 存在二级经销商子客,不支持代付费。 |