第一次提交：阿龙电竞 Django 后端最新版本
This commit is contained in:
XingQue
@@ -0,0 +1,270 @@
|
||||
# -*- coding: utf8 -*-
|
||||
# Copyright (c) 2017-2025 Tencent. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
|
||||
# 短信内容中含有敏感词，请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_CONTAINSENSITIVEWORD = 'FailedOperation.ContainSensitiveWord'
|
||||
|
||||
# 请求包解析失败，通常情况下是由于没有遵守 API 接口说明规范导致的，请参考 [请求包体解析1004错误详解](https://cloud.tencent.com/document/product/382/9558#.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'
|
||||
|
||||
# 套餐包余量不足，请 [购买套餐包](https://buy.cloud.tencent.com/sms)。
|
||||
FAILEDOPERATION_INSUFFICIENTBALANCEINSMSPACKAGE = 'FailedOperation.InsufficientBalanceInSmsPackage'
|
||||
|
||||
# 解析请求包体时候失败。
|
||||
FAILEDOPERATION_JSONPARSEFAIL = 'FailedOperation.JsonParseFail'
|
||||
|
||||
# 营销短信发送时间限制，为避免骚扰用户，营销短信只允许在8点到22点发送。
|
||||
FAILEDOPERATION_MARKETINGSENDTIMECONSTRAINT = 'FailedOperation.MarketingSendTimeConstraint'
|
||||
|
||||
# 没有申请签名之前，无法申请模板，请根据 [创建签名](https://cloud.tencent.com/document/product/382/37794#.E5.88.9B.E5.BB.BA.E7.AD.BE.E5.90.8D) 申请完成之后再次申请。
|
||||
FAILEDOPERATION_MISSINGSIGNATURE = 'FailedOperation.MissingSignature'
|
||||
|
||||
# 无法识别签名，请确认是否已有签名通过申请，一般是签名未通过申请，可以查看 [签名审核](https://cloud.tencent.com/document/product/382/37745)。
|
||||
FAILEDOPERATION_MISSINGSIGNATURELIST = 'FailedOperation.MissingSignatureList'
|
||||
|
||||
# 此签名 ID 未提交申请或不存在，不能进行修改操作，请检查您的 SignId 是否填写正确。
|
||||
FAILEDOPERATION_MISSINGSIGNATURETOMODIFY = 'FailedOperation.MissingSignatureToModify'
|
||||
|
||||
# 无法识别模板，请确认是否已有模板通过申请，一般是模板未通过申请，可以查看 [模板审核](https://cloud.tencent.com/document/product/382/37745)。
|
||||
FAILEDOPERATION_MISSINGTEMPLATELIST = 'FailedOperation.MissingTemplateList'
|
||||
|
||||
# 此模板 ID 未提交申请或不存在，不能进行修改操作，请检查您的 TemplateId是否填写正确。
|
||||
FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = 'FailedOperation.MissingTemplateToModify'
|
||||
|
||||
# 非企业认证无法使用签名及模板相关接口，您可以[ 变更实名认证模式](https://cloud.tencent.com/document/product/378/34075)，变更为企业认证用户后，约1小时左右生效。
|
||||
FAILEDOPERATION_NOTENTERPRISECERTIFICATION = 'FailedOperation.NotEnterpriseCertification'
|
||||
|
||||
# 其他错误，一般是由于参数携带不符合要求导致，请参考API接口说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_OTHERERROR = 'FailedOperation.OtherError'
|
||||
|
||||
# 未知错误，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_PARAMETERSOTHERERROR = 'FailedOperation.ParametersOtherError'
|
||||
|
||||
# 手机号在免打扰名单库中，通常是用户退订或者命中运营商免打扰名单导致的，可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 解决。
|
||||
FAILEDOPERATION_PHONENUMBERINBLACKLIST = 'FailedOperation.PhoneNumberInBlacklist'
|
||||
|
||||
# 资质ID未审核通过。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。
|
||||
FAILEDOPERATION_QUALIFICATIONIDNOTAPPROVED = 'FailedOperation.QualificationIdNotApproved'
|
||||
|
||||
# 签名 ID 不存在。
|
||||
FAILEDOPERATION_SIGNIDNOTEXIST = 'FailedOperation.SignIdNotExist'
|
||||
|
||||
# 签名个数达到最大值。
|
||||
FAILEDOPERATION_SIGNNUMBERLIMIT = 'FailedOperation.SignNumberLimit'
|
||||
|
||||
# 签名未审批或格式错误。（1）可登录 [短信控制台](https://console.cloud.tencent.com/smsv2)，核查签名是否已审批并且审批通过；（2）核查是否符合格式规范，签名只能由中英文、数字组成，要求2 - 12个字，若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_SIGNATUREINCORRECTORUNAPPROVED = 'FailedOperation.SignatureIncorrectOrUnapproved'
|
||||
|
||||
# 此模板已经通过审核，无法再次进行修改。
|
||||
FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = 'FailedOperation.TemplateAlreadyPassedCheck'
|
||||
|
||||
# 模板 ID 不存在。
|
||||
FAILEDOPERATION_TEMPLATEIDNOTEXIST = 'FailedOperation.TemplateIdNotExist'
|
||||
|
||||
# 模板未审批或内容不匹配。（1）可登录 [短信控制台](https://console.cloud.tencent.com/smsv2)，核查模板是否已审批并审批通过；（2）核查是否符合 [格式规范](https://cloud.tencent.com/document/product/382/9558#.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)，若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_TEMPLATEINCORRECTORUNAPPROVED = 'FailedOperation.TemplateIncorrectOrUnapproved'
|
||||
|
||||
# 模板个数达到最大值。
|
||||
FAILEDOPERATION_TEMPLATENUMBERLIMIT = 'FailedOperation.TemplateNumberLimit'
|
||||
|
||||
# 请求内容与审核通过的模板内容不匹配。请检查请求中模板参数的个数是否与申请的模板一致。若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_TEMPLATEPARAMSETNOTMATCHAPPROVEDTEMPLATE = 'FailedOperation.TemplateParamSetNotMatchApprovedTemplate'
|
||||
|
||||
# 模板未审批或不存在。可登录 [短信控制台](https://console.cloud.tencent.com/smsv2)，核查模板是否已审批并审批通过。若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_TEMPLATEUNAPPROVEDORNOTEXIST = 'FailedOperation.TemplateUnapprovedOrNotExist'
|
||||
|
||||
# 后台构造用户参数失败，可联系 [sms helper](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 。
|
||||
INTERNALERROR_CONSTRUCTUSERDATAFAIL = 'InternalError.ConstructUserDataFail'
|
||||
|
||||
# 解析用户参数失败，可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INTERNALERROR_JSONPARSEFAIL = 'InternalError.JsonParseFail'
|
||||
|
||||
# 其他错误，请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 并提供失败手机号。
|
||||
INTERNALERROR_OTHERERROR = 'InternalError.OtherError'
|
||||
|
||||
# 解析运营商包体失败，可联系 [sms helper](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 。
|
||||
INTERNALERROR_PARSEBACKENDRESPONSEFAIL = 'InternalError.ParseBackendResponseFail'
|
||||
|
||||
# 请求发起时间不正常，通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的，请核对服务器时间及 API 接口中的时间字段是否正常。
|
||||
INTERNALERROR_REQUESTTIMEEXCEPTION = 'InternalError.RequestTimeException'
|
||||
|
||||
# 不存在该 RESTAPI 接口，请核查 REST API 接口说明。
|
||||
INTERNALERROR_RESTAPIINTERFACENOTEXIST = 'InternalError.RestApiInterfaceNotExist'
|
||||
|
||||
# 接口超时或短信收发包超时，请检查您的网络是否有波动，或联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 解决。
|
||||
INTERNALERROR_SENDANDRECVFAIL = 'InternalError.SendAndRecvFail'
|
||||
|
||||
# 后端包体中请求包体没有 Sig 字段或 Sig 为空。
|
||||
INTERNALERROR_SIGFIELDMISSING = 'InternalError.SigFieldMissing'
|
||||
|
||||
# 后端校验 Sig 失败。
|
||||
INTERNALERROR_SIGVERIFICATIONFAIL = 'InternalError.SigVerificationFail'
|
||||
|
||||
# 请求下发短信超时，请参考 [60008错误详解](https://cloud.tencent.com/document/product/382/9558#.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'
|
||||
|
||||
# 未知错误类型。
|
||||
INTERNALERROR_UNKNOWNERROR = 'InternalError.UnknownError'
|
||||
|
||||
# 参数错误。
|
||||
INVALIDPARAMETER = 'InvalidParameter'
|
||||
|
||||
# 账号与应用id不匹配。
|
||||
INVALIDPARAMETER_APPIDANDBIZID = 'InvalidParameter.AppidAndBizId'
|
||||
|
||||
# 参数有误，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETER_INVALIDPARAMETERS = 'InvalidParameter.InvalidParameters'
|
||||
|
||||
# 参数 BeginTime 校验失败。
|
||||
INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = 'InvalidParameterValue.BeginTimeVerifyFail'
|
||||
|
||||
# 请求的短信内容太长，短信长度规则请参考 [国内短信内容长度计算规则](https://cloud.tencent.com/document/product/382/18058) 或 [国际/港澳台短信内容长度计算规则](https://cloud.tencent.com/document/product/382/18052#size)。
|
||||
INVALIDPARAMETERVALUE_CONTENTLENGTHLIMIT = 'InvalidParameterValue.ContentLengthLimit'
|
||||
|
||||
# 参数 EndTime 校验失败。
|
||||
INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = 'InvalidParameterValue.EndTimeVerifyFail'
|
||||
|
||||
# 上传的转码图片格式错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_IMAGEINVALID = 'InvalidParameterValue.ImageInvalid'
|
||||
|
||||
# 手机号格式错误。
|
||||
INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = 'InvalidParameterValue.IncorrectPhoneNumber'
|
||||
|
||||
# DocumentType 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDDOCUMENTTYPE = 'InvalidParameterValue.InvalidDocumentType'
|
||||
|
||||
# International 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = 'InvalidParameterValue.InvalidInternational'
|
||||
|
||||
# SmsType 字段校验错误，请参照 API 接口说明中对该字段的描述，更多疑问可咨询 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDSMSTYPE = 'InvalidParameterValue.InvalidSmsType'
|
||||
|
||||
# 无效的拉取起始/截止时间，具体原因可能是请求的 SendDateTime 大于 EndDateTime。
|
||||
INVALIDPARAMETERVALUE_INVALIDSTARTTIME = 'InvalidParameterValue.InvalidStartTime'
|
||||
|
||||
# UsedMethod 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDUSEDMETHOD = 'InvalidParameterValue.InvalidUsedMethod'
|
||||
|
||||
# 营销短信必须包含退订方式，请在短信模板尾部添加“拒收请回复R”后提交。可参考 [关于营销短信退订标识修改的公告](https://cloud.tencent.com/document/product/382/100568)。
|
||||
INVALIDPARAMETERVALUE_MARKETINGTEMPLATEWITHOUTUNSUBSCRIBE = 'InvalidParameterValue.MarketingTemplateWithoutUnsubscribe'
|
||||
|
||||
# 无法识别签名，请确认是否已有签名通过申请，一般是签名未通过申请，可以查看 [签名审核](https://cloud.tencent.com/document/product/382/37745#.E6.AD.A5.E9.AA.A43.EF.BC.9A.E7.AD.89.E5.BE.85.E5.AE.A1.E6.A0.B8) 。
|
||||
INVALIDPARAMETERVALUE_MISSINGSIGNATURELIST = 'InvalidParameterValue.MissingSignatureList'
|
||||
|
||||
# 禁止在模板变量中使用 URL。您可以参考正文模板审核标准下关于 [变量规范](https://cloud.tencent.com/document/product/382/39023#variable) 的描述
|
||||
INVALIDPARAMETERVALUE_PROHIBITEDUSEURLINTEMPLATEPARAMETER = 'InvalidParameterValue.ProhibitedUseUrlInTemplateParameter'
|
||||
|
||||
# 资质ID未找到。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。
|
||||
INVALIDPARAMETERVALUE_QUALIFICATIONIDNOTFOUND = 'InvalidParameterValue.QualificationIdNotFound'
|
||||
|
||||
# SdkAppId 不存在。
|
||||
INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = 'InvalidParameterValue.SdkAppIdNotExist'
|
||||
|
||||
# 此签名已经通过审核，无法再次进行修改。
|
||||
INVALIDPARAMETERVALUE_SIGNALREADYPASSEDCHECK = 'InvalidParameterValue.SignAlreadyPassedCheck'
|
||||
|
||||
# 已存在相同的待审核签名。
|
||||
INVALIDPARAMETERVALUE_SIGNEXISTANDUNAPPROVED = 'InvalidParameterValue.SignExistAndUnapproved'
|
||||
|
||||
# 签名内容长度过长。
|
||||
INVALIDPARAMETERVALUE_SIGNNAMELENGTHTOOLONG = 'InvalidParameterValue.SignNameLengthTooLong'
|
||||
|
||||
# 验证码模板参数格式错误，验证码类模板，模板变量只能传入0 - 6位（包括6位）纯数字。
|
||||
INVALIDPARAMETERVALUE_TEMPLATEPARAMETERFORMATERROR = 'InvalidParameterValue.TemplateParameterFormatError'
|
||||
|
||||
# 单个模板变量字符数超过规定的限制数。您可以参考 <a href="https://cloud.tencent.com/document/product/382/39023#variable">正文模板审核标准</a>下变量规范中关于长度的描述，对于长期未使用的账号及2024年1月25日后开通新账号默认最长支持6个字符，您的账号具体可支持字符长度以<a href="https://console.cloud.tencent.com/smsv2/csms-template/create">控制台显示为准</a>。更多疑问可联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 。
|
||||
INVALIDPARAMETERVALUE_TEMPLATEPARAMETERLENGTHLIMIT = 'InvalidParameterValue.TemplateParameterLengthLimit'
|
||||
|
||||
# 申请国内短信通知和营销短信模板不支持添加变量。可参考 [控制台说明](https://console.cloud.tencent.com/smsv2/csms-template)，更多疑问可咨询 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)
|
||||
INVALIDPARAMETERVALUE_UNSUPPORTEDTEMPLATEVARIABLE = 'InvalidParameterValue.UnsupportedTemplateVariable'
|
||||
|
||||
# 业务短信国家/地区日下发条数超过设定的上限，可自行到控制台应用管理>基础配置下调整国际港澳台短信发送限制。
|
||||
LIMITEXCEEDED_APPCOUNTRYORREGIONDAILYLIMIT = 'LimitExceeded.AppCountryOrRegionDailyLimit'
|
||||
|
||||
# 业务短信国家/地区不在国际港澳台短信发送限制设置的列表中而禁发，可自行到控制台应用管理>基础配置下调整国际港澳台短信发送限制。
|
||||
LIMITEXCEEDED_APPCOUNTRYORREGIONINBLACKLIST = 'LimitExceeded.AppCountryOrRegionInBlacklist'
|
||||
|
||||
# 业务短信日下发条数超过设定的上限 ，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_APPDAILYLIMIT = 'LimitExceeded.AppDailyLimit'
|
||||
|
||||
# 业务短信国际/港澳台日下发条数超过设定的上限，可自行到控制台应用管理>基础配置下调整发送总量阈值。
|
||||
LIMITEXCEEDED_APPGLOBALDAILYLIMIT = 'LimitExceeded.AppGlobalDailyLimit'
|
||||
|
||||
# 业务短信中国大陆日下发条数超过设定的上限，可自行到控制台应用管理>基础配置下调整发送总量阈值。
|
||||
LIMITEXCEEDED_APPMAINLANDCHINADAILYLIMIT = 'LimitExceeded.AppMainlandChinaDailyLimit'
|
||||
|
||||
# 短信日下发条数超过设定的上限 (国际/港澳台)，如需调整限制，可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773)。
|
||||
LIMITEXCEEDED_DAILYLIMIT = 'LimitExceeded.DailyLimit'
|
||||
|
||||
# 下发短信命中了频率限制策略，可自行到控制台调整短信频率限制策略，如有其他需求请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
LIMITEXCEEDED_DELIVERYFREQUENCYLIMIT = 'LimitExceeded.DeliveryFrequencyLimit'
|
||||
|
||||
# 调用接口单次提交的手机号个数超过200个，请遵守 API 接口输入参数 PhoneNumberSet 描述。
|
||||
LIMITEXCEEDED_PHONENUMBERCOUNTLIMIT = 'LimitExceeded.PhoneNumberCountLimit'
|
||||
|
||||
# 单个手机号日下发短信条数超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERDAILYLIMIT = 'LimitExceeded.PhoneNumberDailyLimit'
|
||||
|
||||
# 单个手机号1小时内下发短信条数超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERONEHOURLIMIT = 'LimitExceeded.PhoneNumberOneHourLimit'
|
||||
|
||||
# 单个手机号下发相同内容超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERSAMECONTENTDAILYLIMIT = 'LimitExceeded.PhoneNumberSameContentDailyLimit'
|
||||
|
||||
# 单个手机号30秒内下发短信条数超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERTHIRTYSECONDLIMIT = 'LimitExceeded.PhoneNumberThirtySecondLimit'
|
||||
|
||||
# 缺少参数错误。
|
||||
MISSINGPARAMETER = 'MissingParameter'
|
||||
|
||||
# 传入的号码列表为空，请确认您的参数中是否传入号码。
|
||||
MISSINGPARAMETER_EMPTYPHONENUMBERSET = 'MissingParameter.EmptyPhoneNumberSet'
|
||||
|
||||
# 账户下无此签名或者模板，请登录控制台查询。
|
||||
MISSINGPARAMETER_MISSINGSIGNATURELIST = 'MissingParameter.MissingSignatureList'
|
||||
|
||||
# 个人用户没有发营销短信的权限，请参考 [权益区别](https://cloud.tencent.com/document/product/382/13444)。
|
||||
UNAUTHORIZEDOPERATION_INDIVIDUALUSERMARKETINGSMSPERMISSIONDENY = 'UnauthorizedOperation.IndividualUserMarketingSmsPermissionDeny'
|
||||
|
||||
# 请求 IP 不在白名单中，您配置了校验请求来源 IP，但是检测到当前请求 IP 不在配置列表中，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = 'UnauthorizedOperation.RequestIpNotInWhitelist'
|
||||
|
||||
# 请求没有权限，请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = 'UnauthorizedOperation.RequestPermissionDeny'
|
||||
|
||||
# 此 SdkAppId 禁止提供服务，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = 'UnauthorizedOperation.SdkAppIdIsDisabled'
|
||||
|
||||
# 欠费被停止服务，可自行登录腾讯云充值来缴清欠款。
|
||||
UNAUTHORIZEDOPERATION_SERVICESUSPENDDUETOARREARS = 'UnauthorizedOperation.ServiceSuspendDueToArrears'
|
||||
|
||||
# SmsSdkAppId 校验失败，请检查 [SmsSdkAppId](https://console.cloud.tencent.com/smsv2/app-manage) 是否属于 [云API密钥](https://console.cloud.tencent.com/cam/capi) 的关联账户。
|
||||
UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = 'UnauthorizedOperation.SmsSdkAppIdVerifyFail'
|
||||
|
||||
# 操作不支持。
|
||||
UNSUPPORTEDOPERATION = 'UnsupportedOperation'
|
||||
|
||||
# 国内短信模板不支持发送国际/港澳台手机号。发送国际/港澳台手机号请使用国际/港澳台短信正文模板。
|
||||
UNSUPPORTEDOPERATION_CHINESEMAINLANDTEMPLATETOGLOBALPHONE = 'UnsupportedOperation.ChineseMainlandTemplateToGlobalPhone'
|
||||
|
||||
# 群发请求里既有国内手机号也有国际手机号。请排查是否存在（1）使用国内签名或模板却发送短信到国际手机号；（2）使用国际签名或模板却发送短信到国内手机号。
|
||||
UNSUPPORTEDOPERATION_CONTAINDOMESTICANDINTERNATIONALPHONENUMBER = 'UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber'
|
||||
|
||||
# 国际/港澳台短信模板不支持发送国内手机号。发送国内手机号请使用国内短信正文模板。
|
||||
UNSUPPORTEDOPERATION_GLOBALTEMPLATETOCHINESEMAINLANDPHONE = 'UnsupportedOperation.GlobalTemplateToChineseMainlandPhone'
|
||||
|
||||
# 不支持该地区短信下发。
|
||||
UNSUPPORTEDOPERATION_UNSUPPORTEDREGION = 'UnsupportedOperation.UnsupportedRegion'
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,406 @@
|
||||
# -*- coding: utf8 -*-
|
||||
# Copyright (c) 2017-2025 Tencent. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
import json
|
||||
|
||||
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
|
||||
from tencentcloud.common.abstract_client import AbstractClient
|
||||
from tencentcloud.sms.v20190711 import models
|
||||
|
||||
|
||||
class SmsClient(AbstractClient):
|
||||
_apiVersion = '2019-07-11'
|
||||
_endpoint = 'sms.tencentcloudapi.com'
|
||||
_service = 'sms'
|
||||
|
||||
|
||||
def AddSmsSign(self, request):
|
||||
r"""本接口 (AddSmsSign) 用于添加短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>添加短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信签名。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for AddSmsSign.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.AddSmsSignRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.AddSmsSignResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("AddSmsSign", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.AddSmsSignResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def AddSmsTemplate(self, request):
|
||||
r"""本接口 (AddSmsTemplate) 用于创建短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>申请短信模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信正文模板。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for AddSmsTemplate.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.AddSmsTemplateRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.AddSmsTemplateResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("AddSmsTemplate", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.AddSmsTemplateResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def CallbackStatusStatistics(self, request):
|
||||
r"""本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
|
||||
|
||||
:param request: Request instance for CallbackStatusStatistics.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.CallbackStatusStatisticsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.CallbackStatusStatisticsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("CallbackStatusStatistics", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.CallbackStatusStatisticsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DeleteSmsSign(self, request):
|
||||
r"""本接口 (DeleteSmsSign) 用于删除短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信签名。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DeleteSmsSign.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.DeleteSmsSignRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.DeleteSmsSignResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DeleteSmsSign", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DeleteSmsSignResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DeleteSmsTemplate(self, request):
|
||||
r"""本接口 (DeleteSmsTemplate) 用于删除短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信正文模板。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DeleteSmsTemplate.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.DeleteSmsTemplateRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.DeleteSmsTemplateResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DeleteSmsTemplate", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DeleteSmsTemplateResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DescribeSmsSignList(self, request):
|
||||
r"""本接口 (DescribeSmsSignList) 用于查询短信签名状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信签名。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DescribeSmsSignList.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.DescribeSmsSignListRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.DescribeSmsSignListResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DescribeSmsSignList", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DescribeSmsSignListResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DescribeSmsTemplateList(self, request):
|
||||
r"""本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信正文模板。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DescribeSmsTemplateList.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.DescribeSmsTemplateListRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.DescribeSmsTemplateListResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DescribeSmsTemplateList", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DescribeSmsTemplateListResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def ModifySmsSign(self, request):
|
||||
r"""本接口 (ModifySmsSign) 用于修改短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信签名。</li><li>修改短信签名，仅当签名为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的签名不支持修改。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for ModifySmsSign.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.ModifySmsSignRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.ModifySmsSignResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("ModifySmsSign", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.ModifySmsSignResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def ModifySmsTemplate(self, request):
|
||||
r"""本接口 (ModifySmsTemplate) 用于修改短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信正文模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信正文模板。</li><li>修改短信模板，仅当正文模板为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的正文模板不支持修改。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for ModifySmsTemplate.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.ModifySmsTemplateRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.ModifySmsTemplateResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("ModifySmsTemplate", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.ModifySmsTemplateResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsReplyStatus(self, request):
|
||||
r"""本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsReplyStatus.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.PullSmsReplyStatusRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.PullSmsReplyStatusResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsReplyStatus", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsReplyStatusResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsReplyStatusByPhoneNumber(self, request):
|
||||
r"""本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsReplyStatusByPhoneNumber.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.PullSmsReplyStatusByPhoneNumberRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.PullSmsReplyStatusByPhoneNumberResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsReplyStatusByPhoneNumber", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsReplyStatusByPhoneNumberResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsSendStatus(self, request):
|
||||
r"""本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsSendStatus.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.PullSmsSendStatusRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.PullSmsSendStatusResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsSendStatus", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsSendStatusResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsSendStatusByPhoneNumber(self, request):
|
||||
r"""本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsSendStatusByPhoneNumber.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.PullSmsSendStatusByPhoneNumberRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.PullSmsSendStatusByPhoneNumberResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsSendStatusByPhoneNumber", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsSendStatusByPhoneNumberResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def SendSms(self, request):
|
||||
r"""本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。
|
||||
|
||||
:param request: Request instance for SendSms.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.SendSmsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.SendSmsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("SendSms", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.SendSmsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def SendStatusStatistics(self, request):
|
||||
r"""本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
|
||||
|
||||
:param request: Request instance for SendStatusStatistics.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.SendStatusStatisticsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.SendStatusStatisticsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("SendStatusStatistics", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.SendStatusStatisticsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def SmsPackagesStatistics(self, request):
|
||||
r"""本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
|
||||
|
||||
:param request: Request instance for SmsPackagesStatistics.
|
||||
:type request: :class:`tencentcloud.sms.v20190711.models.SmsPackagesStatisticsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20190711.models.SmsPackagesStatisticsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("SmsPackagesStatistics", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.SmsPackagesStatisticsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
@@ -0,0 +1,326 @@
|
||||
# -*- coding: utf8 -*-
|
||||
# Copyright (c) 2017-2025 Tencent. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
|
||||
|
||||
from tencentcloud.common.abstract_client_async import AbstractClient
|
||||
from tencentcloud.sms.v20190711 import models
|
||||
from typing import Dict
|
||||
|
||||
|
||||
class SmsClient(AbstractClient):
|
||||
_apiVersion = '2019-07-11'
|
||||
_endpoint = 'sms.tencentcloudapi.com'
|
||||
_service = 'sms'
|
||||
|
||||
async def AddSmsSign(
|
||||
self,
|
||||
request: models.AddSmsSignRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.AddSmsSignResponse:
|
||||
"""
|
||||
本接口 (AddSmsSign) 用于添加短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>添加短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信签名。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "AddSmsSign"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.AddSmsSignResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def AddSmsTemplate(
|
||||
self,
|
||||
request: models.AddSmsTemplateRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.AddSmsTemplateResponse:
|
||||
"""
|
||||
本接口 (AddSmsTemplate) 用于创建短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>申请短信模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信正文模板。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "AddSmsTemplate"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.AddSmsTemplateResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def CallbackStatusStatistics(
|
||||
self,
|
||||
request: models.CallbackStatusStatisticsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.CallbackStatusStatisticsResponse:
|
||||
"""
|
||||
本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "CallbackStatusStatistics"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.CallbackStatusStatisticsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DeleteSmsSign(
|
||||
self,
|
||||
request: models.DeleteSmsSignRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DeleteSmsSignResponse:
|
||||
"""
|
||||
本接口 (DeleteSmsSign) 用于删除短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信签名。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DeleteSmsSign"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DeleteSmsSignResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DeleteSmsTemplate(
|
||||
self,
|
||||
request: models.DeleteSmsTemplateRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DeleteSmsTemplateResponse:
|
||||
"""
|
||||
本接口 (DeleteSmsTemplate) 用于删除短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信正文模板。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DeleteSmsTemplate"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DeleteSmsTemplateResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DescribeSmsSignList(
|
||||
self,
|
||||
request: models.DescribeSmsSignListRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DescribeSmsSignListResponse:
|
||||
"""
|
||||
本接口 (DescribeSmsSignList) 用于查询短信签名状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信签名。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DescribeSmsSignList"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DescribeSmsSignListResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DescribeSmsTemplateList(
|
||||
self,
|
||||
request: models.DescribeSmsTemplateListRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DescribeSmsTemplateListResponse:
|
||||
"""
|
||||
本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信正文模板。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DescribeSmsTemplateList"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DescribeSmsTemplateListResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def ModifySmsSign(
|
||||
self,
|
||||
request: models.ModifySmsSignRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.ModifySmsSignResponse:
|
||||
"""
|
||||
本接口 (ModifySmsSign) 用于修改短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信签名。</li><li>修改短信签名，仅当签名为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的签名不支持修改。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "ModifySmsSign"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.ModifySmsSignResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def ModifySmsTemplate(
|
||||
self,
|
||||
request: models.ModifySmsTemplateRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.ModifySmsTemplateResponse:
|
||||
"""
|
||||
本接口 (ModifySmsTemplate) 用于修改短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信正文模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信正文模板。</li><li>修改短信模板，仅当正文模板为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的正文模板不支持修改。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "ModifySmsTemplate"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.ModifySmsTemplateResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsReplyStatus(
|
||||
self,
|
||||
request: models.PullSmsReplyStatusRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsReplyStatusResponse:
|
||||
"""
|
||||
本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsReplyStatus"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsReplyStatusResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsReplyStatusByPhoneNumber(
|
||||
self,
|
||||
request: models.PullSmsReplyStatusByPhoneNumberRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsReplyStatusByPhoneNumberResponse:
|
||||
"""
|
||||
本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsReplyStatusByPhoneNumber"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsReplyStatusByPhoneNumberResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsSendStatus(
|
||||
self,
|
||||
request: models.PullSmsSendStatusRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsSendStatusResponse:
|
||||
"""
|
||||
本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsSendStatus"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsSendStatusResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsSendStatusByPhoneNumber(
|
||||
self,
|
||||
request: models.PullSmsSendStatusByPhoneNumberRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsSendStatusByPhoneNumberResponse:
|
||||
"""
|
||||
本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsSendStatusByPhoneNumber"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsSendStatusByPhoneNumberResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def SendSms(
|
||||
self,
|
||||
request: models.SendSmsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.SendSmsResponse:
|
||||
"""
|
||||
本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "SendSms"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.SendSmsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def SendStatusStatistics(
|
||||
self,
|
||||
request: models.SendStatusStatisticsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.SendStatusStatisticsResponse:
|
||||
"""
|
||||
本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "SendStatusStatistics"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.SendStatusStatisticsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def SmsPackagesStatistics(
|
||||
self,
|
||||
request: models.SmsPackagesStatisticsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.SmsPackagesStatisticsResponse:
|
||||
"""
|
||||
本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "SmsPackagesStatistics"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.SmsPackagesStatisticsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
@@ -0,0 +1,288 @@
|
||||
# -*- coding: utf8 -*-
|
||||
# Copyright (c) 2017-2025 Tencent. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
|
||||
# 短信内容中含有敏感词，请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_CONTAINSENSITIVEWORD = 'FailedOperation.ContainSensitiveWord'
|
||||
|
||||
# 请求包解析失败，通常情况下是由于没有遵守 API 接口说明规范导致的，请参考 [请求包体解析1004错误详解](https://cloud.tencent.com/document/product/382/9558#.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'
|
||||
|
||||
# 个人用户不能申请营销短信。
|
||||
FAILEDOPERATION_FORBIDADDMARKETINGTEMPLATES = 'FailedOperation.ForbidAddMarketingTemplates'
|
||||
|
||||
# 套餐包余量不足，请 [购买套餐包](https://buy.cloud.tencent.com/sms)。
|
||||
FAILEDOPERATION_INSUFFICIENTBALANCEINSMSPACKAGE = 'FailedOperation.InsufficientBalanceInSmsPackage'
|
||||
|
||||
# 解析请求包体时候失败。
|
||||
FAILEDOPERATION_JSONPARSEFAIL = 'FailedOperation.JsonParseFail'
|
||||
|
||||
# 营销短信发送时间限制，为避免骚扰用户，营销短信只允许在8点到22点发送。
|
||||
FAILEDOPERATION_MARKETINGSENDTIMECONSTRAINT = 'FailedOperation.MarketingSendTimeConstraint'
|
||||
|
||||
# 没有申请签名之前，无法申请模板，请根据 [创建签名](https://cloud.tencent.com/document/product/382/37794#.E5.88.9B.E5.BB.BA.E7.AD.BE.E5.90.8D) 申请完成之后再次申请。
|
||||
FAILEDOPERATION_MISSINGSIGNATURE = 'FailedOperation.MissingSignature'
|
||||
|
||||
# 无法识别签名，请确认是否已有签名通过申请，一般是签名未通过申请，可以查看 [签名审核](https://cloud.tencent.com/document/product/382/37745)。
|
||||
FAILEDOPERATION_MISSINGSIGNATURELIST = 'FailedOperation.MissingSignatureList'
|
||||
|
||||
# 此签名 ID 未提交申请或不存在，不能进行修改操作，请检查您的 SignId 是否填写正确。
|
||||
FAILEDOPERATION_MISSINGSIGNATURETOMODIFY = 'FailedOperation.MissingSignatureToModify'
|
||||
|
||||
# 无法识别模板，请确认是否已有模板通过申请，一般是模板未通过申请，可以查看 [模板审核](https://cloud.tencent.com/document/product/382/37745)。
|
||||
FAILEDOPERATION_MISSINGTEMPLATELIST = 'FailedOperation.MissingTemplateList'
|
||||
|
||||
# 此模板 ID 未提交申请或不存在，不能进行修改操作，请检查您的 TemplateId是否填写正确。
|
||||
FAILEDOPERATION_MISSINGTEMPLATETOMODIFY = 'FailedOperation.MissingTemplateToModify'
|
||||
|
||||
# 非企业认证无法使用签名及模板相关接口，您可以[ 变更实名认证模式](https://cloud.tencent.com/document/product/378/34075)，变更为企业认证用户后，约1小时左右生效。
|
||||
FAILEDOPERATION_NOTENTERPRISECERTIFICATION = 'FailedOperation.NotEnterpriseCertification'
|
||||
|
||||
# 其他错误，一般是由于参数携带不符合要求导致，请参考API接口说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_OTHERERROR = 'FailedOperation.OtherError'
|
||||
|
||||
# 未知错误，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_PARAMETERSOTHERERROR = 'FailedOperation.ParametersOtherError'
|
||||
|
||||
# 手机号在免打扰名单库中，通常是用户退订或者命中运营商免打扰名单导致的，可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 解决。
|
||||
FAILEDOPERATION_PHONENUMBERINBLACKLIST = 'FailedOperation.PhoneNumberInBlacklist'
|
||||
|
||||
# 号码解析失败，请检查号码是否符合 E.164 标准。
|
||||
FAILEDOPERATION_PHONENUMBERPARSEFAIL = 'FailedOperation.PhoneNumberParseFail'
|
||||
|
||||
# 非主账号无法使用拉取模板列表功能。您可以使用主账号下云 API 密钥来调用接口。
|
||||
FAILEDOPERATION_PROHIBITSUBACCOUNTUSE = 'FailedOperation.ProhibitSubAccountUse'
|
||||
|
||||
# 资质ID未审核通过。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。
|
||||
FAILEDOPERATION_QUALIFICATIONIDNOTAPPROVED = 'FailedOperation.QualificationIdNotApproved'
|
||||
|
||||
# 签名 ID 不存在。
|
||||
FAILEDOPERATION_SIGNIDNOTEXIST = 'FailedOperation.SignIdNotExist'
|
||||
|
||||
# 签名个数达到最大值。
|
||||
FAILEDOPERATION_SIGNNUMBERLIMIT = 'FailedOperation.SignNumberLimit'
|
||||
|
||||
# 签名未审批或格式错误。（1）可登录 [短信控制台](https://console.cloud.tencent.com/smsv2)，核查签名是否已审批并且审批通过；（2）核查是否符合格式规范，签名只能由中英文、数字组成，要求2 - 12个字，若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_SIGNATUREINCORRECTORUNAPPROVED = 'FailedOperation.SignatureIncorrectOrUnapproved'
|
||||
|
||||
# 此模板已经通过审核，无法再次进行修改。
|
||||
FAILEDOPERATION_TEMPLATEALREADYPASSEDCHECK = 'FailedOperation.TemplateAlreadyPassedCheck'
|
||||
|
||||
# 模板 ID 不存在。
|
||||
FAILEDOPERATION_TEMPLATEIDNOTEXIST = 'FailedOperation.TemplateIdNotExist'
|
||||
|
||||
# 模板未审批或内容不匹配。（1）可登录 [短信控制台](https://console.cloud.tencent.com/smsv2)，核查模板是否已审批并审批通过；（2）核查是否符合 [格式规范](https://cloud.tencent.com/document/product/382/9558#.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)，若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_TEMPLATEINCORRECTORUNAPPROVED = 'FailedOperation.TemplateIncorrectOrUnapproved'
|
||||
|
||||
# 模板个数达到最大值。
|
||||
FAILEDOPERATION_TEMPLATENUMBERLIMIT = 'FailedOperation.TemplateNumberLimit'
|
||||
|
||||
# 请求内容与审核通过的模板内容不匹配。请检查请求中模板参数的个数是否与申请的模板一致。若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_TEMPLATEPARAMSETNOTMATCHAPPROVEDTEMPLATE = 'FailedOperation.TemplateParamSetNotMatchApprovedTemplate'
|
||||
|
||||
# 模板未审批或不存在。可登录 [短信控制台](https://console.cloud.tencent.com/smsv2)，核查模板是否已审批并审批通过。若存在疑问可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
FAILEDOPERATION_TEMPLATEUNAPPROVEDORNOTEXIST = 'FailedOperation.TemplateUnapprovedOrNotExist'
|
||||
|
||||
# 解析用户参数失败，可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INTERNALERROR_JSONPARSEFAIL = 'InternalError.JsonParseFail'
|
||||
|
||||
# 其他错误，请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 并提供失败手机号。
|
||||
INTERNALERROR_OTHERERROR = 'InternalError.OtherError'
|
||||
|
||||
# 解析运营商包体失败，可联系 [sms helper](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 。
|
||||
INTERNALERROR_PARSEBACKENDRESPONSEFAIL = 'InternalError.ParseBackendResponseFail'
|
||||
|
||||
# 请求发起时间不正常，通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的，请核对服务器时间及 API 接口中的时间字段是否正常。
|
||||
INTERNALERROR_REQUESTTIMEEXCEPTION = 'InternalError.RequestTimeException'
|
||||
|
||||
# 不存在该 RESTAPI 接口，请核查 REST API 接口说明。
|
||||
INTERNALERROR_RESTAPIINTERFACENOTEXIST = 'InternalError.RestApiInterfaceNotExist'
|
||||
|
||||
# 接口超时或短信收发包超时，请检查您的网络是否有波动，或联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 解决。
|
||||
INTERNALERROR_SENDANDRECVFAIL = 'InternalError.SendAndRecvFail'
|
||||
|
||||
# 后端包体中请求包体没有 Sig 字段或 Sig 为空。
|
||||
INTERNALERROR_SIGFIELDMISSING = 'InternalError.SigFieldMissing'
|
||||
|
||||
# 后端校验 Sig 失败。
|
||||
INTERNALERROR_SIGVERIFICATIONFAIL = 'InternalError.SigVerificationFail'
|
||||
|
||||
# 请求下发短信超时，请参考 [60008错误详解](https://cloud.tencent.com/document/product/382/9558#.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'
|
||||
|
||||
# 未知错误类型。
|
||||
INTERNALERROR_UNKNOWNERROR = 'InternalError.UnknownError'
|
||||
|
||||
# 参数错误。
|
||||
INVALIDPARAMETER = 'InvalidParameter'
|
||||
|
||||
# 账号与应用id不匹配。
|
||||
INVALIDPARAMETER_APPIDANDBIZID = 'InvalidParameter.AppidAndBizId'
|
||||
|
||||
# 存在敏感词。
|
||||
INVALIDPARAMETER_DIRTYWORDFOUND = 'InvalidParameter.DirtyWordFound'
|
||||
|
||||
# 参数有误，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETER_INVALIDPARAMETERS = 'InvalidParameter.InvalidParameters'
|
||||
|
||||
# 参数 BeginTime 校验失败。
|
||||
INVALIDPARAMETERVALUE_BEGINTIMEVERIFYFAIL = 'InvalidParameterValue.BeginTimeVerifyFail'
|
||||
|
||||
# 请求的短信内容太长，短信长度规则请参考 [国内短信内容长度计算规则](https://cloud.tencent.com/document/product/382/18058) 或 [国际/港澳台短信内容长度计算规则](https://cloud.tencent.com/document/product/382/18052#size)。
|
||||
INVALIDPARAMETERVALUE_CONTENTLENGTHLIMIT = 'InvalidParameterValue.ContentLengthLimit'
|
||||
|
||||
# 参数 EndTime 校验失败。
|
||||
INVALIDPARAMETERVALUE_ENDTIMEVERIFYFAIL = 'InvalidParameterValue.EndTimeVerifyFail'
|
||||
|
||||
# 上传的转码图片格式错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_IMAGEINVALID = 'InvalidParameterValue.ImageInvalid'
|
||||
|
||||
# 手机号格式错误。
|
||||
INVALIDPARAMETERVALUE_INCORRECTPHONENUMBER = 'InvalidParameterValue.IncorrectPhoneNumber'
|
||||
|
||||
# DocumentType 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDDOCUMENTTYPE = 'InvalidParameterValue.InvalidDocumentType'
|
||||
|
||||
# International 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDINTERNATIONAL = 'InvalidParameterValue.InvalidInternational'
|
||||
|
||||
# SignPurpose 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDSIGNPURPOSE = 'InvalidParameterValue.InvalidSignPurpose'
|
||||
|
||||
# SmsType 字段校验错误，请参照 API 接口说明中对该字段的描述，更多疑问可咨询 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDSMSTYPE = 'InvalidParameterValue.InvalidSmsType'
|
||||
|
||||
# 无效的拉取起始/截止时间，具体原因可能是请求的 SendDateTime 大于 EndDateTime。
|
||||
INVALIDPARAMETERVALUE_INVALIDSTARTTIME = 'InvalidParameterValue.InvalidStartTime'
|
||||
|
||||
# 模板格式错误，请参考[正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)。
|
||||
INVALIDPARAMETERVALUE_INVALIDTEMPLATEFORMAT = 'InvalidParameterValue.InvalidTemplateFormat'
|
||||
|
||||
# UsedMethod 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
INVALIDPARAMETERVALUE_INVALIDUSEDMETHOD = 'InvalidParameterValue.InvalidUsedMethod'
|
||||
|
||||
# 参数 Limit 校验失败。
|
||||
INVALIDPARAMETERVALUE_LIMITVERIFYFAIL = 'InvalidParameterValue.LimitVerifyFail'
|
||||
|
||||
# 营销短信必须包含退订方式，请在短信模板尾部添加“拒收请回复R”后提交。可参考 [关于营销短信退订标识修改的公告](https://cloud.tencent.com/document/product/382/100568)。
|
||||
INVALIDPARAMETERVALUE_MARKETINGTEMPLATEWITHOUTUNSUBSCRIBE = 'InvalidParameterValue.MarketingTemplateWithoutUnsubscribe'
|
||||
|
||||
# 参数 Offset 校验失败。
|
||||
INVALIDPARAMETERVALUE_OFFSETVERIFYFAIL = 'InvalidParameterValue.OffsetVerifyFail'
|
||||
|
||||
# 禁止在模板变量中使用 URL。您可以参考正文模板审核标准下关于 [变量规范](https://cloud.tencent.com/document/product/382/39023#variable) 的描述
|
||||
INVALIDPARAMETERVALUE_PROHIBITEDUSEURLINTEMPLATEPARAMETER = 'InvalidParameterValue.ProhibitedUseUrlInTemplateParameter'
|
||||
|
||||
# 资质ID未找到。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。
|
||||
INVALIDPARAMETERVALUE_QUALIFICATIONIDNOTFOUND = 'InvalidParameterValue.QualificationIdNotFound'
|
||||
|
||||
# SdkAppId 不存在。
|
||||
INVALIDPARAMETERVALUE_SDKAPPIDNOTEXIST = 'InvalidParameterValue.SdkAppIdNotExist'
|
||||
|
||||
# 此签名已经通过审核，无法再次进行修改。
|
||||
INVALIDPARAMETERVALUE_SIGNALREADYPASSEDCHECK = 'InvalidParameterValue.SignAlreadyPassedCheck'
|
||||
|
||||
# 已存在相同的待审核签名。
|
||||
INVALIDPARAMETERVALUE_SIGNEXISTANDUNAPPROVED = 'InvalidParameterValue.SignExistAndUnapproved'
|
||||
|
||||
# 签名内容长度过长。
|
||||
INVALIDPARAMETERVALUE_SIGNNAMELENGTHTOOLONG = 'InvalidParameterValue.SignNameLengthTooLong'
|
||||
|
||||
# 验证码模板参数格式错误，验证码类模板，模板变量只能传入0 - 6位（包括6位）纯数字。
|
||||
INVALIDPARAMETERVALUE_TEMPLATEPARAMETERFORMATERROR = 'InvalidParameterValue.TemplateParameterFormatError'
|
||||
|
||||
# 单个模板变量字符数超过规定的限制数。您可以参考 <a href="https://cloud.tencent.com/document/product/382/39023#variable">正文模板审核标准</a>下变量规范中关于长度的描述，对于长期未使用的账号及2024年1月25日后开通新账号默认最长支持6个字符，您的账号具体可支持字符长度以<a href="https://console.cloud.tencent.com/smsv2/csms-template/create">控制台显示为准</a>。更多疑问可联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 。
|
||||
INVALIDPARAMETERVALUE_TEMPLATEPARAMETERLENGTHLIMIT = 'InvalidParameterValue.TemplateParameterLengthLimit'
|
||||
|
||||
# 模板内容存在敏感词，请参考[正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)。
|
||||
INVALIDPARAMETERVALUE_TEMPLATEWITHDIRTYWORDS = 'InvalidParameterValue.TemplateWithDirtyWords'
|
||||
|
||||
# 申请国内短信通知和营销短信模板不支持添加变量。可参考 [控制台说明](https://console.cloud.tencent.com/smsv2/csms-template)，更多疑问可咨询 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)
|
||||
INVALIDPARAMETERVALUE_UNSUPPORTEDTEMPLATEVARIABLE = 'InvalidParameterValue.UnsupportedTemplateVariable'
|
||||
|
||||
# 业务短信国家/地区日下发条数超过设定的上限，可自行到控制台应用管理>基础配置下调整国际港澳台短信发送限制。
|
||||
LIMITEXCEEDED_APPCOUNTRYORREGIONDAILYLIMIT = 'LimitExceeded.AppCountryOrRegionDailyLimit'
|
||||
|
||||
# 业务短信国家/地区不在国际港澳台短信发送限制设置的列表中而禁发，可自行到控制台应用管理>基础配置下调整国际港澳台短信发送限制。
|
||||
LIMITEXCEEDED_APPCOUNTRYORREGIONINBLACKLIST = 'LimitExceeded.AppCountryOrRegionInBlacklist'
|
||||
|
||||
# 业务短信日下发条数超过设定的上限 ，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_APPDAILYLIMIT = 'LimitExceeded.AppDailyLimit'
|
||||
|
||||
# 业务短信国际/港澳台日下发条数超过设定的上限，可自行到控制台应用管理>基础配置下调整发送总量阈值。
|
||||
LIMITEXCEEDED_APPGLOBALDAILYLIMIT = 'LimitExceeded.AppGlobalDailyLimit'
|
||||
|
||||
# 业务短信中国大陆日下发条数超过设定的上限，可自行到控制台应用管理>基础配置下调整发送总量阈值。
|
||||
LIMITEXCEEDED_APPMAINLANDCHINADAILYLIMIT = 'LimitExceeded.AppMainlandChinaDailyLimit'
|
||||
|
||||
# 短信日下发条数超过设定的上限 (国际/港澳台)，如需调整限制，可联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773)。
|
||||
LIMITEXCEEDED_DAILYLIMIT = 'LimitExceeded.DailyLimit'
|
||||
|
||||
# 下发短信命中了频率限制策略，可自行到控制台调整短信频率限制策略，如有其他需求请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
LIMITEXCEEDED_DELIVERYFREQUENCYLIMIT = 'LimitExceeded.DeliveryFrequencyLimit'
|
||||
|
||||
# 调用接口单次提交的手机号个数超过200个，请遵守 API 接口输入参数 PhoneNumberSet 描述。
|
||||
LIMITEXCEEDED_PHONENUMBERCOUNTLIMIT = 'LimitExceeded.PhoneNumberCountLimit'
|
||||
|
||||
# 单个手机号日下发短信条数超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERDAILYLIMIT = 'LimitExceeded.PhoneNumberDailyLimit'
|
||||
|
||||
# 单个手机号1小时内下发短信条数超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERONEHOURLIMIT = 'LimitExceeded.PhoneNumberOneHourLimit'
|
||||
|
||||
# 单个手机号下发相同内容超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERSAMECONTENTDAILYLIMIT = 'LimitExceeded.PhoneNumberSameContentDailyLimit'
|
||||
|
||||
# 单个手机号30秒内下发短信条数超过设定的上限，可自行到控制台调整短信频率限制策略。
|
||||
LIMITEXCEEDED_PHONENUMBERTHIRTYSECONDLIMIT = 'LimitExceeded.PhoneNumberThirtySecondLimit'
|
||||
|
||||
# 缺少参数错误。
|
||||
MISSINGPARAMETER = 'MissingParameter'
|
||||
|
||||
# 传入的号码列表为空，请确认您的参数中是否传入号码。
|
||||
MISSINGPARAMETER_EMPTYPHONENUMBERSET = 'MissingParameter.EmptyPhoneNumberSet'
|
||||
|
||||
# 个人用户没有发营销短信的权限，请参考 [权益区别](https://cloud.tencent.com/document/product/382/13444)。
|
||||
UNAUTHORIZEDOPERATION_INDIVIDUALUSERMARKETINGSMSPERMISSIONDENY = 'UnauthorizedOperation.IndividualUserMarketingSmsPermissionDeny'
|
||||
|
||||
# 请求 IP 不在白名单中，您配置了校验请求来源 IP，但是检测到当前请求 IP 不在配置列表中，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
UNAUTHORIZEDOPERATION_REQUESTIPNOTINWHITELIST = 'UnauthorizedOperation.RequestIpNotInWhitelist'
|
||||
|
||||
# 请求没有权限，请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
UNAUTHORIZEDOPERATION_REQUESTPERMISSIONDENY = 'UnauthorizedOperation.RequestPermissionDeny'
|
||||
|
||||
# 此 SdkAppId 禁止提供服务，如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。
|
||||
UNAUTHORIZEDOPERATION_SDKAPPIDISDISABLED = 'UnauthorizedOperation.SdkAppIdIsDisabled'
|
||||
|
||||
# 欠费被停止服务，可自行登录腾讯云充值来缴清欠款。
|
||||
UNAUTHORIZEDOPERATION_SERVICESUSPENDDUETOARREARS = 'UnauthorizedOperation.ServiceSuspendDueToArrears'
|
||||
|
||||
# SmsSdkAppId 校验失败，请检查 [SmsSdkAppId](https://console.cloud.tencent.com/smsv2/app-manage) 是否属于 [云API密钥](https://console.cloud.tencent.com/cam/capi) 的关联账户。
|
||||
UNAUTHORIZEDOPERATION_SMSSDKAPPIDVERIFYFAIL = 'UnauthorizedOperation.SmsSdkAppIdVerifyFail'
|
||||
|
||||
# 操作不支持。
|
||||
UNSUPPORTEDOPERATION = 'UnsupportedOperation'
|
||||
|
||||
# 国内短信模板不支持发送国际/港澳台手机号。发送国际/港澳台手机号请使用国际/港澳台短信正文模板。
|
||||
UNSUPPORTEDOPERATION_CHINESEMAINLANDTEMPLATETOGLOBALPHONE = 'UnsupportedOperation.ChineseMainlandTemplateToGlobalPhone'
|
||||
|
||||
# 群发请求里既有国内手机号也有国际手机号。请排查是否存在（1）使用国内签名或模板却发送短信到国际手机号；（2）使用国际签名或模板却发送短信到国内手机号。
|
||||
UNSUPPORTEDOPERATION_CONTAINDOMESTICANDINTERNATIONALPHONENUMBER = 'UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber'
|
||||
|
||||
# 国际/港澳台短信模板不支持发送国内手机号。发送国内手机号请使用国内短信正文模板。
|
||||
UNSUPPORTEDOPERATION_GLOBALTEMPLATETOCHINESEMAINLANDPHONE = 'UnsupportedOperation.GlobalTemplateToChineseMainlandPhone'
|
||||
|
||||
# 不支持该地区短信下发。
|
||||
UNSUPPORTEDOPERATION_UNSUPPORTEDREGION = 'UnsupportedOperation.UnsupportedRegion'
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,455 @@
|
||||
# -*- coding: utf8 -*-
|
||||
# Copyright (c) 2017-2025 Tencent. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
import json
|
||||
|
||||
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
|
||||
from tencentcloud.common.abstract_client import AbstractClient
|
||||
from tencentcloud.sms.v20210111 import models
|
||||
|
||||
|
||||
class SmsClient(AbstractClient):
|
||||
_apiVersion = '2021-01-11'
|
||||
_endpoint = 'sms.tencentcloudapi.com'
|
||||
_service = 'sms'
|
||||
|
||||
|
||||
def AddSmsSign(self, request):
|
||||
r"""本接口 (AddSmsSign) 用于添加短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>添加短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信签名。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for AddSmsSign.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.AddSmsSignRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.AddSmsSignResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("AddSmsSign", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.AddSmsSignResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def AddSmsTemplate(self, request):
|
||||
r"""本接口 (AddSmsTemplate) 用于创建短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>申请短信模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信正文模板。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for AddSmsTemplate.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.AddSmsTemplateRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.AddSmsTemplateResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("AddSmsTemplate", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.AddSmsTemplateResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def CallbackStatusStatistics(self, request):
|
||||
r"""本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
|
||||
|
||||
:param request: Request instance for CallbackStatusStatistics.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.CallbackStatusStatisticsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.CallbackStatusStatisticsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("CallbackStatusStatistics", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.CallbackStatusStatisticsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DeleteSmsSign(self, request):
|
||||
r"""本接口 (DeleteSmsSign) 用于删除短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信签名。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DeleteSmsSign.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.DeleteSmsSignRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.DeleteSmsSignResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DeleteSmsSign", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DeleteSmsSignResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DeleteSmsTemplate(self, request):
|
||||
r"""本接口 (DeleteSmsTemplate) 用于删除短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信正文模板。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DeleteSmsTemplate.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.DeleteSmsTemplateRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.DeleteSmsTemplateResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DeleteSmsTemplate", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DeleteSmsTemplateResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DescribePhoneNumberInfo(self, request):
|
||||
r"""本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。
|
||||
- 例如：查询号码 +86018501234444，可以得到国家码 86、规范的 E.164 号码 +8618501234444 等信息。
|
||||
|
||||
:param request: Request instance for DescribePhoneNumberInfo.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.DescribePhoneNumberInfoRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.DescribePhoneNumberInfoResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DescribePhoneNumberInfo", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DescribePhoneNumberInfoResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DescribeSmsSignList(self, request):
|
||||
r"""本接口 (DescribeSmsSignList) 用于查询短信签名状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信签名。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DescribeSmsSignList.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.DescribeSmsSignListRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.DescribeSmsSignListResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DescribeSmsSignList", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DescribeSmsSignListResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def DescribeSmsTemplateList(self, request):
|
||||
r"""本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信正文模板。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for DescribeSmsTemplateList.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.DescribeSmsTemplateListRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.DescribeSmsTemplateListResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("DescribeSmsTemplateList", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.DescribeSmsTemplateListResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def ModifySmsSign(self, request):
|
||||
r"""本接口 (ModifySmsSign) 用于修改短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信签名。</li><li>修改短信签名，仅当签名为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的签名不支持修改。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for ModifySmsSign.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.ModifySmsSignRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.ModifySmsSignResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("ModifySmsSign", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.ModifySmsSignResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def ModifySmsTemplate(self, request):
|
||||
r"""本接口 (ModifySmsTemplate) 用于修改短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信正文模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信正文模板。</li><li>修改短信模板，仅当正文模板为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的正文模板不支持修改。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for ModifySmsTemplate.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.ModifySmsTemplateRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.ModifySmsTemplateResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("ModifySmsTemplate", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.ModifySmsTemplateResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsReplyStatus(self, request):
|
||||
r"""本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsReplyStatus.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.PullSmsReplyStatusRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.PullSmsReplyStatusResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsReplyStatus", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsReplyStatusResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsReplyStatusByPhoneNumber(self, request):
|
||||
r"""本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsReplyStatusByPhoneNumber.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.PullSmsReplyStatusByPhoneNumberRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.PullSmsReplyStatusByPhoneNumberResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsReplyStatusByPhoneNumber", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsReplyStatusByPhoneNumberResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsSendStatus(self, request):
|
||||
r"""本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsSendStatus.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.PullSmsSendStatusRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.PullSmsSendStatusResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsSendStatus", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsSendStatusResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def PullSmsSendStatusByPhoneNumber(self, request):
|
||||
r"""本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for PullSmsSendStatusByPhoneNumber.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.PullSmsSendStatusByPhoneNumberRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.PullSmsSendStatusByPhoneNumberResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("PullSmsSendStatusByPhoneNumber", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.PullSmsSendStatusByPhoneNumberResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def ReportConversion(self, request):
|
||||
r"""本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>该接口当前以白名单方式对外开放，如有需要请联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li></ul></blockquote>
|
||||
|
||||
:param request: Request instance for ReportConversion.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.ReportConversionRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.ReportConversionResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("ReportConversion", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.ReportConversionResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def SendSms(self, request):
|
||||
r"""本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。
|
||||
- 当前接口属于 2021-01-11 版本，如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778)，建议您使用当前最新版本的接口，版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
|
||||
|
||||
:param request: Request instance for SendSms.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.SendSmsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.SendSmsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("SendSms", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.SendSmsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def SendStatusStatistics(self, request):
|
||||
r"""本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
|
||||
|
||||
:param request: Request instance for SendStatusStatistics.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.SendStatusStatisticsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.SendStatusStatisticsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("SendStatusStatistics", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.SendStatusStatisticsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
|
||||
|
||||
def SmsPackagesStatistics(self, request):
|
||||
r"""本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
|
||||
|
||||
:param request: Request instance for SmsPackagesStatistics.
|
||||
:type request: :class:`tencentcloud.sms.v20210111.models.SmsPackagesStatisticsRequest`
|
||||
:rtype: :class:`tencentcloud.sms.v20210111.models.SmsPackagesStatisticsResponse`
|
||||
|
||||
"""
|
||||
try:
|
||||
params = request._serialize()
|
||||
headers = request.headers
|
||||
body = self.call("SmsPackagesStatistics", params, headers=headers)
|
||||
response = json.loads(body)
|
||||
model = models.SmsPackagesStatisticsResponse()
|
||||
model._deserialize(response["Response"])
|
||||
return model
|
||||
except Exception as e:
|
||||
if isinstance(e, TencentCloudSDKException):
|
||||
raise
|
||||
else:
|
||||
raise TencentCloudSDKException(type(e).__name__, str(e))
|
||||
@@ -0,0 +1,365 @@
|
||||
# -*- coding: utf8 -*-
|
||||
# Copyright (c) 2017-2025 Tencent. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
|
||||
|
||||
from tencentcloud.common.abstract_client_async import AbstractClient
|
||||
from tencentcloud.sms.v20210111 import models
|
||||
from typing import Dict
|
||||
|
||||
|
||||
class SmsClient(AbstractClient):
|
||||
_apiVersion = '2021-01-11'
|
||||
_endpoint = 'sms.tencentcloudapi.com'
|
||||
_service = 'sms'
|
||||
|
||||
async def AddSmsSign(
|
||||
self,
|
||||
request: models.AddSmsSignRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.AddSmsSignResponse:
|
||||
"""
|
||||
本接口 (AddSmsSign) 用于添加短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>添加短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信签名。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "AddSmsSign"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.AddSmsSignResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def AddSmsTemplate(
|
||||
self,
|
||||
request: models.AddSmsTemplateRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.AddSmsTemplateResponse:
|
||||
"""
|
||||
本接口 (AddSmsTemplate) 用于创建短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>申请短信模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信正文模板。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "AddSmsTemplate"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.AddSmsTemplateResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def CallbackStatusStatistics(
|
||||
self,
|
||||
request: models.CallbackStatusStatisticsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.CallbackStatusStatisticsResponse:
|
||||
"""
|
||||
本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "CallbackStatusStatistics"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.CallbackStatusStatisticsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DeleteSmsSign(
|
||||
self,
|
||||
request: models.DeleteSmsSignRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DeleteSmsSignResponse:
|
||||
"""
|
||||
本接口 (DeleteSmsSign) 用于删除短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信签名。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DeleteSmsSign"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DeleteSmsSignResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DeleteSmsTemplate(
|
||||
self,
|
||||
request: models.DeleteSmsTemplateRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DeleteSmsTemplateResponse:
|
||||
"""
|
||||
本接口 (DeleteSmsTemplate) 用于删除短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信正文模板。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DeleteSmsTemplate"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DeleteSmsTemplateResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DescribePhoneNumberInfo(
|
||||
self,
|
||||
request: models.DescribePhoneNumberInfoRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DescribePhoneNumberInfoResponse:
|
||||
"""
|
||||
本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。
|
||||
- 例如：查询号码 +86018501234444，可以得到国家码 86、规范的 E.164 号码 +8618501234444 等信息。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DescribePhoneNumberInfo"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DescribePhoneNumberInfoResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DescribeSmsSignList(
|
||||
self,
|
||||
request: models.DescribeSmsSignListRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DescribeSmsSignListResponse:
|
||||
"""
|
||||
本接口 (DescribeSmsSignList) 用于查询短信签名状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信签名。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DescribeSmsSignList"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DescribeSmsSignListResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def DescribeSmsTemplateList(
|
||||
self,
|
||||
request: models.DescribeSmsTemplateListRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.DescribeSmsTemplateListResponse:
|
||||
"""
|
||||
本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信正文模板。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "DescribeSmsTemplateList"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.DescribeSmsTemplateListResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def ModifySmsSign(
|
||||
self,
|
||||
request: models.ModifySmsSignRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.ModifySmsSignResponse:
|
||||
"""
|
||||
本接口 (ModifySmsSign) 用于修改短信签名。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信签名前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信签名，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信签名。</li><li>修改短信签名，仅当签名为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的签名不支持修改。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "ModifySmsSign"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.ModifySmsSignResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def ModifySmsTemplate(
|
||||
self,
|
||||
request: models.ModifySmsTemplateRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.ModifySmsTemplateResponse:
|
||||
"""
|
||||
本接口 (ModifySmsTemplate) 用于修改短信模板。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>修改短信正文模板前，请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信正文模板，请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>，如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信正文模板。</li><li>修改短信模板，仅当正文模板为<b>待审核</b>或<b>已拒绝</b>状态时，才能进行修改，<b>已审核通过</b>的正文模板不支持修改。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "ModifySmsTemplate"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.ModifySmsTemplateResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsReplyStatus(
|
||||
self,
|
||||
request: models.PullSmsReplyStatusRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsReplyStatusResponse:
|
||||
"""
|
||||
本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsReplyStatus"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsReplyStatusResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsReplyStatusByPhoneNumber(
|
||||
self,
|
||||
request: models.PullSmsReplyStatusByPhoneNumberRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsReplyStatusByPhoneNumberResponse:
|
||||
"""
|
||||
本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsReplyStatusByPhoneNumber"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsReplyStatusByPhoneNumberResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsSendStatus(
|
||||
self,
|
||||
request: models.PullSmsSendStatusRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsSendStatusResponse:
|
||||
"""
|
||||
本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。</li><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsSendStatus"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsSendStatusResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def PullSmsSendStatusByPhoneNumber(
|
||||
self,
|
||||
request: models.PullSmsSendStatusByPhoneNumberRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.PullSmsSendStatusByPhoneNumberResponse:
|
||||
"""
|
||||
本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#sendingstatus">配置回调</a> 的方式获取。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "PullSmsSendStatusByPhoneNumber"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.PullSmsSendStatusByPhoneNumberResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def ReportConversion(
|
||||
self,
|
||||
request: models.ReportConversionRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.ReportConversionResponse:
|
||||
"""
|
||||
本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
|
||||
<blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明：</div><p></p><ul><li>该接口当前以白名单方式对外开放，如有需要请联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li></ul></blockquote>
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "ReportConversion"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.ReportConversionResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def SendSms(
|
||||
self,
|
||||
request: models.SendSmsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.SendSmsResponse:
|
||||
"""
|
||||
本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。
|
||||
- 当前接口属于 2021-01-11 版本，如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778)，建议您使用当前最新版本的接口，版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "SendSms"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.SendSmsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def SendStatusStatistics(
|
||||
self,
|
||||
request: models.SendStatusStatisticsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.SendStatusStatisticsResponse:
|
||||
"""
|
||||
本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "SendStatusStatistics"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.SendStatusStatisticsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
|
||||
async def SmsPackagesStatistics(
|
||||
self,
|
||||
request: models.SmsPackagesStatisticsRequest,
|
||||
opts: Dict = None,
|
||||
) -> models.SmsPackagesStatisticsResponse:
|
||||
"""
|
||||
本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
|
||||
"""
|
||||
|
||||
kwargs = {}
|
||||
kwargs["action"] = "SmsPackagesStatistics"
|
||||
kwargs["params"] = request._serialize()
|
||||
kwargs["resp_cls"] = models.SmsPackagesStatisticsResponse
|
||||
kwargs["headers"] = request.headers
|
||||
kwargs["opts"] = opts or {}
|
||||
|
||||
return await self.call_and_deserialize(**kwargs)
|
||||
Reference in New Issue
Block a user