ListOrganizationInvitations

Last updated: 2020-01-13 17:12:51

    1. API Description

    Domain name for API request: organization.tencentcloudapi.com.

    This API is used to obtain an invitation list.

    A maximum of 20 requests can be initiated per second for this API.

    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 parameter. The value used for this API: ListOrganizationInvitations
    Version Yes String Common parameter. The value used for this API: 2018-12-25
    Region No String Common parameter. This parameter is not required for this API.
    Invited Yes Integer Whether to list the invitations you received or the invitations you sent. 1: list the invitations you received; 0: list the invitations you sent.
    Offset No Integer Offset
    Limit No Integer Limit

    3. Output Parameters

    Parameter Name Type Description
    Invitations Array of OrgInvitation List of invitations
    TotalCount Integer Total number of results
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining an invitation list

    Input Example

    https://organization.tencentcloudapi.com/?Action=ListOrganizationInvitations
    &Invited=1
    &Offset=0
    &Limit=10
    &<Common Request Parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 0,
        "Invitations": [
          {
            "Id": 1,
            "Uin": 1,
            "HostUin": 1,
            "HostName": "aa",
            "HostMail": "aa@qq.com",
            "Status": 1,
            "Name": "aa",
            "Remark": "",
            "OrgType": 1,
            "InviteTime": "2019-10-10 00:00:00",
            "ExpireTime": "2019-10-10 00:00:00"
          }
        ],
        "RequestId": "97fd9345-cfd6-4b93-8205-e25d21ecd26e"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    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
    ResourceNotFound.UserNotExist The user does not exist.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help