Tencent Cloud Organization
- Operation Guide
- Organization Settings
- Department Management
- Member Account Management
- Member Finance Management
- Unified Organization Payment Mode (Pay-on-Behalf)
- Member Access Management
- Service Control Policy
- Resource Management
- Resource Sharing
- Management of Shared Resources by the Sharer
- Additional Operations
- Management of Shared Resources by the Shared User
- Organization Service Management
- Member Audit
- Identity Center Management
- Introduction to Identity Center
- Identity Center Use Cases
- Settings
- SCIM Synchronization
- Examples of SCIM Synchronization
- Examples of Synchronization from OneLogin via SCIM
- SSO Login
- Manage Permission Configuration
- Manage Multi-account Authorization
- Manage CAM User Synchronization
- API Documentation
- Making API Requests
- Organization Settings APIs
- Department and Member Management APIs
- ListOrganizationIdentity
- Unified Member Login APIs
- Organization Service Management APIs
- Resource Sharing APIs
- Identity Center Management APIs
- Identity Center User Management APIs
- Identity Center User Group Management APIs
- Identity Center Management SCIM Synchronization APIs
- Identity Center Single Sign-On Management APIs
- Identity Center Permission Configuration Management APIs
- Identity Center Multi-Account Authorization Management APIs
- Identity Center Sub-User Synchronization Management APIs
- TCO API 2018-12-25
- Making API Requests
- Read APIs
- Write APIs
- Related Agreement
DocumentationTencent Cloud OrganizationAPI DocumentationDepartment and Member Management APIsDescribeOrganizationMemberEmailBind
DescribeOrganizationMemberEmailBind
Last updated: 2025-03-06 17:08:35
1. API Description
Domain name for API request: organization.intl.tencentcloudapi.com.
This API is used to query detailed information about member mailbox binding.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: DescribeOrganizationMemberEmailBind. |
| 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 | Member uin. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| BindId | Integer | Bound ID. |
| ApplyTime | String | Application time. |
| String | Email address. | |
| Phone | String | Verification mobile number. |
| BindStatus | String | Binding status: unbound indicates not bound; valid indicates to be activated; success indicates bound successfully; failed indicates binding failed. |
| BindTime | String | Binding time. |
| Description | String | Failure description. |
| PhoneBind | Integer | Verification mobile number binding status. 0 indicates unbound and 1 indicates bound. |
| CountryCode | String | International area code. |
| 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. |
4. Example
Example1 Querying Detailed Information About Member Mailbox Binding
Input Example
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationMemberEmailBind
<Common request parameters>
{
"MemberUin": 123
}
Output Example
{
"Response": {
"RequestId": "b46d2afe-6893-4529-bc96-2c82d9214957",
"BindId": 1,
"ApplyTime": "2022-01-13 12:09:08",
"Email": "123@qq.com",
"Phone": "18***32",
"BindStatus": "Success",
"BindTime": "2022-01-13 18:09:08",
"Description": "success",
"PhoneBind": 0,
"CountryCode": "86"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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.AccountAlreadyRegister | The account has been registered. |
| FailedOperation.BindEmailLinkExpired | The mailbox binding link has expired. |
| FailedOperation.BindEmailLinkInvalid | The mailbox binding link is invalid. |
| FailedOperation.EmailAlreadyUsed | The email has been used. |
| FailedOperation.EmailBindRecordInvalid | Mailbox binding has become invalid. |
| FailedOperation.MemberBindEmailError | Mailbox binding failed. |
| FailedOperation.MemberBindPhoneError | Verification mobile numbe binding failed. |
| InternalError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.CodeError | Incorrect mobile phone verification code. |
| InvalidParameter.CodeExpired | The mobile phone verification code has expired. |
| InvalidParameter.InvalidEmail | The mailbox is invalid. |
| InvalidParameter.PasswordIllegal | The password is invalid. |
| ResourceNotFound.OrganizationMemberNotExist | The organization member does not exist. |
| ResourceNotFound.OrganizationNotExist | The organization does not exist. |
| ResourceNotFound.UserNotExist | The user does not exist. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No