Documentation
¶
Index ¶
- Constants
- type AddSignStatus
- type AddSmsSignRequest
- type AddSmsSignResponse
- type AddSmsTemplateRequest
- type AddSmsTemplateResponse
- type AddTemplateStatus
- type CallbackStatusStatistics
- type CallbackStatusStatisticsRequest
- type CallbackStatusStatisticsResponse
- type Client
- func (c *Client) AddSmsSign(request *AddSmsSignRequest) (response *AddSmsSignResponse, err error)
- func (c *Client) AddSmsSignWithContext(ctx context.Context, request *AddSmsSignRequest) (response *AddSmsSignResponse, err error)
- func (c *Client) AddSmsTemplate(request *AddSmsTemplateRequest) (response *AddSmsTemplateResponse, err error)
- func (c *Client) AddSmsTemplateWithContext(ctx context.Context, request *AddSmsTemplateRequest) (response *AddSmsTemplateResponse, err error)
- func (c *Client) CallbackStatusStatistics(request *CallbackStatusStatisticsRequest) (response *CallbackStatusStatisticsResponse, err error)
- func (c *Client) CallbackStatusStatisticsWithContext(ctx context.Context, request *CallbackStatusStatisticsRequest) (response *CallbackStatusStatisticsResponse, err error)
- func (c *Client) DeleteSmsSign(request *DeleteSmsSignRequest) (response *DeleteSmsSignResponse, err error)
- func (c *Client) DeleteSmsSignWithContext(ctx context.Context, request *DeleteSmsSignRequest) (response *DeleteSmsSignResponse, err error)
- func (c *Client) DeleteSmsTemplate(request *DeleteSmsTemplateRequest) (response *DeleteSmsTemplateResponse, err error)
- func (c *Client) DeleteSmsTemplateWithContext(ctx context.Context, request *DeleteSmsTemplateRequest) (response *DeleteSmsTemplateResponse, err error)
- func (c *Client) DescribePhoneNumberInfo(request *DescribePhoneNumberInfoRequest) (response *DescribePhoneNumberInfoResponse, err error)
- func (c *Client) DescribePhoneNumberInfoWithContext(ctx context.Context, request *DescribePhoneNumberInfoRequest) (response *DescribePhoneNumberInfoResponse, err error)
- func (c *Client) DescribeSmsSignList(request *DescribeSmsSignListRequest) (response *DescribeSmsSignListResponse, err error)
- func (c *Client) DescribeSmsSignListWithContext(ctx context.Context, request *DescribeSmsSignListRequest) (response *DescribeSmsSignListResponse, err error)
- func (c *Client) DescribeSmsTemplateList(request *DescribeSmsTemplateListRequest) (response *DescribeSmsTemplateListResponse, err error)
- func (c *Client) DescribeSmsTemplateListWithContext(ctx context.Context, request *DescribeSmsTemplateListRequest) (response *DescribeSmsTemplateListResponse, err error)
- func (c *Client) ModifySmsSign(request *ModifySmsSignRequest) (response *ModifySmsSignResponse, err error)
- func (c *Client) ModifySmsSignWithContext(ctx context.Context, request *ModifySmsSignRequest) (response *ModifySmsSignResponse, err error)
- func (c *Client) ModifySmsTemplate(request *ModifySmsTemplateRequest) (response *ModifySmsTemplateResponse, err error)
- func (c *Client) ModifySmsTemplateWithContext(ctx context.Context, request *ModifySmsTemplateRequest) (response *ModifySmsTemplateResponse, err error)
- func (c *Client) PullSmsReplyStatus(request *PullSmsReplyStatusRequest) (response *PullSmsReplyStatusResponse, err error)
- func (c *Client) PullSmsReplyStatusByPhoneNumber(request *PullSmsReplyStatusByPhoneNumberRequest) (response *PullSmsReplyStatusByPhoneNumberResponse, err error)
- func (c *Client) PullSmsReplyStatusByPhoneNumberWithContext(ctx context.Context, request *PullSmsReplyStatusByPhoneNumberRequest) (response *PullSmsReplyStatusByPhoneNumberResponse, err error)
- func (c *Client) PullSmsReplyStatusWithContext(ctx context.Context, request *PullSmsReplyStatusRequest) (response *PullSmsReplyStatusResponse, err error)
- func (c *Client) PullSmsSendStatus(request *PullSmsSendStatusRequest) (response *PullSmsSendStatusResponse, err error)
- func (c *Client) PullSmsSendStatusByPhoneNumber(request *PullSmsSendStatusByPhoneNumberRequest) (response *PullSmsSendStatusByPhoneNumberResponse, err error)
- func (c *Client) PullSmsSendStatusByPhoneNumberWithContext(ctx context.Context, request *PullSmsSendStatusByPhoneNumberRequest) (response *PullSmsSendStatusByPhoneNumberResponse, err error)
- func (c *Client) PullSmsSendStatusWithContext(ctx context.Context, request *PullSmsSendStatusRequest) (response *PullSmsSendStatusResponse, err error)
- func (c *Client) SendSms(request *SendSmsRequest) (response *SendSmsResponse, err error)
- func (c *Client) SendSmsWithContext(ctx context.Context, request *SendSmsRequest) (response *SendSmsResponse, err error)
- func (c *Client) SendStatusStatistics(request *SendStatusStatisticsRequest) (response *SendStatusStatisticsResponse, err error)
- func (c *Client) SendStatusStatisticsWithContext(ctx context.Context, request *SendStatusStatisticsRequest) (response *SendStatusStatisticsResponse, err error)
- type DeleteSignStatus
- type DeleteSmsSignRequest
- type DeleteSmsSignResponse
- type DeleteSmsTemplateRequest
- type DeleteSmsTemplateResponse
- type DeleteTemplateStatus
- type DescribePhoneNumberInfoRequest
- type DescribePhoneNumberInfoResponse
- type DescribeSignListStatus
- type DescribeSmsSignListRequest
- type DescribeSmsSignListResponse
- type DescribeSmsTemplateListRequest
- type DescribeSmsTemplateListResponse
- type DescribeTemplateListStatus
- type ModifySignStatus
- type ModifySmsSignRequest
- type ModifySmsSignResponse
- type ModifySmsTemplateRequest
- type ModifySmsTemplateResponse
- type ModifyTemplateStatus
- type PhoneNumberInfo
- type PullSmsReplyStatus
- type PullSmsReplyStatusByPhoneNumberRequest
- type PullSmsReplyStatusByPhoneNumberResponse
- type PullSmsReplyStatusRequest
- type PullSmsReplyStatusResponse
- type PullSmsSendStatus
- type PullSmsSendStatusByPhoneNumberRequest
- type PullSmsSendStatusByPhoneNumberResponse
- type PullSmsSendStatusRequest
- type PullSmsSendStatusResponse
- type SendSmsRequest
- type SendSmsResponse
- type SendStatus
- type SendStatusStatistics
- type SendStatusStatisticsRequest
- type SendStatusStatisticsResponse
Constants ¶
View Source
const ( // The SMS message contains sensitive words. You can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. FAILEDOPERATION_CONTAINSENSITIVEWORD = "FailedOperation.ContainSensitiveWord" // 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](https://intl.cloud.tencent.com/document/product/382/9558?from_cn_redirect=1#.E8.BF.94.E5.9B.9E1004.E9.94.99.E8.AF.AF.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F). FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" // Individual users cannot apply for sending marketing SMS messages. FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = "FailedOperation.ForbidAddMarketingTemplates" // The package balance is insufficient. Please [purchase an SMS package](https://buy.cloud.tencent.com/sms). FAILEDOPERATION_INSUFFICIENTBALANCEINSMSPACKAGE = "FailedOperation.InsufficientBalanceInSmsPackage" // Failed to parse the request body. FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" // Marketing SMS messages can only be sent between 8:00 and 22:00 in order not to disturb recipients. FAILEDOPERATION_MARKETINGSENDTIMECONSTRAINT = "FailedOperation.MarketingSendTimeConstraint" // You cannot apply for a template before you apply for a signature. Please create a signature first as instructed in [Creating Signatures](https://intl.cloud.tencent.com/document/product/382/37794?from_cn_redirect=1#.E5.88.9B.E5.BB.BA.E7.AD.BE.E5.90.8D). FAILEDOPERATION_MISSINGSIGNATURE = "FailedOperation.MissingSignature" // Unable to identify the signature. Please check whether the signature has been approved. For more information, see the signature approval section in [Getting Started](https://intl.cloud.tencent.com/document/product/382/37745?from_cn_redirect=1). FAILEDOPERATION_MISSINGSIGNATURELIST = "FailedOperation.MissingSignatureList" // This signature ID has not been submitted for approval or does not exist, so it cannot be modified. Please check whether the `SignId` is entered correctly. FAILEDOPERATION_MISSINGSIGNATURETOMODIFY = "FailedOperation.MissingSignatureToModify" // Unable to identify the template. Please check whether the template has been approved. For more information, see the template approval section in [Getting Started](https://intl.cloud.tencent.com/document/product/382/37745?from_cn_redirect=1). FAILEDOPERATION_MISSINGTEMPLATELIST = "FailedOperation.MissingTemplateList" // This template ID has not been submitted for approval or does not exist, so it cannot be modified. Please check whether the `TemplateId` is entered correctly. FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" // Individual users cannot use the APIs related to signatures and templates. You can change your account identity type to enterprise as instructed [here](https://intl.cloud.tencent.com/document/product/378/34075?from_cn_redirect=1). The change will take effect in about one hour. FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" // 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](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" // Unknown error. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. FAILEDOPERATION_PARAMETERSOTHERERROR = "FailedOperation.ParametersOtherError" // The mobile number is in the blocklist. Usually, this is because that the user unsubscribed or the carrier's blocklist was hit. You can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" // Failed to parse the mobile number. Please check whether it meets the E.164 standard. FAILEDOPERATION_PHONENUMBERPARSEFAIL = "FailedOperation.PhoneNumberParseFail" // Non-Root accounts cannot use the template list pull feature. You can use the TencentCloud API key of your root account to call the API. FAILEDOPERATION_PROHIBITSUBACCOUNTUSE = "FailedOperation.ProhibitSubAccountUse" // The number of signatures has reached the maximum value. FAILEDOPERATION_SIGNNUMBERLIMIT = "FailedOperation.SignNumberLimit" // The signature is not approved or in wrong format. (1) Log in to the [SMS console](https://console.cloud.tencent.com/smsv2) and check whether the signature has been approved; (2) Check whether the signature is in compliance with the format specification, that is, it can contain 2–12 letters and digits. If you have any questions, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. FAILEDOPERATION_SIGNATUREINCORRECTORUNAPPROVED = "FailedOperation.SignatureIncorrectOrUnapproved" // This template has been approved and cannot be modified again. FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = "FailedOperation.TemplateAlreadyPassedCheck" // The template ID or signature ID does not exist. FAILEDOPERATION_TEMPLATEIDNOTEXIST = "FailedOperation.TemplateIdNotExist" // The template is not approved or in wrong format. (1) Log in to the [SMS console](https://console.cloud.tencent.com/smsv2) and check whether the template has been approved; (2) Check whether the template is in compliance with the [format specification](https://intl.cloud.tencent.com/document/product/382/9558?from_cn_redirect=1#.E8.BF.94.E5.9B.9E1014.E9.94.99.E8.AF.AF.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F). If you have any questions, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. FAILEDOPERATION_TEMPLATEINCORRECTORUNAPPROVED = "FailedOperation.TemplateIncorrectOrUnapproved" // The number of templates has reached the maximum value. FAILEDOPERATION_TEMPLATENUMBERLIMIT = "FailedOperation.TemplateNumberLimit" // Failed to parse the user parameter. You can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INTERNALERROR_JSONPARSEFAIL = "InternalError.JsonParseFail" // Other error. You can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) and provide the failed mobile number for assistance. INTERNALERROR_OTHERERROR = "InternalError.OtherError" // 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_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" // This RESTful API does not exist. Please check the RESTful API description. INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" // The API timed out or SMS packet sending/receiving timed out. You need to check whether your network jitters or contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" // The request body in the backend body does not have a `Sig` field or the `Sig` field is empty. INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" // Backend check of `Sig` failed. INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" // The request to deliver an SMS message timed out. Please see [Detailed Explanation of Error 60008](https://intl.cloud.tencent.com/document/product/382/9558?from_cn_redirect=1#.E8.BF.94.E5.9B.9E60008.E9.94.99.E8.AF.AF.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F). INTERNALERROR_TIMEOUT = "InternalError.Timeout" // Unknown error. INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" // A parameter error occurred. INVALIDPARAMETER = "InvalidParameter" // The account does not match the application ID. INVALIDPARAMETER_APPIDANDBIZID = "InvalidParameter.AppidAndBizId" // There are sensitive words. INVALIDPARAMETER_DIRTYWORDFOUND = "InvalidParameter.DirtyWordFound" // Incorrect `International` or `SmsType` parameter. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INVALIDPARAMETER_INVALIDPARAMETERS = "InvalidParameter.InvalidParameters" // `BeginTime` parameter check failed. INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" // The content of the requested SMS message is too long. For message length calculation rule, please see [Mainland China SMS Length Calculation Rule](https://intl.cloud.tencent.com/document/product/382/18058?from_cn_redirect=1). INVALIDPARAMETERVALUE_CONTENTLENGTHLIMIT = "InvalidParameterValue.ContentLengthLimit" // `EndTime` parameter check failed. INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" // The format of the uploaded transcoded image is incorrect. See the description of this field in the API description. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INVALIDPARAMETERVALUE_IMAGEINVALID = "InvalidParameterValue.ImageInvalid" // The format of the mobile number is incorrect, Please see [Detailed Explanation of Error 1016](https://intl.cloud.tencent.com/document/product/382/9558?from_cn_redirect=1#.E8.BF.94.E5.9B.9E1016.E9.94.99.E8.AF.AF.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F). INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" // `DocumentType` field check failed. See the description of this field in the API description. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INVALIDPARAMETERVALUE_INVALIDDOCUMENTTYPE = "InvalidParameterValue.InvalidDocumentType" // `International` field check failed. See the description of this field in the API description. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" // `SignPurpose` field check failed. See the description of this field in the API description. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INVALIDPARAMETERVALUE_INVALIDSIGNPURPOSE = "InvalidParameterValue.InvalidSignPurpose" // Invalid start time or end time. The reason may be that the requested `SendDateTime` is later than `EndDateTime`. INVALIDPARAMETERVALUE_INVALIDSTARTTIME = "InvalidParameterValue.InvalidStartTime" // The template format is incorrect. For more information, please see [Body Template Review Standards](https://intl.cloud.tencent.com/document/product/382/39023?from_cn_redirect=1). INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = "InvalidParameterValue.InvalidTemplateFormat" // `UsedMethod` field check failed. See the description of this field in the API description. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. INVALIDPARAMETERVALUE_INVALIDUSEDMETHOD = "InvalidParameterValue.InvalidUsedMethod" // `Limit` parameter check failed. INVALIDPARAMETERVALUE_LIMITVERIFYFAIL = "InvalidParameterValue.LimitVerifyFail" // `Offset` parameter check failed. INVALIDPARAMETERVALUE_OFFSETVERIFYFAIL = "InvalidParameterValue.OffsetVerifyFail" // URLs are not allowed in template variables. INVALIDPARAMETERVALUE_PROHIBITEDUSEURLINTEMPLATEPARAMETER = "InvalidParameterValue.ProhibitedUseUrlInTemplateParameter" // The `SdkAppId` does not exist. INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" // This signature has been approved and cannot be modified again. INVALIDPARAMETERVALUE_SIGNALREADYPASSEDCHECK = "InvalidParameterValue.SignAlreadyPassedCheck" // The same signature pending review already exists. INVALIDPARAMETERVALUE_SIGNEXISTANDUNAPPROVED = "InvalidParameterValue.SignExistAndUnapproved" // The parameter format of the verification code template is incorrect. For a verification code template, only 0–6 digits can be passed in as the template variable. INVALIDPARAMETERVALUE_TEMPLATEPARAMETERFORMATERROR = "InvalidParameterValue.TemplateParameterFormatError" // There are more than 12 characters in a single template variable. There is no upper limit of variable characters for enterprise users. You can change your account identity type to enterprise as instructed [here](https://intl.cloud.tencent.com/document/product/378/34075?from_cn_redirect=1). The limit change will take effect in about one hour. INVALIDPARAMETERVALUE_TEMPLATEPARAMETERLENGTHLIMIT = "InvalidParameterValue.TemplateParameterLengthLimit" // The template content contains sensitive words. For more information, please see [Body Template Review Standards](https://intl.cloud.tencent.com/document/product/382/39023?from_cn_redirect=1). INVALIDPARAMETERVALUE_TEMPLATEWITHDIRTYWORDS = "InvalidParameterValue.TemplateWithDirtyWords" // The number of SMS messages delivered on the current day exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. LIMITEXCEEDED_APPDAILYLIMIT = "LimitExceeded.AppDailyLimit" // The number of SMS messages delivered on the current day exceeds the set upper limit (for Global SMS). If you want to adjust the limit, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1) for assistance. LIMITEXCEEDED_DAILYLIMIT = "LimitExceeded.DailyLimit" // The SMS delivery hits the delivery rate limit policy. You can adjust the policy in the console. If you have other requirements, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) for assistance. LIMITEXCEEDED_DELIVERYFREQUENCYLIMIT = "LimitExceeded.DeliveryFrequencyLimit" // The number of mobile numbers you query at a time exceeds 200. Please refer to the input parameter `PhoneNumberSet`. LIMITEXCEEDED_PHONENUMBERCOUNTLIMIT = "LimitExceeded.PhoneNumberCountLimit" // The number of SMS messages delivered to a single mobile number on the current day exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. LIMITEXCEEDED_PHONENUMBERDAILYLIMIT = "LimitExceeded.PhoneNumberDailyLimit" // The number of SMS messages delivered to a single mobile number within 1 hour exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. LIMITEXCEEDED_PHONENUMBERONEHOURLIMIT = "LimitExceeded.PhoneNumberOneHourLimit" // The number of identical SMS messages delivered to a single mobile number exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console. LIMITEXCEEDED_PHONENUMBERSAMECONTENTDAILYLIMIT = "LimitExceeded.PhoneNumberSameContentDailyLimit" // The number of SMS messages delivered to a single mobile number within 30 seconds exceeds the set upper limit. You can adjust the SMS delivery rate limit policy in the console LIMITEXCEEDED_PHONENUMBERTHIRTYSECONDLIMIT = "LimitExceeded.PhoneNumberThirtySecondLimit" // Missing parameters. Please check and try again. MISSINGPARAMETER = "MissingParameter" // The list of mobile numbers passed in is empty. Please check whether numbers are present in your parameters. MISSINGPARAMETER_EMPTYPHONENUMBERSET = "MissingParameter.EmptyPhoneNumberSet" // Individual users do not have permission to send marketing SMS messages. Please see [Differences in Rights](https://intl.cloud.tencent.com/document/product/382/13444?from_cn_redirect=1). UNAUTHORIZEDOPERATION_INDIVIDUALUSERMARKETINGSMSPERMISSIONDENY = "UnauthorizedOperation.IndividualUserMarketingSmsPermissionDeny" // 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](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81). UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" // The request does not have permission. You can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81). UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" // This `SdkAppId` is forbidden to provide services. If necessary, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81). UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" // The service has been suspended due to overdue payments. You can log in to Tencent Cloud to make the payments. UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" // Failed to verify `SmsSdkAppId`. Please check whether [SmsSdkAppId](https://console.cloud.tencent.com/smsv2/app-manage) is under the account associated with the [TencentCloud API key](https://console.cloud.tencent.com/cam/capi). UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" // The request is not supported. UNSUPPORTEDOPERATION_ = "UnsupportedOperation." // The group message request contains both Chinese mainland numbers and international numbers. Please check: (1) whether the message is sent to international numbers with a Chinese mainland signature or template; (2) whether the message is sent to Chinese mainland numbers with an international signature or template. UNSUPPORTEDOPERATION_CONTAINDOMESTICANDINTERNATIONALPHONENUMBER = "UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber" // SMS delivery to this region is not supported. UNSUPPORTEDOPERATION_UNSUPORTEDREGION = "UnsupportedOperation.UnsuportedRegion" )
View Source
const APIVersion = "2021-01-11"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddSignStatus ¶
type AddSignStatus struct {
// Signature ID.
SignId *uint64 `json:"SignId,omitempty" name:"SignId"`
}
type AddSmsSignRequest ¶
type AddSmsSignRequest struct {
*tchttp.BaseRequest
// Signature name.
// Note: you cannot apply for an approved or pending signature again.
SignName *string `json:"SignName,omitempty" name:"SignName"`
// Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option:
// 0: company. Valid values of `DocumentType` include 0 and 1.
// 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4.
// 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5.
// 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8.
// 4: trademark. Valid values of `DocumentType` include 7.
// 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3.
// 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6.
// Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.
SignType *uint64 `json:"SignType,omitempty" name:"SignType"`
// Identity certificate type:
// 0: three-in-one licence.
// 1: business license.
// 2: organization code certificate.
// 3: social credit code certificate.
// 4: screenshot of application backend management (for personal app).
// 5: screenshot of website ICP filing backend (for personal website).
// 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program).
// 7: trademark registration certificate.
// 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).
DocumentType *uint64 `json:"DocumentType,omitempty" name:"DocumentType"`
// Whether it is Global SMS:
// 0: Mainland China SMS.
// 1: Global SMS.
International *uint64 `json:"International,omitempty" name:"International"`
// Signature purpose:
// 0: for personal use.
// 1: for others.
SignPurpose *uint64 `json:"SignPurpose,omitempty" name:"SignPurpose"`
// You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
ProofImage *string `json:"ProofImage,omitempty" name:"ProofImage"`
// Power of attorney, which should be submitted if `SignPurpose` is for use by others.
// You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
// Note: this field will take effect only when `SignPurpose` is 1 (for user by others).
CommissionImage *string `json:"CommissionImage,omitempty" name:"CommissionImage"`
// Signature application remarks.
Remark *string `json:"Remark,omitempty" name:"Remark"`
}
func NewAddSmsSignRequest ¶
func NewAddSmsSignRequest() (request *AddSmsSignRequest)
func (*AddSmsSignRequest) FromJsonString ¶
func (r *AddSmsSignRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AddSmsSignRequest) ToJsonString ¶
func (r *AddSmsSignRequest) ToJsonString() string
type AddSmsSignResponse ¶
type AddSmsSignResponse struct {
*tchttp.BaseResponse
Response *struct {
// Signature addition response
AddSignStatus *AddSignStatus `json:"AddSignStatus,omitempty" name:"AddSignStatus"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewAddSmsSignResponse ¶
func NewAddSmsSignResponse() (response *AddSmsSignResponse)
func (*AddSmsSignResponse) FromJsonString ¶
func (r *AddSmsSignResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AddSmsSignResponse) ToJsonString ¶
func (r *AddSmsSignResponse) ToJsonString() string
type AddSmsTemplateRequest ¶
type AddSmsTemplateRequest struct {
*tchttp.BaseRequest
// Template name.
TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`
// Template content.
TemplateContent *string `json:"TemplateContent,omitempty" name:"TemplateContent"`
// SMS type. 0: regular SMS, 1: marketing SMS.
SmsType *uint64 `json:"SmsType,omitempty" name:"SmsType"`
// Whether it is Global SMS:
// 0: Mainland China SMS.
// 1: Global SMS.
International *uint64 `json:"International,omitempty" name:"International"`
// Template remarks, such as reason for application and use case.
Remark *string `json:"Remark,omitempty" name:"Remark"`
}
func NewAddSmsTemplateRequest ¶
func NewAddSmsTemplateRequest() (request *AddSmsTemplateRequest)
func (*AddSmsTemplateRequest) FromJsonString ¶
func (r *AddSmsTemplateRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AddSmsTemplateRequest) ToJsonString ¶
func (r *AddSmsTemplateRequest) ToJsonString() string
type AddSmsTemplateResponse ¶
type AddSmsTemplateResponse struct {
*tchttp.BaseResponse
Response *struct {
// SMS template addition response body
AddTemplateStatus *AddTemplateStatus `json:"AddTemplateStatus,omitempty" name:"AddTemplateStatus"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewAddSmsTemplateResponse ¶
func NewAddSmsTemplateResponse() (response *AddSmsTemplateResponse)
func (*AddSmsTemplateResponse) FromJsonString ¶
func (r *AddSmsTemplateResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AddSmsTemplateResponse) ToJsonString ¶
func (r *AddSmsTemplateResponse) ToJsonString() string
type AddTemplateStatus ¶
type AddTemplateStatus struct {
// Template ID.
TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`
}
type CallbackStatusStatistics ¶
type CallbackStatusStatistics struct {
// Messages with receipt.
CallbackCount *uint64 `json:"CallbackCount,omitempty" name:"CallbackCount"`
// Successfully submitted SMS messages.
RequestSuccessCount *uint64 `json:"RequestSuccessCount,omitempty" name:"RequestSuccessCount"`
// Failed receipts.
CallbackFailCount *uint64 `json:"CallbackFailCount,omitempty" name:"CallbackFailCount"`
// Successful receipts.
CallbackSuccessCount *uint64 `json:"CallbackSuccessCount,omitempty" name:"CallbackSuccessCount"`
// Carrier's internal error.
InternalErrorCount *uint64 `json:"InternalErrorCount,omitempty" name:"InternalErrorCount"`
// Invalid numbers.
InvalidNumberCount *uint64 `json:"InvalidNumberCount,omitempty" name:"InvalidNumberCount"`
// Errors such as out-of-service or power-off.
ShutdownErrorCount *uint64 `json:"ShutdownErrorCount,omitempty" name:"ShutdownErrorCount"`
// Blocked mobile numbers.
BlackListCount *uint64 `json:"BlackListCount,omitempty" name:"BlackListCount"`
// Carrier rate limit hits.
FrequencyLimitCount *uint64 `json:"FrequencyLimitCount,omitempty" name:"FrequencyLimitCount"`
}
type CallbackStatusStatisticsRequest ¶
type CallbackStatusStatisticsRequest struct {
*tchttp.BaseRequest
// Start time in the format of `yyyymmddhh` accurate to the hour, such as 2021050113 (13:00 on May 1, 2021).
BeginTime *string `json:"BeginTime,omitempty" name:"BeginTime"`
// End time in the format of `yyyymmddhh` accurate to the hour, such as 2021050118 (18:00 on May 1, 2021).
// Note: `EndTime` must be after `BeginTime`, and the difference should not exceed 32 days.
EndTime *string `json:"EndTime,omitempty" name:"EndTime"`
// The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
SmsSdkAppId *string `json:"SmsSdkAppId,omitempty" name:"SmsSdkAppId"`
// Upper limit.
// Note: this parameter is currently fixed at 0.
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// Offset.
// Note: this parameter is currently fixed at 0.
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}
func NewCallbackStatusStatisticsRequest ¶
func NewCallbackStatusStatisticsRequest() (request *CallbackStatusStatisticsRequest)
func (*CallbackStatusStatisticsRequest) FromJsonString ¶
func (r *CallbackStatusStatisticsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CallbackStatusStatisticsRequest) ToJsonString ¶
func (r *CallbackStatusStatisticsRequest) ToJsonString() string
type CallbackStatusStatisticsResponse ¶
type CallbackStatusStatisticsResponse struct {
*tchttp.BaseResponse
Response *struct {
// Receipt statistics response body.
CallbackStatusStatistics *CallbackStatusStatistics `json:"CallbackStatusStatistics,omitempty" name:"CallbackStatusStatistics"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCallbackStatusStatisticsResponse ¶
func NewCallbackStatusStatisticsResponse() (response *CallbackStatusStatisticsResponse)
func (*CallbackStatusStatisticsResponse) FromJsonString ¶
func (r *CallbackStatusStatisticsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CallbackStatusStatisticsResponse) ToJsonString ¶
func (r *CallbackStatusStatisticsResponse) ToJsonString() string
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) AddSmsSign ¶
func (c *Client) AddSmsSign(request *AddSmsSignRequest) (response *AddSmsSignResponse, err error)
AddSmsSign 1. This API is used to add an SMS signature. You need to read the [Tencent Cloud SMS Signature Review Standards](https://intl.cloud.tencent.com/zh/document/product/382/40658) before starting an application.
2. ⚠️ Note: individual users cannot use this API to apply for SMS signatures. For more information, see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the console to apply for 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_PARAMETERSOTHERERROR = "FailedOperation.ParametersOtherError" FAILEDOPERATION_SIGNNUMBERLIMIT = "FailedOperation.SignNumberLimit" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER_APPIDANDBIZID = "InvalidParameter.AppidAndBizId" INVALIDPARAMETERVALUE_IMAGEINVALID = "InvalidParameterValue.ImageInvalid" INVALIDPARAMETERVALUE_INVALIDDOCUMENTTYPE = "InvalidParameterValue.InvalidDocumentType" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDUSEDMETHOD = "InvalidParameterValue.InvalidUsedMethod" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" INVALIDPARAMETERVALUE_SIGNALREADYPASSEDCHECK = "InvalidParameterValue.SignAlreadyPassedCheck" INVALIDPARAMETERVALUE_SIGNEXISTANDUNAPPROVED = "InvalidParameterValue.SignExistAndUnapproved" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) AddSmsSignWithContext ¶
func (c *Client) AddSmsSignWithContext(ctx context.Context, request *AddSmsSignRequest) (response *AddSmsSignResponse, err error)
AddSmsSign 1. This API is used to add an SMS signature. You need to read the [Tencent Cloud SMS Signature Review Standards](https://intl.cloud.tencent.com/zh/document/product/382/40658) before starting an application.
2. ⚠️ Note: individual users cannot use this API to apply for SMS signatures. For more information, see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the console to apply for 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_PARAMETERSOTHERERROR = "FailedOperation.ParametersOtherError" FAILEDOPERATION_SIGNNUMBERLIMIT = "FailedOperation.SignNumberLimit" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER_APPIDANDBIZID = "InvalidParameter.AppidAndBizId" INVALIDPARAMETERVALUE_IMAGEINVALID = "InvalidParameterValue.ImageInvalid" INVALIDPARAMETERVALUE_INVALIDDOCUMENTTYPE = "InvalidParameterValue.InvalidDocumentType" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDUSEDMETHOD = "InvalidParameterValue.InvalidUsedMethod" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" INVALIDPARAMETERVALUE_SIGNALREADYPASSEDCHECK = "InvalidParameterValue.SignAlreadyPassedCheck" INVALIDPARAMETERVALUE_SIGNEXISTANDUNAPPROVED = "InvalidParameterValue.SignExistAndUnapproved" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) AddSmsTemplate ¶
func (c *Client) AddSmsTemplate(request *AddSmsTemplateRequest) (response *AddSmsTemplateResponse, err error)
AddSmsTemplate 1. This API is used to add an SMS template. You need to read the [Tencent Cloud SMS Body Template Review Standards](https://intl.cloud.tencent.com/zh/document/product/382/40659) before starting an application.
2. ⚠️ Note: individual users cannot use this API to apply for SMS body templates. For more information, see [Identity Verification Overview](https://intl.cloud.tencent.com/zh/document/product/378/3629). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to apply for SMS body templates.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = "FailedOperation.ForbidAddMarketingTemplates" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGSIGNATURE = "FailedOperation.MissingSignature" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = "FailedOperation.TemplateAlreadyPassedCheck" FAILEDOPERATION_TEMPLATENUMBERLIMIT = "FailedOperation.TemplateNumberLimit" INTERNALERROR_JSONPARSEFAIL = "InternalError.JsonParseFail" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER_DIRTYWORDFOUND = "InvalidParameter.DirtyWordFound" INVALIDPARAMETER_INVALIDPARAMETERS = "InvalidParameter.InvalidParameters" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = "InvalidParameterValue.InvalidTemplateFormat" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) AddSmsTemplateWithContext ¶
func (c *Client) AddSmsTemplateWithContext(ctx context.Context, request *AddSmsTemplateRequest) (response *AddSmsTemplateResponse, err error)
AddSmsTemplate 1. This API is used to add an SMS template. You need to read the [Tencent Cloud SMS Body Template Review Standards](https://intl.cloud.tencent.com/zh/document/product/382/40659) before starting an application.
2. ⚠️ Note: individual users cannot use this API to apply for SMS body templates. For more information, see [Identity Verification Overview](https://intl.cloud.tencent.com/zh/document/product/378/3629). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to apply for SMS body templates.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = "FailedOperation.ForbidAddMarketingTemplates" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGSIGNATURE = "FailedOperation.MissingSignature" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = "FailedOperation.TemplateAlreadyPassedCheck" FAILEDOPERATION_TEMPLATENUMBERLIMIT = "FailedOperation.TemplateNumberLimit" INTERNALERROR_JSONPARSEFAIL = "InternalError.JsonParseFail" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER_DIRTYWORDFOUND = "InvalidParameter.DirtyWordFound" INVALIDPARAMETER_INVALIDPARAMETERS = "InvalidParameter.InvalidParameters" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = "InvalidParameterValue.InvalidTemplateFormat" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) CallbackStatusStatistics ¶
func (c *Client) CallbackStatusStatistics(request *CallbackStatusStatisticsRequest) (response *CallbackStatusStatisticsResponse, err error)
CallbackStatusStatistics This API is used to collect statistics on user receipts.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_LIMITVERIFYFAIL = "InvalidParameterValue.LimitVerifyFail" INVALIDPARAMETERVALUE_OFFSETVERIFYFAIL = "InvalidParameterValue.OffsetVerifyFail" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) CallbackStatusStatisticsWithContext ¶
func (c *Client) CallbackStatusStatisticsWithContext(ctx context.Context, request *CallbackStatusStatisticsRequest) (response *CallbackStatusStatisticsResponse, err error)
CallbackStatusStatistics This API is used to collect statistics on user receipts.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_LIMITVERIFYFAIL = "InvalidParameterValue.LimitVerifyFail" INVALIDPARAMETERVALUE_OFFSETVERIFYFAIL = "InvalidParameterValue.OffsetVerifyFail" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DeleteSmsSign ¶
func (c *Client) DeleteSmsSign(request *DeleteSmsSignRequest) (response *DeleteSmsSignResponse, err error)
DeleteSmsSign ⚠️ Note: individual users cannot use this API to delete SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). Please log in to the [console](https://console.cloud.tencent.com/smsv2) to delete 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGSIGNATURETOMODIFY = "FailedOperation.MissingSignatureToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DeleteSmsSignWithContext ¶
func (c *Client) DeleteSmsSignWithContext(ctx context.Context, request *DeleteSmsSignRequest) (response *DeleteSmsSignResponse, err error)
DeleteSmsSign ⚠️ Note: individual users cannot use this API to delete SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). Please log in to the [console](https://console.cloud.tencent.com/smsv2) to delete 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGSIGNATURETOMODIFY = "FailedOperation.MissingSignatureToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DeleteSmsTemplate ¶
func (c *Client) DeleteSmsTemplate(request *DeleteSmsTemplateRequest) (response *DeleteSmsTemplateResponse, err error)
DeleteSmsTemplate ⚠️ Note: individual users cannot use this API to delete SMS body templates. Please log in to the [console](https://console.cloud.tencent.com/smsv2) to do so. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1).
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_TEMPLATEIDNOTEXIST = "FailedOperation.TemplateIdNotExist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DeleteSmsTemplateWithContext ¶
func (c *Client) DeleteSmsTemplateWithContext(ctx context.Context, request *DeleteSmsTemplateRequest) (response *DeleteSmsTemplateResponse, err error)
DeleteSmsTemplate ⚠️ Note: individual users cannot use this API to delete SMS body templates. Please log in to the [console](https://console.cloud.tencent.com/smsv2) to do so. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1).
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_TEMPLATEIDNOTEXIST = "FailedOperation.TemplateIdNotExist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DescribePhoneNumberInfo ¶
func (c *Client) DescribePhoneNumberInfo(request *DescribePhoneNumberInfoRequest) (response *DescribePhoneNumberInfoResponse, err error)
DescribePhoneNumberInfo This API is used to query the information of a phone number, including country/region code and standardized E.164 format number.
>- For example, if you query the number +86018845720123, you can get the country/region code 86 and the standardized E.164 number +8618845720123.
error code that may be returned:
FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERPARSEFAIL = "FailedOperation.PhoneNumberParseFail" LIMITEXCEEDED_PHONENUMBERCOUNTLIMIT = "LimitExceeded.PhoneNumberCountLimit"
func (*Client) DescribePhoneNumberInfoWithContext ¶
func (c *Client) DescribePhoneNumberInfoWithContext(ctx context.Context, request *DescribePhoneNumberInfoRequest) (response *DescribePhoneNumberInfoResponse, err error)
DescribePhoneNumberInfo This API is used to query the information of a phone number, including country/region code and standardized E.164 format number.
>- For example, if you query the number +86018845720123, you can get the country/region code 86 and the standardized E.164 number +8618845720123.
error code that may be returned:
FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERPARSEFAIL = "FailedOperation.PhoneNumberParseFail" LIMITEXCEEDED_PHONENUMBERCOUNTLIMIT = "LimitExceeded.PhoneNumberCountLimit"
func (*Client) DescribeSmsSignList ¶
func (c *Client) DescribeSmsSignList(request *DescribeSmsSignListRequest) (response *DescribeSmsSignListResponse, err error)
DescribeSmsSignList ⚠️ Note: individual users cannot use this API to query SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DescribeSmsSignListWithContext ¶
func (c *Client) DescribeSmsSignListWithContext(ctx context.Context, request *DescribeSmsSignListRequest) (response *DescribeSmsSignListResponse, err error)
DescribeSmsSignList ⚠️ Note: individual users cannot use this API to query SMS signatures. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DescribeSmsTemplateList ¶
func (c *Client) DescribeSmsTemplateList(request *DescribeSmsTemplateListRequest) (response *DescribeSmsTemplateListResponse, err error)
DescribeSmsTemplateList ⚠️ Note: individual users cannot use this API to query SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1).
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = "FailedOperation.ForbidAddMarketingTemplates" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_PROHIBITSUBACCOUNTUSE = "FailedOperation.ProhibitSubAccountUse" FAILEDOPERATION_TEMPLATENUMBERLIMIT = "FailedOperation.TemplateNumberLimit" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = "InvalidParameterValue.InvalidTemplateFormat" INVALIDPARAMETERVALUE_TEMPLATEWITHDIRTYWORDS = "InvalidParameterValue.TemplateWithDirtyWords" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) DescribeSmsTemplateListWithContext ¶
func (c *Client) DescribeSmsTemplateListWithContext(ctx context.Context, request *DescribeSmsTemplateListRequest) (response *DescribeSmsTemplateListResponse, err error)
DescribeSmsTemplateList ⚠️ Note: individual users cannot use this API to query SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1).
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = "FailedOperation.ForbidAddMarketingTemplates" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_PROHIBITSUBACCOUNTUSE = "FailedOperation.ProhibitSubAccountUse" FAILEDOPERATION_TEMPLATENUMBERLIMIT = "FailedOperation.TemplateNumberLimit" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = "InvalidParameterValue.InvalidTemplateFormat" INVALIDPARAMETERVALUE_TEMPLATEWITHDIRTYWORDS = "InvalidParameterValue.TemplateWithDirtyWords" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) ModifySmsSign ¶
func (c *Client) ModifySmsSign(request *ModifySmsSignRequest) (response *ModifySmsSignResponse, err error)
ModifySmsSign 1. This API is used to modify an SMS signature. You need to read the [Tencent Cloud SMS Signature Review Standards](https://intl.cloud.tencent.com/document/product/382/39022) before making a modification.
2. ⚠️ Note: individual users cannot use this API to modify SMS signatures. For more information, see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to modify SMS signatures.
3. Modifications can be made only if the signature status is **Pending Review** or **Rejected**. **Approved** signatures cannot be modified.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGSIGNATURELIST = "FailedOperation.MissingSignatureList" FAILEDOPERATION_MISSINGSIGNATURETOMODIFY = "FailedOperation.MissingSignatureToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_SIGNNUMBERLIMIT = "FailedOperation.SignNumberLimit" FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = "FailedOperation.TemplateAlreadyPassedCheck" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_APPIDANDBIZID = "InvalidParameter.AppidAndBizId" INVALIDPARAMETERVALUE_IMAGEINVALID = "InvalidParameterValue.ImageInvalid" INVALIDPARAMETERVALUE_INVALIDDOCUMENTTYPE = "InvalidParameterValue.InvalidDocumentType" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDSIGNPURPOSE = "InvalidParameterValue.InvalidSignPurpose" INVALIDPARAMETERVALUE_SIGNALREADYPASSEDCHECK = "InvalidParameterValue.SignAlreadyPassedCheck" INVALIDPARAMETERVALUE_SIGNEXISTANDUNAPPROVED = "InvalidParameterValue.SignExistAndUnapproved" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) ModifySmsSignWithContext ¶
func (c *Client) ModifySmsSignWithContext(ctx context.Context, request *ModifySmsSignRequest) (response *ModifySmsSignResponse, err error)
ModifySmsSign 1. This API is used to modify an SMS signature. You need to read the [Tencent Cloud SMS Signature Review Standards](https://intl.cloud.tencent.com/document/product/382/39022) before making a modification.
2. ⚠️ Note: individual users cannot use this API to modify SMS signatures. For more information, see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to modify SMS signatures.
3. Modifications can be made only if the signature status is **Pending Review** or **Rejected**. **Approved** signatures cannot be modified.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MISSINGSIGNATURELIST = "FailedOperation.MissingSignatureList" FAILEDOPERATION_MISSINGSIGNATURETOMODIFY = "FailedOperation.MissingSignatureToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_SIGNNUMBERLIMIT = "FailedOperation.SignNumberLimit" FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = "FailedOperation.TemplateAlreadyPassedCheck" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_APPIDANDBIZID = "InvalidParameter.AppidAndBizId" INVALIDPARAMETERVALUE_IMAGEINVALID = "InvalidParameterValue.ImageInvalid" INVALIDPARAMETERVALUE_INVALIDDOCUMENTTYPE = "InvalidParameterValue.InvalidDocumentType" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDSIGNPURPOSE = "InvalidParameterValue.InvalidSignPurpose" INVALIDPARAMETERVALUE_SIGNALREADYPASSEDCHECK = "InvalidParameterValue.SignAlreadyPassedCheck" INVALIDPARAMETERVALUE_SIGNEXISTANDUNAPPROVED = "InvalidParameterValue.SignExistAndUnapproved" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) ModifySmsTemplate ¶
func (c *Client) ModifySmsTemplate(request *ModifySmsTemplateRequest) (response *ModifySmsTemplateResponse, err error)
ModifySmsTemplate 1. This API is used to modify an SMS body template. Please read the [Tencent Cloud SMS Body Template Review Standards](https://intl.cloud.tencent.com/document/product/382/39023?from_cn_redirect=1) before making a modification.
2. ⚠️ Note: individual users cannot use this API to modify SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to modify SMS body templates.
3. Modifications can be made only if the body template status is **Pending Review** or **Rejected**. **Approved** body templates cannot be modified.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = "FailedOperation.ForbidAddMarketingTemplates" FAILEDOPERATION_MISSINGTEMPLATELIST = "FailedOperation.MissingTemplateList" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = "FailedOperation.TemplateAlreadyPassedCheck" FAILEDOPERATION_TEMPLATENUMBERLIMIT = "FailedOperation.TemplateNumberLimit" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER_DIRTYWORDFOUND = "InvalidParameter.DirtyWordFound" INVALIDPARAMETER_INVALIDPARAMETERS = "InvalidParameter.InvalidParameters" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = "InvalidParameterValue.InvalidTemplateFormat" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) ModifySmsTemplateWithContext ¶
func (c *Client) ModifySmsTemplateWithContext(ctx context.Context, request *ModifySmsTemplateRequest) (response *ModifySmsTemplateResponse, err error)
ModifySmsTemplate 1. This API is used to modify an SMS body template. Please read the [Tencent Cloud SMS Body Template Review Standards](https://intl.cloud.tencent.com/document/product/382/39023?from_cn_redirect=1) before making a modification.
2. ⚠️ Note: individual users cannot use this API to modify SMS body templates. For more information, please see [Identity Verification Overview](https://intl.cloud.tencent.com/document/product/378/3629?from_cn_redirect=1). If your account identity is individual, you can log in to the [console](https://console.cloud.tencent.com/smsv2) to modify SMS body templates.
3. Modifications can be made only if the body template status is **Pending Review** or **Rejected**. **Approved** body templates cannot be modified.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = "FailedOperation.ForbidAddMarketingTemplates" FAILEDOPERATION_MISSINGTEMPLATELIST = "FailedOperation.MissingTemplateList" FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = "FailedOperation.MissingTemplateToModify" FAILEDOPERATION_NOTENTERPRISECERTIFICATION = "FailedOperation.NotEnterpriseCertification" FAILEDOPERATION_OTHERERROR = "FailedOperation.OtherError" FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = "FailedOperation.TemplateAlreadyPassedCheck" FAILEDOPERATION_TEMPLATENUMBERLIMIT = "FailedOperation.TemplateNumberLimit" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER_DIRTYWORDFOUND = "InvalidParameter.DirtyWordFound" INVALIDPARAMETER_INVALIDPARAMETERS = "InvalidParameter.InvalidParameters" INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = "InvalidParameterValue.InvalidInternational" INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = "InvalidParameterValue.InvalidTemplateFormat" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsReplyStatus ¶
func (c *Client) PullSmsReplyStatus(request *PullSmsReplyStatusRequest) (response *PullSmsReplyStatusResponse, err error)
PullSmsReplyStatus This API is used to pull SMS reply status.
Currently, you can also [configure the reply callback](https://intl.cloud.tencent.com/document/product/382/42907?from_cn_redirect=1) to get replies.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsReplyStatusByPhoneNumber ¶
func (c *Client) PullSmsReplyStatusByPhoneNumber(request *PullSmsReplyStatusByPhoneNumberRequest) (response *PullSmsReplyStatusByPhoneNumberResponse, err error)
PullSmsReplyStatusByPhoneNumber This API is used to pull SMS reply status for one single number.
Currently, you can also [configure the reply callback](https://intl.cloud.tencent.com/document/product/382/42907?from_cn_redirect=1) to get replies.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_INVALIDSTARTTIME = "InvalidParameterValue.InvalidStartTime" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsReplyStatusByPhoneNumberWithContext ¶
func (c *Client) PullSmsReplyStatusByPhoneNumberWithContext(ctx context.Context, request *PullSmsReplyStatusByPhoneNumberRequest) (response *PullSmsReplyStatusByPhoneNumberResponse, err error)
PullSmsReplyStatusByPhoneNumber This API is used to pull SMS reply status for one single number.
Currently, you can also [configure the reply callback](https://intl.cloud.tencent.com/document/product/382/42907?from_cn_redirect=1) to get replies.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_INVALIDSTARTTIME = "InvalidParameterValue.InvalidStartTime" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsReplyStatusWithContext ¶
func (c *Client) PullSmsReplyStatusWithContext(ctx context.Context, request *PullSmsReplyStatusRequest) (response *PullSmsReplyStatusResponse, err error)
PullSmsReplyStatus This API is used to pull SMS reply status.
Currently, you can also [configure the reply callback](https://intl.cloud.tencent.com/document/product/382/42907?from_cn_redirect=1) to get replies.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsSendStatus ¶
func (c *Client) PullSmsSendStatus(request *PullSmsSendStatusRequest) (response *PullSmsSendStatusResponse, err error)
PullSmsSendStatus This API is used to pull SMS delivery status.
Currently, you can also [configure the callback](https://intl.cloud.tencent.com/document/product/382/37809?from_cn_redirect=1#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) to get the delivery status.
>- Note: you need to contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) to activate this API.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsSendStatusByPhoneNumber ¶
func (c *Client) PullSmsSendStatusByPhoneNumber(request *PullSmsSendStatusByPhoneNumberRequest) (response *PullSmsSendStatusByPhoneNumberResponse, err error)
PullSmsSendStatusByPhoneNumber This API is used to pull SMS delivery status for one single number.
Currently, you can also [configure the callback](https://intl.cloud.tencent.com/document/product/382/37809?from_cn_redirect=1#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) to get the delivery status.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) to eliminate the need to calculate signatures. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_JSONPARSEFAIL = "InternalError.JsonParseFail" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_INVALIDSTARTTIME = "InvalidParameterValue.InvalidStartTime" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsSendStatusByPhoneNumberWithContext ¶
func (c *Client) PullSmsSendStatusByPhoneNumberWithContext(ctx context.Context, request *PullSmsSendStatusByPhoneNumberRequest) (response *PullSmsSendStatusByPhoneNumberResponse, err error)
PullSmsSendStatusByPhoneNumber This API is used to pull SMS delivery status for one single number.
Currently, you can also [configure the callback](https://intl.cloud.tencent.com/document/product/382/37809?from_cn_redirect=1#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) to get the delivery status.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) to eliminate the need to calculate signatures. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_JSONPARSEFAIL = "InternalError.JsonParseFail" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_INVALIDSTARTTIME = "InvalidParameterValue.InvalidStartTime" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) PullSmsSendStatusWithContext ¶
func (c *Client) PullSmsSendStatusWithContext(ctx context.Context, request *PullSmsSendStatusRequest) (response *PullSmsSendStatusResponse, err error)
PullSmsSendStatus This API is used to pull SMS delivery status.
Currently, you can also [configure the callback](https://intl.cloud.tencent.com/document/product/382/37809?from_cn_redirect=1#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) to get the delivery status.
>- Note: you need to contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) to activate this API.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) SendSms ¶
func (c *Client) SendSms(request *SendSmsRequest) (response *SendSmsResponse, err error)
SendSms This API is used to send SMS verification codes, notification, or marketing messages to users.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_CONTAINSENSITIVEWORD = "FailedOperation.ContainSensitiveWord" FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_INSUFFICIENTBALANCEINSMSPACKAGE = "FailedOperation.InsufficientBalanceInSmsPackage" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MARKETINGSENDTIMECONSTRAINT = "FailedOperation.MarketingSendTimeConstraint" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" FAILEDOPERATION_SIGNATUREINCORRECTORUNAPPROVED = "FailedOperation.SignatureIncorrectOrUnapproved" FAILEDOPERATION_TEMPLATEINCORRECTORUNAPPROVED = "FailedOperation.TemplateIncorrectOrUnapproved" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETERVALUE_CONTENTLENGTHLIMIT = "InvalidParameterValue.ContentLengthLimit" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_PROHIBITEDUSEURLINTEMPLATEPARAMETER = "InvalidParameterValue.ProhibitedUseUrlInTemplateParameter" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" INVALIDPARAMETERVALUE_TEMPLATEPARAMETERFORMATERROR = "InvalidParameterValue.TemplateParameterFormatError" INVALIDPARAMETERVALUE_TEMPLATEPARAMETERLENGTHLIMIT = "InvalidParameterValue.TemplateParameterLengthLimit" LIMITEXCEEDED_APPDAILYLIMIT = "LimitExceeded.AppDailyLimit" LIMITEXCEEDED_DAILYLIMIT = "LimitExceeded.DailyLimit" LIMITEXCEEDED_DELIVERYFREQUENCYLIMIT = "LimitExceeded.DeliveryFrequencyLimit" LIMITEXCEEDED_PHONENUMBERCOUNTLIMIT = "LimitExceeded.PhoneNumberCountLimit" LIMITEXCEEDED_PHONENUMBERDAILYLIMIT = "LimitExceeded.PhoneNumberDailyLimit" LIMITEXCEEDED_PHONENUMBERONEHOURLIMIT = "LimitExceeded.PhoneNumberOneHourLimit" LIMITEXCEEDED_PHONENUMBERSAMECONTENTDAILYLIMIT = "LimitExceeded.PhoneNumberSameContentDailyLimit" LIMITEXCEEDED_PHONENUMBERTHIRTYSECONDLIMIT = "LimitExceeded.PhoneNumberThirtySecondLimit" MISSINGPARAMETER_EMPTYPHONENUMBERSET = "MissingParameter.EmptyPhoneNumberSet" UNAUTHORIZEDOPERATION_INDIVIDUALUSERMARKETINGSMSPERMISSIONDENY = "UnauthorizedOperation.IndividualUserMarketingSmsPermissionDeny" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation." UNSUPPORTEDOPERATION_CONTAINDOMESTICANDINTERNATIONALPHONENUMBER = "UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber" UNSUPPORTEDOPERATION_UNSUPORTEDREGION = "UnsupportedOperation.UnsuportedRegion"
func (*Client) SendSmsWithContext ¶
func (c *Client) SendSmsWithContext(ctx context.Context, request *SendSmsRequest) (response *SendSmsResponse, err error)
SendSms This API is used to send SMS verification codes, notification, or marketing messages to users.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_CONTAINSENSITIVEWORD = "FailedOperation.ContainSensitiveWord" FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_INSUFFICIENTBALANCEINSMSPACKAGE = "FailedOperation.InsufficientBalanceInSmsPackage" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_MARKETINGSENDTIMECONSTRAINT = "FailedOperation.MarketingSendTimeConstraint" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" FAILEDOPERATION_SIGNATUREINCORRECTORUNAPPROVED = "FailedOperation.SignatureIncorrectOrUnapproved" FAILEDOPERATION_TEMPLATEINCORRECTORUNAPPROVED = "FailedOperation.TemplateIncorrectOrUnapproved" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETERVALUE_CONTENTLENGTHLIMIT = "InvalidParameterValue.ContentLengthLimit" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_PROHIBITEDUSEURLINTEMPLATEPARAMETER = "InvalidParameterValue.ProhibitedUseUrlInTemplateParameter" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" INVALIDPARAMETERVALUE_TEMPLATEPARAMETERFORMATERROR = "InvalidParameterValue.TemplateParameterFormatError" INVALIDPARAMETERVALUE_TEMPLATEPARAMETERLENGTHLIMIT = "InvalidParameterValue.TemplateParameterLengthLimit" LIMITEXCEEDED_APPDAILYLIMIT = "LimitExceeded.AppDailyLimit" LIMITEXCEEDED_DAILYLIMIT = "LimitExceeded.DailyLimit" LIMITEXCEEDED_DELIVERYFREQUENCYLIMIT = "LimitExceeded.DeliveryFrequencyLimit" LIMITEXCEEDED_PHONENUMBERCOUNTLIMIT = "LimitExceeded.PhoneNumberCountLimit" LIMITEXCEEDED_PHONENUMBERDAILYLIMIT = "LimitExceeded.PhoneNumberDailyLimit" LIMITEXCEEDED_PHONENUMBERONEHOURLIMIT = "LimitExceeded.PhoneNumberOneHourLimit" LIMITEXCEEDED_PHONENUMBERSAMECONTENTDAILYLIMIT = "LimitExceeded.PhoneNumberSameContentDailyLimit" LIMITEXCEEDED_PHONENUMBERTHIRTYSECONDLIMIT = "LimitExceeded.PhoneNumberThirtySecondLimit" MISSINGPARAMETER_EMPTYPHONENUMBERSET = "MissingParameter.EmptyPhoneNumberSet" UNAUTHORIZEDOPERATION_INDIVIDUALUSERMARKETINGSMSPERMISSIONDENY = "UnauthorizedOperation.IndividualUserMarketingSmsPermissionDeny" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation." UNSUPPORTEDOPERATION_CONTAINDOMESTICANDINTERNATIONALPHONENUMBER = "UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber" UNSUPPORTEDOPERATION_UNSUPORTEDREGION = "UnsupportedOperation.UnsuportedRegion"
func (*Client) SendStatusStatistics ¶
func (c *Client) SendStatusStatistics(request *SendStatusStatisticsRequest) (response *SendStatusStatisticsResponse, err error)
SendStatusStatistics This API is used to collect statistics on SMS messages sent by users.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" FAILEDOPERATION_TEMPLATEINCORRECTORUNAPPROVED = "FailedOperation.TemplateIncorrectOrUnapproved" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_LIMITVERIFYFAIL = "InvalidParameterValue.LimitVerifyFail" INVALIDPARAMETERVALUE_OFFSETVERIFYFAIL = "InvalidParameterValue.OffsetVerifyFail" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
func (*Client) SendStatusStatisticsWithContext ¶
func (c *Client) SendStatusStatisticsWithContext(ctx context.Context, request *SendStatusStatisticsRequest) (response *SendStatusStatisticsResponse, err error)
SendStatusStatistics This API is used to collect statistics on SMS messages sent by users.
>- 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](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms), which eliminates the signature calculation steps. After it is executed successfully, API Explorer can **automatically generate** SDK code samples.
error code that may be returned:
FAILEDOPERATION_FAILRESOLVEPACKET = "FailedOperation.FailResolvePacket" FAILEDOPERATION_JSONPARSEFAIL = "FailedOperation.JsonParseFail" FAILEDOPERATION_PHONENUMBERINBLACKLIST = "FailedOperation.PhoneNumberInBlacklist" FAILEDOPERATION_TEMPLATEINCORRECTORUNAPPROVED = "FailedOperation.TemplateIncorrectOrUnapproved" INTERNALERROR_OTHERERROR = "InternalError.OtherError" INTERNALERROR_REQUESTTIMEEXCEPTION = "InternalError.RequestTimeException" INTERNALERROR_RESTAPIINTERFACENOTEXIST = "InternalError.RestApiInterfaceNotExist" INTERNALERROR_SENDANDRECVFAIL = "InternalError.SendAndRecvFail" INTERNALERROR_SIGFIELDMISSING = "InternalError.SigFieldMissing" INTERNALERROR_SIGVERIFICATIONFAIL = "InternalError.SigVerificationFail" INTERNALERROR_TIMEOUT = "InternalError.Timeout" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = "InvalidParameterValue.BeginTimeVerifyFail" INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = "InvalidParameterValue.EndTimeVerifyFail" INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = "InvalidParameterValue.IncorrectPhoneNumber" INVALIDPARAMETERVALUE_LIMITVERIFYFAIL = "InvalidParameterValue.LimitVerifyFail" INVALIDPARAMETERVALUE_OFFSETVERIFYFAIL = "InvalidParameterValue.OffsetVerifyFail" INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = "InvalidParameterValue.SdkAppIdNotExist" MISSINGPARAMETER = "MissingParameter" UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = "UnauthorizedOperation.RequestIpNotInWhitelist" UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = "UnauthorizedOperation.RequestPermissionDeny" UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = "UnauthorizedOperation.SdkAppIdIsDisabled" UNAUTHORIZEDOPERATION_SERIVCESUSPENDDUETOARREARS = "UnauthorizedOperation.SerivceSuspendDueToArrears" UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = "UnauthorizedOperation.SmsSdkAppIdVerifyFail" UNSUPPORTEDOPERATION_ = "UnsupportedOperation."
type DeleteSignStatus ¶
type DeleteSmsSignRequest ¶
type DeleteSmsSignRequest struct {
*tchttp.BaseRequest
// ID of the signature to be deleted.
SignId *uint64 `json:"SignId,omitempty" name:"SignId"`
}
func NewDeleteSmsSignRequest ¶
func NewDeleteSmsSignRequest() (request *DeleteSmsSignRequest)
func (*DeleteSmsSignRequest) FromJsonString ¶
func (r *DeleteSmsSignRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteSmsSignRequest) ToJsonString ¶
func (r *DeleteSmsSignRequest) ToJsonString() string
type DeleteSmsSignResponse ¶
type DeleteSmsSignResponse struct {
*tchttp.BaseResponse
Response *struct {
// Signature deletion response
DeleteSignStatus *DeleteSignStatus `json:"DeleteSignStatus,omitempty" name:"DeleteSignStatus"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteSmsSignResponse ¶
func NewDeleteSmsSignResponse() (response *DeleteSmsSignResponse)
func (*DeleteSmsSignResponse) FromJsonString ¶
func (r *DeleteSmsSignResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteSmsSignResponse) ToJsonString ¶
func (r *DeleteSmsSignResponse) ToJsonString() string
type DeleteSmsTemplateRequest ¶
type DeleteSmsTemplateRequest struct {
*tchttp.BaseRequest
// ID of the template to be deleted.
TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`
}
func NewDeleteSmsTemplateRequest ¶
func NewDeleteSmsTemplateRequest() (request *DeleteSmsTemplateRequest)
func (*DeleteSmsTemplateRequest) FromJsonString ¶
func (r *DeleteSmsTemplateRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteSmsTemplateRequest) ToJsonString ¶
func (r *DeleteSmsTemplateRequest) ToJsonString() string
type DeleteSmsTemplateResponse ¶
type DeleteSmsTemplateResponse struct {
*tchttp.BaseResponse
Response *struct {
// Template deletion response
DeleteTemplateStatus *DeleteTemplateStatus `json:"DeleteTemplateStatus,omitempty" name:"DeleteTemplateStatus"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDeleteSmsTemplateResponse ¶
func NewDeleteSmsTemplateResponse() (response *DeleteSmsTemplateResponse)
func (*DeleteSmsTemplateResponse) FromJsonString ¶
func (r *DeleteSmsTemplateResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteSmsTemplateResponse) ToJsonString ¶
func (r *DeleteSmsTemplateResponse) ToJsonString() string
type DeleteTemplateStatus ¶
type DescribePhoneNumberInfoRequest ¶
type DescribePhoneNumberInfoRequest struct {
*tchttp.BaseRequest
// A parameter used to query mobile numbers in E.164 format (+[country/region code][subscriber number]). Up to 200 mobile numbers can be queried at a time.
// Take the number +8613711112222 as an example. “86” is the country code (with a “+” sign in its front) and “13711112222” is the subscriber number.
PhoneNumberSet []*string `json:"PhoneNumberSet,omitempty" name:"PhoneNumberSet"`
}
func NewDescribePhoneNumberInfoRequest ¶
func NewDescribePhoneNumberInfoRequest() (request *DescribePhoneNumberInfoRequest)
func (*DescribePhoneNumberInfoRequest) FromJsonString ¶
func (r *DescribePhoneNumberInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribePhoneNumberInfoRequest) ToJsonString ¶
func (r *DescribePhoneNumberInfoRequest) ToJsonString() string
type DescribePhoneNumberInfoResponse ¶
type DescribePhoneNumberInfoResponse struct {
*tchttp.BaseResponse
Response *struct {
// A parameter used to obtain mobile number information.
PhoneNumberInfoSet []*PhoneNumberInfo `json:"PhoneNumberInfoSet,omitempty" name:"PhoneNumberInfoSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribePhoneNumberInfoResponse ¶
func NewDescribePhoneNumberInfoResponse() (response *DescribePhoneNumberInfoResponse)
func (*DescribePhoneNumberInfoResponse) FromJsonString ¶
func (r *DescribePhoneNumberInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribePhoneNumberInfoResponse) ToJsonString ¶
func (r *DescribePhoneNumberInfoResponse) ToJsonString() string
type DescribeSignListStatus ¶
type DescribeSignListStatus struct {
// Signature ID.
SignId *uint64 `json:"SignId,omitempty" name:"SignId"`
// Whether it is Global SMS. 0: Mainland China SMS; 1: Global SMS.
International *uint64 `json:"International,omitempty" name:"International"`
// Signature application status. Valid values: 0: approved; 1: under review.
// -1: application rejected or failed.
StatusCode *int64 `json:"StatusCode,omitempty" name:"StatusCode"`
// Review reply, i.e., response given by the reviewer, which is usually the reason for rejection.
ReviewReply *string `json:"ReviewReply,omitempty" name:"ReviewReply"`
// Signature name.
SignName *string `json:"SignName,omitempty" name:"SignName"`
// Application submission time in the format of UNIX timestamp in seconds.
CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`
}
type DescribeSmsSignListRequest ¶
type DescribeSmsSignListRequest struct {
*tchttp.BaseRequest
// Signature ID array.
// Note: the maximum length of the array is 100 by default.
SignIdSet []*uint64 `json:"SignIdSet,omitempty" name:"SignIdSet"`
// Whether it is Global SMS:
// 0: Mainland China SMS.
// 1: Global SMS.
International *uint64 `json:"International,omitempty" name:"International"`
}
func NewDescribeSmsSignListRequest ¶
func NewDescribeSmsSignListRequest() (request *DescribeSmsSignListRequest)
func (*DescribeSmsSignListRequest) FromJsonString ¶
func (r *DescribeSmsSignListRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSmsSignListRequest) ToJsonString ¶
func (r *DescribeSmsSignListRequest) ToJsonString() string
type DescribeSmsSignListResponse ¶
type DescribeSmsSignListResponse struct {
*tchttp.BaseResponse
Response *struct {
// Response for getting signature information
DescribeSignListStatusSet []*DescribeSignListStatus `json:"DescribeSignListStatusSet,omitempty" name:"DescribeSignListStatusSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeSmsSignListResponse ¶
func NewDescribeSmsSignListResponse() (response *DescribeSmsSignListResponse)
func (*DescribeSmsSignListResponse) FromJsonString ¶
func (r *DescribeSmsSignListResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSmsSignListResponse) ToJsonString ¶
func (r *DescribeSmsSignListResponse) ToJsonString() string
type DescribeSmsTemplateListRequest ¶
type DescribeSmsTemplateListRequest struct {
*tchttp.BaseRequest
// Whether it is Global SMS:
// 0: Mainland China SMS.
// 1: Global SMS.
International *uint64 `json:"International,omitempty" name:"International"`
// Array of template IDs. If the array is empty, the template list information will be queried by default (only allowed for root accounts). You need to use the `Limit` and `Offset` fields to set the query range.
// <dx-alert infotype="notice" title="Note">The default array length can be up to 100</dx-alert>
TemplateIdSet []*uint64 `json:"TemplateIdSet,omitempty" name:"TemplateIdSet"`
// Upper limit. Maximum value: 100.
// Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// Offset.
// Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeSmsTemplateListRequest ¶
func NewDescribeSmsTemplateListRequest() (request *DescribeSmsTemplateListRequest)
func (*DescribeSmsTemplateListRequest) FromJsonString ¶
func (r *DescribeSmsTemplateListRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSmsTemplateListRequest) ToJsonString ¶
func (r *DescribeSmsTemplateListRequest) ToJsonString() string
type DescribeSmsTemplateListResponse ¶
type DescribeSmsTemplateListResponse struct {
*tchttp.BaseResponse
Response *struct {
// Response for getting SMS template information
DescribeTemplateStatusSet []*DescribeTemplateListStatus `json:"DescribeTemplateStatusSet,omitempty" name:"DescribeTemplateStatusSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeSmsTemplateListResponse ¶
func NewDescribeSmsTemplateListResponse() (response *DescribeSmsTemplateListResponse)
func (*DescribeSmsTemplateListResponse) FromJsonString ¶
func (r *DescribeSmsTemplateListResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSmsTemplateListResponse) ToJsonString ¶
func (r *DescribeSmsTemplateListResponse) ToJsonString() string
type DescribeTemplateListStatus ¶
type DescribeTemplateListStatus struct {
// Template ID.
TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`
// Whether it is Global SMS. 0: Mainland China SMS; 1: Global SMS.
International *uint64 `json:"International,omitempty" name:"International"`
// Template application status. Valid values: 0: approved; 1: under review; -1: application rejected or failed.
StatusCode *int64 `json:"StatusCode,omitempty" name:"StatusCode"`
// Review reply, i.e., response given by the reviewer, which is usually the reason for rejection.
ReviewReply *string `json:"ReviewReply,omitempty" name:"ReviewReply"`
// Template name.
TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`
// Application submission time in the format of UNIX timestamp in seconds.
CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`
// Template content.
TemplateContent *string `json:"TemplateContent,omitempty" name:"TemplateContent"`
}
type ModifySignStatus ¶
type ModifySignStatus struct {
// Signature ID.
SignId *uint64 `json:"SignId,omitempty" name:"SignId"`
}
type ModifySmsSignRequest ¶
type ModifySmsSignRequest struct {
*tchttp.BaseRequest
// ID of the signature to be modified.
SignId *uint64 `json:"SignId,omitempty" name:"SignId"`
// Signature name.
SignName *string `json:"SignName,omitempty" name:"SignName"`
// Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option:
// 0: company. Valid values of `DocumentType` include 0 and 1.
// 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4.
// 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5.
// 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8.
// 4: trademark. Valid values of `DocumentType` include 7.
// 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3.
// 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6.
// Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.
SignType *uint64 `json:"SignType,omitempty" name:"SignType"`
// Identity certificate type:
// 0: three-in-one.
// 1: business license.
// 2: organization code certificate.
// 3: social credit code certificate.
// 4: screenshot of application backend management (for personal app).
// 5: screenshot of website ICP filing backend (for personal website).
// 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program).
// 7: trademark registration certificate.
// 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).
DocumentType *uint64 `json:"DocumentType,omitempty" name:"DocumentType"`
// A parameter used to specify whether it is Global SMS:
// `0`: Chinese mainland SMS.
// `1`: Global SMS.
// Note: the value of this parameter must be consistent with the `International` value of the signature to be modified. This parameter cannot be used to directly change a Chinese mainland signature to an international signature.
International *uint64 `json:"International,omitempty" name:"International"`
// Signature purpose:
// 0: for personal use.
// 1: for others.
SignPurpose *uint64 `json:"SignPurpose,omitempty" name:"SignPurpose"`
// You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
ProofImage *string `json:"ProofImage,omitempty" name:"ProofImage"`
// Power of attorney, which should be submitted if `SignPurpose` is for use by others.
// You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
// Note: this field will take effect only when `SignPurpose` is 1 (for user by others).
CommissionImage *string `json:"CommissionImage,omitempty" name:"CommissionImage"`
// Signature application remarks.
Remark *string `json:"Remark,omitempty" name:"Remark"`
}
func NewModifySmsSignRequest ¶
func NewModifySmsSignRequest() (request *ModifySmsSignRequest)
func (*ModifySmsSignRequest) FromJsonString ¶
func (r *ModifySmsSignRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySmsSignRequest) ToJsonString ¶
func (r *ModifySmsSignRequest) ToJsonString() string
type ModifySmsSignResponse ¶
type ModifySmsSignResponse struct {
*tchttp.BaseResponse
Response *struct {
// Signature modification response
ModifySignStatus *ModifySignStatus `json:"ModifySignStatus,omitempty" name:"ModifySignStatus"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifySmsSignResponse ¶
func NewModifySmsSignResponse() (response *ModifySmsSignResponse)
func (*ModifySmsSignResponse) FromJsonString ¶
func (r *ModifySmsSignResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySmsSignResponse) ToJsonString ¶
func (r *ModifySmsSignResponse) ToJsonString() string
type ModifySmsTemplateRequest ¶
type ModifySmsTemplateRequest struct {
*tchttp.BaseRequest
// ID of the template to be modified.
TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`
// New template name.
TemplateName *string `json:"TemplateName,omitempty" name:"TemplateName"`
// New template content.
TemplateContent *string `json:"TemplateContent,omitempty" name:"TemplateContent"`
// SMS type. 0: regular SMS, 1: marketing SMS.
SmsType *uint64 `json:"SmsType,omitempty" name:"SmsType"`
// Whether it is Global SMS:
// 0: Mainland China SMS.
// 1: Global SMS.
International *uint64 `json:"International,omitempty" name:"International"`
// Template remarks, such as reason for application and use case.
Remark *string `json:"Remark,omitempty" name:"Remark"`
}
func NewModifySmsTemplateRequest ¶
func NewModifySmsTemplateRequest() (request *ModifySmsTemplateRequest)
func (*ModifySmsTemplateRequest) FromJsonString ¶
func (r *ModifySmsTemplateRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySmsTemplateRequest) ToJsonString ¶
func (r *ModifySmsTemplateRequest) ToJsonString() string
type ModifySmsTemplateResponse ¶
type ModifySmsTemplateResponse struct {
*tchttp.BaseResponse
Response *struct {
// Template parameter modification response
ModifyTemplateStatus *ModifyTemplateStatus `json:"ModifyTemplateStatus,omitempty" name:"ModifyTemplateStatus"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifySmsTemplateResponse ¶
func NewModifySmsTemplateResponse() (response *ModifySmsTemplateResponse)
func (*ModifySmsTemplateResponse) FromJsonString ¶
func (r *ModifySmsTemplateResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifySmsTemplateResponse) ToJsonString ¶
func (r *ModifySmsTemplateResponse) ToJsonString() string
type ModifyTemplateStatus ¶
type ModifyTemplateStatus struct {
// Template ID.
TemplateId *uint64 `json:"TemplateId,omitempty" name:"TemplateId"`
}
type PhoneNumberInfo ¶
type PhoneNumberInfo struct {
// Error code for mobile number information query. `Ok` will be returned if the query is successful.
Code *string `json:"Code,omitempty" name:"Code"`
// Description of the error code for mobile number information query.
Message *string `json:"Message,omitempty" name:"Message"`
// Country (or region) code.
NationCode *string `json:"NationCode,omitempty" name:"NationCode"`
// Subscriber number in normal format such as 13711112222, without any prefix (country or region code).
SubscriberNumber *string `json:"SubscriberNumber,omitempty" name:"SubscriberNumber"`
// The standardized mobile number in E.164 format after parsing, which is consistent with the parsed number for SMS message delivery. If the parsing fails, the original number will be returned.
PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`
// Country or region code such as CN and US. If the country or region code cannot be identified, `DEF` will be returned by default.
IsoCode *string `json:"IsoCode,omitempty" name:"IsoCode"`
// Country code or region name such as China. For more information, see [Global SMS Price Overview](https://intl.cloud.tencent.com/document/product/382/18051?from_cn_redirect=1#.E6.97.A5.E7.BB.93.E5.90.8E.E4.BB.98.E8.B4.B9.3Ca-id.3D.22post-payment.22.3E.3C.2Fa.3E)
IsoName *string `json:"IsoName,omitempty" name:"IsoName"`
}
type PullSmsReplyStatus ¶
type PullSmsReplyStatus struct {
// SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
ExtendCode *string `json:"ExtendCode,omitempty" name:"ExtendCode"`
// Country (or region) code.
CountryCode *string `json:"CountryCode,omitempty" name:"CountryCode"`
// Mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`
// SMS signature name.
SignName *string `json:"SignName,omitempty" name:"SignName"`
// User reply.
ReplyContent *string `json:"ReplyContent,omitempty" name:"ReplyContent"`
// Reply time in seconds in the format of UNIX timestamp.
ReplyTime *uint64 `json:"ReplyTime,omitempty" name:"ReplyTime"`
// User's mobile number in a common format such as 13711112222.
SubscriberNumber *string `json:"SubscriberNumber,omitempty" name:"SubscriberNumber"`
}
type PullSmsReplyStatusByPhoneNumberRequest ¶
type PullSmsReplyStatusByPhoneNumberRequest struct {
*tchttp.BaseRequest
// Pull start time in seconds in the format of UNIX timestamp.
// Note: the data for the last 7 days can be pulled at most.
BeginTime *uint64 `json:"BeginTime,omitempty" name:"BeginTime"`
// Offset.
// Note: this parameter is currently fixed at 0.
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// Maximum number of pulled entries. Maximum value: 100.
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// Target mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`
// The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
SmsSdkAppId *string `json:"SmsSdkAppId,omitempty" name:"SmsSdkAppId"`
// Pull end time in seconds in the format of UNIX timestamp.
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
}
func NewPullSmsReplyStatusByPhoneNumberRequest ¶
func NewPullSmsReplyStatusByPhoneNumberRequest() (request *PullSmsReplyStatusByPhoneNumberRequest)
func (*PullSmsReplyStatusByPhoneNumberRequest) FromJsonString ¶
func (r *PullSmsReplyStatusByPhoneNumberRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsReplyStatusByPhoneNumberRequest) ToJsonString ¶
func (r *PullSmsReplyStatusByPhoneNumberRequest) ToJsonString() string
type PullSmsReplyStatusByPhoneNumberResponse ¶
type PullSmsReplyStatusByPhoneNumberResponse struct {
*tchttp.BaseResponse
Response *struct {
// Reply status response set.
PullSmsReplyStatusSet []*PullSmsReplyStatus `json:"PullSmsReplyStatusSet,omitempty" name:"PullSmsReplyStatusSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewPullSmsReplyStatusByPhoneNumberResponse ¶
func NewPullSmsReplyStatusByPhoneNumberResponse() (response *PullSmsReplyStatusByPhoneNumberResponse)
func (*PullSmsReplyStatusByPhoneNumberResponse) FromJsonString ¶
func (r *PullSmsReplyStatusByPhoneNumberResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsReplyStatusByPhoneNumberResponse) ToJsonString ¶
func (r *PullSmsReplyStatusByPhoneNumberResponse) ToJsonString() string
type PullSmsReplyStatusRequest ¶
type PullSmsReplyStatusRequest struct {
*tchttp.BaseRequest
// Maximum number of pulled entries. Maximum value: 100.
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
SmsSdkAppId *string `json:"SmsSdkAppId,omitempty" name:"SmsSdkAppId"`
}
func NewPullSmsReplyStatusRequest ¶
func NewPullSmsReplyStatusRequest() (request *PullSmsReplyStatusRequest)
func (*PullSmsReplyStatusRequest) FromJsonString ¶
func (r *PullSmsReplyStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsReplyStatusRequest) ToJsonString ¶
func (r *PullSmsReplyStatusRequest) ToJsonString() string
type PullSmsReplyStatusResponse ¶
type PullSmsReplyStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// Reply status response set.
PullSmsReplyStatusSet []*PullSmsReplyStatus `json:"PullSmsReplyStatusSet,omitempty" name:"PullSmsReplyStatusSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewPullSmsReplyStatusResponse ¶
func NewPullSmsReplyStatusResponse() (response *PullSmsReplyStatusResponse)
func (*PullSmsReplyStatusResponse) FromJsonString ¶
func (r *PullSmsReplyStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsReplyStatusResponse) ToJsonString ¶
func (r *PullSmsReplyStatusResponse) ToJsonString() string
type PullSmsSendStatus ¶
type PullSmsSendStatus struct {
// Actual time of SMS receipt by user in seconds in the format of UNIX timestamp.
UserReceiveTime *uint64 `json:"UserReceiveTime,omitempty" name:"UserReceiveTime"`
// Country (or region) code.
CountryCode *string `json:"CountryCode,omitempty" name:"CountryCode"`
// User's mobile number in a common format such as 13711112222.
SubscriberNumber *string `json:"SubscriberNumber,omitempty" name:"SubscriberNumber"`
// Mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`
// ID of the current delivery.
SerialNo *string `json:"SerialNo,omitempty" name:"SerialNo"`
// Whether the SMS message is actually received. Valid values: SUCCESS (success), FAIL (failure).
ReportStatus *string `json:"ReportStatus,omitempty" name:"ReportStatus"`
// Description of SMS receipt by user.
Description *string `json:"Description,omitempty" name:"Description"`
}
type PullSmsSendStatusByPhoneNumberRequest ¶
type PullSmsSendStatusByPhoneNumberRequest struct {
*tchttp.BaseRequest
// Pull start time in seconds in the format of UNIX timestamp.
// Note: the data for the last 7 days can be pulled at most.
BeginTime *uint64 `json:"BeginTime,omitempty" name:"BeginTime"`
// Offset.
// Note: this parameter is currently fixed at 0.
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// Maximum number of pulled entries. Maximum value: 100.
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// Target mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`
// The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
SmsSdkAppId *string `json:"SmsSdkAppId,omitempty" name:"SmsSdkAppId"`
// Pull end time in seconds in the format of UNIX timestamp.
EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
}
func NewPullSmsSendStatusByPhoneNumberRequest ¶
func NewPullSmsSendStatusByPhoneNumberRequest() (request *PullSmsSendStatusByPhoneNumberRequest)
func (*PullSmsSendStatusByPhoneNumberRequest) FromJsonString ¶
func (r *PullSmsSendStatusByPhoneNumberRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsSendStatusByPhoneNumberRequest) ToJsonString ¶
func (r *PullSmsSendStatusByPhoneNumberRequest) ToJsonString() string
type PullSmsSendStatusByPhoneNumberResponse ¶
type PullSmsSendStatusByPhoneNumberResponse struct {
*tchttp.BaseResponse
Response *struct {
// Delivery status response set.
PullSmsSendStatusSet []*PullSmsSendStatus `json:"PullSmsSendStatusSet,omitempty" name:"PullSmsSendStatusSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewPullSmsSendStatusByPhoneNumberResponse ¶
func NewPullSmsSendStatusByPhoneNumberResponse() (response *PullSmsSendStatusByPhoneNumberResponse)
func (*PullSmsSendStatusByPhoneNumberResponse) FromJsonString ¶
func (r *PullSmsSendStatusByPhoneNumberResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsSendStatusByPhoneNumberResponse) ToJsonString ¶
func (r *PullSmsSendStatusByPhoneNumberResponse) ToJsonString() string
type PullSmsSendStatusRequest ¶
type PullSmsSendStatusRequest struct {
*tchttp.BaseRequest
// Maximum number of pulled entries. Maximum value: 100.
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
SmsSdkAppId *string `json:"SmsSdkAppId,omitempty" name:"SmsSdkAppId"`
}
func NewPullSmsSendStatusRequest ¶
func NewPullSmsSendStatusRequest() (request *PullSmsSendStatusRequest)
func (*PullSmsSendStatusRequest) FromJsonString ¶
func (r *PullSmsSendStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsSendStatusRequest) ToJsonString ¶
func (r *PullSmsSendStatusRequest) ToJsonString() string
type PullSmsSendStatusResponse ¶
type PullSmsSendStatusResponse struct {
*tchttp.BaseResponse
Response *struct {
// Delivery status response set.
PullSmsSendStatusSet []*PullSmsSendStatus `json:"PullSmsSendStatusSet,omitempty" name:"PullSmsSendStatusSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewPullSmsSendStatusResponse ¶
func NewPullSmsSendStatusResponse() (response *PullSmsSendStatusResponse)
func (*PullSmsSendStatusResponse) FromJsonString ¶
func (r *PullSmsSendStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PullSmsSendStatusResponse) ToJsonString ¶
func (r *PullSmsSendStatusResponse) ToJsonString() string
type SendSmsRequest ¶
type SendSmsRequest struct {
*tchttp.BaseRequest
// Target mobile number in E.164 format (+[country/region code][subscriber number]). Up to 200 numbers, all of which should be either Chinese mainland numbers or international numbers, are supported in a single request.
// Take the number +8613711112222 as an example. “86” is the country code (with a “+” sign in its front) and “13711112222” is the subscriber number.
// Note: 11-digit Chinese mainland numbers prefixed by 0086 or 86 or those without any country/region code are also supported. The default prefix is +86.
PhoneNumberSet []*string `json:"PhoneNumberSet,omitempty" name:"PhoneNumberSet"`
// The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
SmsSdkAppId *string `json:"SmsSdkAppId,omitempty" name:"SmsSdkAppId"`
// Template ID. You must enter the ID of an approved template, which can be viewed on the [Chinese Mainland SMS](https://console.cloud.tencent.com/smsv2/csms-template) or [Global SMS](https://console.cloud.tencent.com/smsv2/isms-template) body template management page. If you need to send SMS messages to global mobile numbers, you can only use a Global SMS template.
TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`
// Content of the SMS signature, which should be encoded in UTF-8. You must enter an approved signature, such as Tencent Cloud. The signature information can be viewed on the [Chinese Mainland SMS](https://console.cloud.tencent.com/smsv2/csms-sign) or [Global SMS](https://console.cloud.tencent.com/smsv2/isms-sign) signature management page.
// <dx-alert infotype="notice" title="Note">This parameter is required for Chinese Mainland SMS.</dx-alert>
SignName *string `json:"SignName,omitempty" name:"SignName"`
// Template parameter. If there is no template parameter, leave this field empty.
// <dx-alert infotype="notice" title="Note">The number of template parameters should be consistent with that of the template variables of `TemplateId`.</dx-alert>
TemplateParamSet []*string `json:"TemplateParamSet,omitempty" name:"TemplateParamSet"`
// SMS code number extension, which is not activated by default. If you need to activate it, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
ExtendCode *string `json:"ExtendCode,omitempty" name:"ExtendCode"`
// User session content, which can carry context information such as user-side ID and will be returned as-is by the server.
SessionContext *string `json:"SessionContext,omitempty" name:"SessionContext"`
// This parameter is not required for Chinese Mainland SMS. For Global SMS, if you have applied for a separate `SenderId`, this parameter is required. By default, the public `SenderId` is used, in which case you don't need to enter this parameter.
// Note: if your monthly usage reaches the specified threshold, you can apply for an independent `SenderId`. For more information, contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
SenderId *string `json:"SenderId,omitempty" name:"SenderId"`
}
func NewSendSmsRequest ¶
func NewSendSmsRequest() (request *SendSmsRequest)
func (*SendSmsRequest) FromJsonString ¶
func (r *SendSmsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SendSmsRequest) ToJsonString ¶
func (r *SendSmsRequest) ToJsonString() string
type SendSmsResponse ¶
type SendSmsResponse struct {
*tchttp.BaseResponse
Response *struct {
// SMS delivery status.
SendStatusSet []*SendStatus `json:"SendStatusSet,omitempty" name:"SendStatusSet"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewSendSmsResponse ¶
func NewSendSmsResponse() (response *SendSmsResponse)
func (*SendSmsResponse) FromJsonString ¶
func (r *SendSmsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SendSmsResponse) ToJsonString ¶
func (r *SendSmsResponse) ToJsonString() string
type SendStatus ¶
type SendStatus struct {
// Delivery serial number.
SerialNo *string `json:"SerialNo,omitempty" name:"SerialNo"`
// Mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"`
// Number of billable SMS messages. For billing rules, see Billing Policy.
Fee *uint64 `json:"Fee,omitempty" name:"Fee"`
// User session content.
SessionContext *string `json:"SessionContext,omitempty" name:"SessionContext"`
// SMS request error code. For specific meanings, see [Error Codes](https://intl.cloud.tencent.com/zh/document/product/382/40536#6.-error-code). `Ok` will be returned for successful delivery.
Code *string `json:"Code,omitempty" name:"Code"`
// SMS request error message.
Message *string `json:"Message,omitempty" name:"Message"`
// Country/Region code, such as CN and US. For unrecognized country/region codes, `DEF` is returned by default. For the specific list of supported values, please see [Global SMS Price Overview](https://intl.cloud.tencent.com/document/product/382/18051?from_cn_redirect=1).
IsoCode *string `json:"IsoCode,omitempty" name:"IsoCode"`
}
type SendStatusStatistics ¶
type SendStatusStatistics struct {
// Billable SMS message quantity; for example, in 100 successfully submitted SMS messages, if 20 ones are long messages (over 80 characters) and split into two messages each, then the billable quantity will be 80 * 1 + 20 * 2 = 120.
FeeCount *uint64 `json:"FeeCount,omitempty" name:"FeeCount"`
// Submitted SMS messages.
RequestCount *uint64 `json:"RequestCount,omitempty" name:"RequestCount"`
// Successfully submitted SMS messages.
RequestSuccessCount *uint64 `json:"RequestSuccessCount,omitempty" name:"RequestSuccessCount"`
}
type SendStatusStatisticsRequest ¶
type SendStatusStatisticsRequest struct {
*tchttp.BaseRequest
// Start time in the format of `yyyymmddhh` accurate to the hour, such as 2021050113 (13:00 on May 1, 2021).
BeginTime *string `json:"BeginTime,omitempty" name:"BeginTime"`
// End time in the format of `yyyymmddhh` accurate to the hour, such as 2021050118 (18:00 on May 1, 2021).
// Note: `EndTime` must be after `BeginTime`.
EndTime *string `json:"EndTime,omitempty" name:"EndTime"`
// The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
SmsSdkAppId *string `json:"SmsSdkAppId,omitempty" name:"SmsSdkAppId"`
// Upper limit.
// Note: this parameter is currently fixed at 0.
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// Offset.
// Note: this parameter is currently fixed at 0.
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}
func NewSendStatusStatisticsRequest ¶
func NewSendStatusStatisticsRequest() (request *SendStatusStatisticsRequest)
func (*SendStatusStatisticsRequest) FromJsonString ¶
func (r *SendStatusStatisticsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SendStatusStatisticsRequest) ToJsonString ¶
func (r *SendStatusStatisticsRequest) ToJsonString() string
type SendStatusStatisticsResponse ¶
type SendStatusStatisticsResponse struct {
*tchttp.BaseResponse
Response *struct {
// Delivery statistics response body.
SendStatusStatistics *SendStatusStatistics `json:"SendStatusStatistics,omitempty" name:"SendStatusStatistics"`
// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewSendStatusStatisticsResponse ¶
func NewSendStatusStatisticsResponse() (response *SendStatusStatisticsResponse)
func (*SendStatusStatisticsResponse) FromJsonString ¶
func (r *SendStatusStatisticsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SendStatusStatisticsResponse) ToJsonString ¶
func (r *SendStatusStatisticsResponse) ToJsonString() string
Source Files
Click to show internal directories.
Click to hide internal directories.