tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DisableCCCPhoneNumber

Last updated: 2024-09-09 17:57:59

1. API Description

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

This API is used to disable numbers.

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: DisableCCCPhoneNumber.
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.
PhoneNumbers.N Yes Array of String Number list starting with 0086.
Disabled Yes Integer Disable switch: 0 for enable, 1 for disable.
SdkAppId No Integer TCCC instance application ID.

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 Disabling Number

This example shows you how to disable number.

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DisableCCCPhoneNumber
<Common request parameters>
{
    "SdkAppId": 1,
    "PhoneNumbers": [
        "008602112345678"
    ],
    "Disabled": 0
}

Output Example

{
    "Response": {
        "RequestId": "3651cda6-6501-4482-9f4e-8d0c9548a4db"
    }
}

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
FailedOperation.CurStateNotAllowModify The current number status cannot be modified.
InternalError.DBError Internal database access failure.
InvalidParameter.DuplicateAddress Duplicate address.
InvalidParameter.DuplicatePhoneNumber Duplicate number
InvalidParameter.DuplicateSipAccount Duplicate SIP account
InvalidParameter.IllegalAddress Illegal address.
InvalidParameter.IllegalPhoneNumber Illegal number.
InvalidParameter.InvalidAddress Invalid address.
InvalidParameter.InvalidIP Invalid IP information.
InvalidParameter.InvalidPhoneNumber Invalid number
InvalidParameter.InvalidPort Invalid port information.
InvalidParameter.SipAccountPasswordFormat Illegal password. (The length should be no less than 8 digits and must contain upper and lower case letters and numbers.)
InvalidParameter.SipAccountUserFormat Illegal username (only can contain A-Z,a-z, and number)
InvalidParameter.SipTrunkInUsed The SIP channel is still in use.
InvalidParameter.SipTrunkNotFound SIP channel information not found
InvalidParameterValue parameter value is invalid.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy