tencent cloud

Feedback

ModifyStaff

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

1. API Description

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

This API is used to modify customer service / agent account.

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: ModifyStaff.
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
Email Yes String Agent account.
Name No String Agent name.
Phone No String Agent phone number (preceded by 0086, example: 008618011111111).
Nick No String Agent nickname.
StaffNo No String Agent ID
SkillGroupIds.N No Array of Integer Bind skill group ID list.
UseMobileCallOut No Boolean Whether the cell phone outbound call switch is enabled or not.
UseMobileAccept No Integer Cell phone answering pattern: 0 - Off | 1 - Only when Offline | 2 - Always.

3. Output Parameters

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.

4. Example

Example1 Modifying Customer Service

This example shows you how to modify customer service.

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyStaff
<Common request parameters>
{
    "Phone": "008618092688910",
    "Email": "xxx@tencent.com",
    "SdkAppId": 1400000000
}

Output Example

{
    "Response": {
        "RequestId": "6bb56a09-2787-40bc-80c5-dc6dab783eff"
    }
}

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.
InternalError.DBError Internal database access failure.
InvalidParameter Parameter error.
InvalidParameterValue.AccountNotExist Account does not exist.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.PhoneNumIsBoundOtherAccount The number has been bound to another account.
InvalidParameterValue.SkillGroupError Skill group error.
OperationDenied.NotInWhiteList Not in the allowlist.