tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeStaffInfoList

Last updated: 2024-09-09 17:58:09

1. API Description

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

This API is used to access the agent information list.

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: DescribeStaffInfoList.
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 Application ID (required) can be found at https://console.tencentcloud.com/ccc.
PageSize Yes Integer Page size, upper limit 9,999
PageNumber Yes Integer Page number starting from 0.
StaffMail No String Agent account used when querying a single agent.
ModifiedTime No Integer Use when querying for agents with a modification time greater or equal to ModifiedTime.
SkillGroupId No Integer Skill group ID.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of agent users.
StaffList Array of StaffInfo Agent user 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 This example shows you how to access agent list.

This example shows you how to access agent list.

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStaffInfoList
<Common request parameters>

{
    "ModifiedTime": 1590147606,
    "PageSize": 10,
    "PageNumber": 0,
    "StaffMail": ""121223@qq.com"",
    "SdkAppId": "1400000000"
}

Output Example

{
    "Response": {
        "RequestId": "5ac74e13-ef15-41a6-9639-f1bc8c9896bd",
        "TotalCount": 602,
        "StaffList": [
            {
                "Name": "xiao",
                "Mail": "1000273@qq.com",
                "Phone": "008617636049517",
                "Nick": "Test 3",
                "StaffNumber": "125",
                "RoleId": 1,
                "SkillGroupList": [
                    {
                        "SkillGroupId": 53,
                        "SkillGroupName": "ALL-dingoding-Test",
                        "Priority": 3,
                        "Type": "ALL"
                    },
                    {
                        "SkillGroupId": 82,
                        "SkillGroupName": "uu",
                        "Priority": 1,
                        "Type": "IM"
                    }
                ],
                "LastModifyTimestamp": 1613988825
            }
        ]
    }
}

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 An internal error occurs.
InvalidParameter.InstanceNotExist The instance does not exist.
InvalidParameterValue parameter value is invalid.
InvalidParameterValue.InstanceNotExist The instance does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy