tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeExtensions

Last updated: 2024-03-27 16:13:29

1. API Description

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

This API is used to query the telephone list information.

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: DescribeExtensions.
Version Yes String Common Params. The value used for this API: 2020-02-10.
Region No String Common Params. This parameter is not required for this API.
SdkAppId Yes Integer TCCC instance application ID.
PageNumber Yes Integer Page number (starting from 0)
ExtensionIds.N No Array of String Filtering extension number list
PageSize No Integer Page size
FuzzingKeyWord No String Fuzzy query field (fuzzy query for extension number, extension name, agent email, and agent name).
IsNeedStatus No Boolean Whether to return the current status of the telephone or not.

3. Output Parameters

Parameter Name Type Description
Total Integer Total query count.
ExtensionList Array of ExtensionInfo Telephone information list.
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 Telephone List Information

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExtensions
<Common Request Parameters>
{
    "PageNumber": 0,
    "PageSize": 35,
    "SdkAppId": 1400264214,
    "ExtensionIds": [
        "1001"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "86a17f0e-bcb3-46bf-ac66-8f165fe52127",
        "Total": 1,
        "ExtensionList": [
            {
                "SdkAppId": 1400000014,
                "FullExtensionId": "1001@140000014.tccc.qcloud.com",
                "ExtensionId": "1001",
                "SkillGroupId": "1532",
                "ExtensionName": "lulu",
                "CreateTime": 0,
                "ModifyTime": 0,
                "Status": 0,
                "Register": false,
                "Relation": "123456",
                "RelationName": "foobar"
            }
        ]
    }
}

5. Developer Resources

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
InternalError.DBError Internal database access failure.
InvalidParameterValue.InstanceNotExist The instance does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy