Domain name for API request: sms.tencentcloudapi.com.
⚠️ Note: individual users cannot use this API to query SMS signatures. For more information, please see Identity Verification Overview. If your account identity is individual, you can log in to the console to query SMS signatures.
- Note: because of the improved security of TencentCloud API 3.0, API authentication is more complicated. We recommend you use the Tencent Cloud SMS service with the SDK.
- You can run this API directly in API 3.0 Explorer, which eliminates the signature calculation steps. After it is executed successfully, API Explorer can automatically generate SDK code samples.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeSmsSignList. |
Version | Yes | String | Common Params. The value used for this API: 2021-01-11. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
SignIdSet.N | Yes | Array of Integer | Signature ID array. Note: the maximum length of the array is 100 by default. |
International | Yes | Integer | Whether it is Global SMS: 0: Mainland China SMS. 1: Global SMS. |
Parameter Name | Type | Description |
---|---|---|
DescribeSignListStatusSet | Array of DescribeSignListStatus | Response for getting signature information |
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. |
POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSmsSignList
<Common request parameters>
{
"International": 0,
"SignIdSet": [
1110,
1111
]
}
{
"Response": {
"RequestId": "f36e4f00-605e-49b1-ad0d-bfaba81c7325",
"DescribeSignListStatusSet": [
{
"SignName": "Tencent Cloud",
"International": 0,
"SignId": 1110,
"ReviewReply": "xxx",
"CreateTime": 1617508800,
"StatusCode": 0
},
{
"SignName": "Tencent Cloud",
"International": 1,
"SignId": 1111,
"ReviewReply": "xxx",
"CreateTime": 1617508801,
"StatusCode": 0
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.FailResolvePacket | Failed to parse the request packet. Usually, this is because that the API specification was not followed. Please see Detailed Explanation of Request Body Parsing Error 1004. |
FailedOperation.JsonParseFail | Failed to parse the request body. |
FailedOperation.NotEnterpriseCertification | Individual users cannot use the APIs related to signatures and templates. You can change your account identity type to enterprise as instructed here. The change will take effect in about one hour. |
FailedOperation.OtherError | Other error. Usually, this is because that the carried parameter is non-compliant. For more information, see the API description. If necessary, you can contact SMS Helper for assistance. |
InternalError.JsonParseFail | Failed to parse the user parameter. You can contact SMS Helper for assistance. |
InternalError.OtherError | Other error. You can contact SMS Helper and provide the failed mobile number for assistance. |
InternalError.RequestTimeException | The request was initiated in an exceptional time. Usually, this is because that the difference between your server time and Tencent Cloud server time exceeds 10 minutes. Please check whether the server time and the time field in the API are correct. |
InternalError.RestApiInterfaceNotExist | This RESTful API does not exist. Please check the RESTful API description. |
InternalError.SendAndRecvFail | The API timed out or SMS packet sending/receiving timed out. You need to check whether your network jitters or contact SMS Helper for assistance. |
InternalError.SigVerificationFail | Backend check of Sig failed. |
InternalError.Timeout | The request to deliver an SMS message timed out. Please see Detailed Explanation of Error 60008. |
InternalError.UnknownError | Unknown error. |
UnauthorizedOperation.RequestIpNotInWhitelist | The requesting IP is not in the allowlist. You have configured the verification of request source IP, but the current requesting IP is not in the configured allowlist. If necessary, you can contact SMS Helper. |
UnauthorizedOperation.RequestPermissionDeny | The request does not have permission. You can contact SMS Helper. |
UnauthorizedOperation.SdkAppIdIsDisabled | This SdkAppId is forbidden to provide services. If necessary, you can contact SMS Helper. |
UnauthorizedOperation.ServiceSuspendDueToArrears | If the service is suspended due to outstanding fees, you can log in to Tencent Cloud to recharge and clear the debt on your own. |
UnsupportedOperation. | The request is not supported. |
Was this page helpful?