产品概述
相关概念
Domain name for API request: organization.intl.tencentcloudapi.com.
This API is used to invite a member.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: InviteOrganizationMember. |
| Version | Yes | String | Common Params. The value used for this API: 2021-03-31. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| MemberUin | Yes | Integer | UIN of an invited account. |
| Name | Yes | String | Member name, which contains up to 25 characters, including English letters, digits, and symbols +@&._[]-:,. |
| PolicyType | Yes | String | Relationship policy. Valid value: Financial. |
| PermissionIds.N | Yes | Array of Integer | List of member financial permission ids. valid values: 1: view bills. 2: view balance. 3: transfer funds (contact your business manager to enable internal fund transfer permission if required). 4: consolidate bills. 5: issue invoice. 6: inherit discounts. 7: pay on behalf. 8: analyze costs. 9: manage budget. 10: set credit limit (contact your business manager to enable internal credit limit setting privilege if required). 1 and 2 are required by default. |
| NodeId | Yes | Integer | Node ID of the member's department, which can be obtained through DescribeOrganizationNodes. |
| Remark | No | String | Remarks. |
| IsAllowQuit | No | String | Whether to allow a member to exit. Valid values: Allow, Denied. |
| PayUin | No | String | Payer UIN, which is required when pay-on-behalf mode is used. |
| RelationAuthName | No | String | Name of a mutual trust real-name entity. |
| AuthFile.N | No | Array of AuthRelationFile | List of proof files of a mutual trust entity. |
| Tags.N | No | Array of Tag | Member tag list, with a maximum of 10. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to invite a member.
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InviteOrganizationMember
<Common request parameters>
{
"Remark": "invitation member",
"MemberUin": 111111111111,
"Name": "member_name",
"NodeId": 1001,
"PermissionIds": [
1,
2
],
"PolicyType": "Financial",
"PayUin": "100000000001"
}
{
"Response": {
"RequestId": "9be34d82-b614-4010-8cd8-d907b4d303f2"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.ApplyExist | The application already exists. |
| FailedOperation.AuthInfoEmpty | The user has not completed identity verification. |
| FailedOperation.AuthInfoNotSame | Enterprise real name mismatch. |
| FailedOperation.AuthNotEnterprise | The user has not completed enterprise identity verification. |
| FailedOperation.CreateBillingPermissionErr | Failed to create the billing permission |
| FailedOperation.ExistOtherOrganizationMemberShared | There are shared resources with other organization members or from other organization members. |
| FailedOperation.GetAccountRegion | Errors occurred when account's regional attributes are obtained. |
| FailedOperation.ImportFileIllegal | The uploaded file is invalid. |
| FailedOperation.InvitationExist | The invitation already exists. |
| FailedOperation.MemberExistInOtherOrganization | The member already belongs to another organization. |
| FailedOperation.MemberNameUsed | The name is already in use. |
| FailedOperation.NotSameRegion | You can only invite accounts within the same site. |
| FailedOperation.OperateBillingPermissionErr | An error occurred while manipulating the billing member permission. |
| FailedOperation.OrganizationAuthRelationExist | Real-name authentication relationship already exists. |
| FailedOperation.OrganizationMemberExist | Member already exists. |
| FailedOperation.OrganizationMemberNameUsed | The member name already exists. |
| FailedOperation.OrganizationNodeNotExist | The organization node does not exist. |
| FailedOperation.OrganizationPermissionIllegal | The organization permission is invalid. |
| FailedOperation.OrganizationPolicyIllegal | The organization policy is invalid. |
| FailedOperation.PayUinIllegal | The payer is invalid. |
| FailedOperation.ReSentInvitation | The invitation has already been sent before. |
| FailedOperation.TagResourcesError | Tagging error. |
| InternalError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.TagError | Tag value error. |
| LimitExceeded.InvitationOverLimit | Invitation limit exceeded. |
| LimitExceeded.OrganizationMemberOverLimit | The number of members exceeds the upper limit. |
| ResourceNotFound.OrganizationNodeNotExist | The organization node does not exist. |
| ResourceNotFound.OrganizationNotExist | The organization does not exist. |
| UnsupportedOperation | The operation is not supported. |
| UnsupportedOperation.AbnormalFinancialStatusOfAdmin | The payer has a financial status exception and does not support pay-on-behalf. |
| UnsupportedOperation.AbnormalFinancialStatusOfMember | Member's financial status is abnormal. Pay-on-behalf mode is not supported. |
| UnsupportedOperation.AddDelegatePayerNotAllow | No paying relationships can be added. |
| UnsupportedOperation.AddDiscountInheritNotAllow | No offer inheritance relationships can be added. |
| UnsupportedOperation.AgentNotSame | The resellers of the administrator and the member do not match. |
| UnsupportedOperation.ExistedAgent | Payment-on-behalf is not supported for this member or payer as it is a reseller. |
| UnsupportedOperation.ExistedClient | Payment-on-behalf is not supported for this member or payer as it is a reseller’s account. |
| UnsupportedOperation.InconsistentUserTypes | The user type mismatches. |
| UnsupportedOperation.ManagementSystemError | An error occurred while calling the operations management system. |
| UnsupportedOperation.MemberAccountArrears | The member account has an overdue payment. |
| UnsupportedOperation.MemberDiscountInheritExisted | The member has an inherited offer. |
| UnsupportedOperation.MemberExistAccountLevelDiscountInherit | The member has an account-level offer. |
| UnsupportedOperation.MemberHasVoucher | The member has vouchers. Pay-on-behalf mode is not supported. |
| UnsupportedOperation.MemberIsAgent | The account is an agent or an agent customer. |
| UnsupportedOperation.MemberIsNotClient | The member is not a reseller customer. |
| UnsupportedOperation.OrderInProgressExisted | There is an ongoing order. |
| UnsupportedOperation.OwnerDiscountInheritExisted | The admin has an inherited offer. |
| UnsupportedOperation.PayerArrearsAndNoCreditAccount | The payer has an overdue payment and has no credit account. |
| UnsupportedOperation.PayerExistAccountLevelDiscountInherit | The payer has an account-level offer. |
| UnsupportedOperation.SecondaryDistributorSubClientExisted | Pay-on-behalf is not supported for second-level reseller customers exist. |
文档反馈