# frozen_string_literal: true
# Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. 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.
module TencentCloud
module Sms
module V20190711
# 添加签名响应
class AddSignStatus < TencentCloud::Common::AbstractModel
# @param SignId: 签名Id。
# @type SignId: Integer
# @param SignApplyId: 签名申请Id。
# @type SignApplyId: Integer
attr_accessor :SignId, :SignApplyId
def initialize(signid=nil, signapplyid=nil)
@SignId = signid
@SignApplyId = signapplyid
end
def deserialize(params)
@SignId = params['SignId']
@SignApplyId = params['SignApplyId']
end
end
# AddSmsSign请求参数结构体
class AddSmsSignRequest < TencentCloud::Common::AbstractModel
# @param SignName: 签名名称。
# 注:不能重复申请已通过或待审核的签名。
# @type SignName: String
# @param SignType: 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
# 0:公司,可选 DocumentType 有(0,1)。
# 1:APP,可选 DocumentType 有(0,1,2,3,4) 。
# 2:网站,可选 DocumentType 有(0,1,2,3,5)。
# 3:公众号,可选 DocumentType 有(0,1,2,3,8)。
# 4:商标,可选 DocumentType 有(7)。
# 5:政府/机关事业单位/其他机构,可选 DocumentType 有(2,3)。
# 6:小程序,可选 DocumentType 有(0,1,2,3,6)。
# 注:必须按照对应关系选择证明类型,否则会审核失败。
# @type SignType: Integer
# @param DocumentType: 证明类型:
# 0:三证合一。
# 1:企业营业执照。
# 2:组织机构代码证书。
# 3:社会信用代码证书。
# 4:应用后台管理截图(个人开发APP)。
# 5:网站备案后台截图(个人开发网站)。
# 6:小程序设置页面截图(个人认证小程序)。
# 7:商标注册书。
# 8:公众号设置页面截图(个人认证公众号)。
# @type DocumentType: Integer
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# @type International: Integer
# @param UsedMethod: 签名用途:
# 0:自用。
# 1:他用。
# @type UsedMethod: Integer
# @param ProofImage: 签名对应的资质证明图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
# @type ProofImage: String
# @param CommissionImage: 委托授权证明。选择 UsedMethod 为他用之后需要提交委托的授权证明。
# 图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
# 注:只有 UsedMethod 在选择为 1(他用)时,这个字段才会生效。
# @type CommissionImage: String
# @param Remark: 签名的申请备注。
# @type Remark: String
# @param QualificationId: 已审核通过的国内短信的资质 ID。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。
# @type QualificationId: Integer
attr_accessor :SignName, :SignType, :DocumentType, :International, :UsedMethod, :ProofImage, :CommissionImage, :Remark, :QualificationId
def initialize(signname=nil, signtype=nil, documenttype=nil, international=nil, usedmethod=nil, proofimage=nil, commissionimage=nil, remark=nil, qualificationid=nil)
@SignName = signname
@SignType = signtype
@DocumentType = documenttype
@International = international
@UsedMethod = usedmethod
@ProofImage = proofimage
@CommissionImage = commissionimage
@Remark = remark
@QualificationId = qualificationid
end
def deserialize(params)
@SignName = params['SignName']
@SignType = params['SignType']
@DocumentType = params['DocumentType']
@International = params['International']
@UsedMethod = params['UsedMethod']
@ProofImage = params['ProofImage']
@CommissionImage = params['CommissionImage']
@Remark = params['Remark']
@QualificationId = params['QualificationId']
end
end
# AddSmsSign返回参数结构体
class AddSmsSignResponse < TencentCloud::Common::AbstractModel
# @param AddSignStatus: 添加签名响应
# @type AddSignStatus: :class:`Tencentcloud::Sms.v20190711.models.AddSignStatus`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :AddSignStatus, :RequestId
def initialize(addsignstatus=nil, requestid=nil)
@AddSignStatus = addsignstatus
@RequestId = requestid
end
def deserialize(params)
unless params['AddSignStatus'].nil?
@AddSignStatus = AddSignStatus.new
@AddSignStatus.deserialize(params['AddSignStatus'])
end
@RequestId = params['RequestId']
end
end
# AddSmsTemplate请求参数结构体
class AddSmsTemplateRequest < TencentCloud::Common::AbstractModel
# @param TemplateName: 模板名称。
# @type TemplateName: String
# @param TemplateContent: 模板内容。
# @type TemplateContent: String
# @param SmsType: 短信类型,1表示营销短信,2表示通知短信,3表示验证码短信。
# 注:为进一步提升短信发送质量、提高短信模板审核通过率,从2024年5月16日起,腾讯云短信模板类型优化为“验证码短信”、“通知短信”、“营销短信”,可参考[关于腾讯云短信模板类型优化公告](https://cloud.tencent.com/document/product/382/106171)。新开通短信服务的客户需严格参考新的短信类型申请短信模板。
# @type SmsType: Integer
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# @type International: Integer
# @param Remark: 模板备注,例如申请原因,使用场景等。
# @type Remark: String
attr_accessor :TemplateName, :TemplateContent, :SmsType, :International, :Remark
def initialize(templatename=nil, templatecontent=nil, smstype=nil, international=nil, remark=nil)
@TemplateName = templatename
@TemplateContent = templatecontent
@SmsType = smstype
@International = international
@Remark = remark
end
def deserialize(params)
@TemplateName = params['TemplateName']
@TemplateContent = params['TemplateContent']
@SmsType = params['SmsType']
@International = params['International']
@Remark = params['Remark']
end
end
# AddSmsTemplate返回参数结构体
class AddSmsTemplateResponse < TencentCloud::Common::AbstractModel
# @param AddTemplateStatus: 添加短信模板响应包体
# @type AddTemplateStatus: :class:`Tencentcloud::Sms.v20190711.models.AddTemplateStatus`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :AddTemplateStatus, :RequestId
def initialize(addtemplatestatus=nil, requestid=nil)
@AddTemplateStatus = addtemplatestatus
@RequestId = requestid
end
def deserialize(params)
unless params['AddTemplateStatus'].nil?
@AddTemplateStatus = AddTemplateStatus.new
@AddTemplateStatus.deserialize(params['AddTemplateStatus'])
end
@RequestId = params['RequestId']
end
end
# 添加模板参数响应
class AddTemplateStatus < TencentCloud::Common::AbstractModel
# @param TemplateId: 模板参数
# @type TemplateId: String
attr_accessor :TemplateId
def initialize(templateid=nil)
@TemplateId = templateid
end
def deserialize(params)
@TemplateId = params['TemplateId']
end
end
# 回执数据统计响应包体
class CallbackStatusStatistics < TencentCloud::Common::AbstractModel
# @param CallbackCount: 短信回执量统计。
# @type CallbackCount: Integer
# @param RequestSuccessCount: 短信提交成功量统计。
# @type RequestSuccessCount: Integer
# @param CallbackFailCount: 短信回执失败量统计。
# @type CallbackFailCount: Integer
# @param CallbackSuccessCount: 短信回执成功量统计。
# @type CallbackSuccessCount: Integer
# @param InternalErrorCount: 运营商内部错误统计。
# @type InternalErrorCount: Integer
# @param InvalidNumberCount: 号码无效或空号统计。
# @type InvalidNumberCount: Integer
# @param ShutdownErrorCount: 停机、关机等错误统计。
# @type ShutdownErrorCount: Integer
# @param BlackListCount: 号码拉入黑名单统计。
# @type BlackListCount: Integer
# @param FrequencyLimitCount: 运营商频率限制统计。
# @type FrequencyLimitCount: Integer
attr_accessor :CallbackCount, :RequestSuccessCount, :CallbackFailCount, :CallbackSuccessCount, :InternalErrorCount, :InvalidNumberCount, :ShutdownErrorCount, :BlackListCount, :FrequencyLimitCount
def initialize(callbackcount=nil, requestsuccesscount=nil, callbackfailcount=nil, callbacksuccesscount=nil, internalerrorcount=nil, invalidnumbercount=nil, shutdownerrorcount=nil, blacklistcount=nil, frequencylimitcount=nil)
@CallbackCount = callbackcount
@RequestSuccessCount = requestsuccesscount
@CallbackFailCount = callbackfailcount
@CallbackSuccessCount = callbacksuccesscount
@InternalErrorCount = internalerrorcount
@InvalidNumberCount = invalidnumbercount
@ShutdownErrorCount = shutdownerrorcount
@BlackListCount = blacklistcount
@FrequencyLimitCount = frequencylimitcount
end
def deserialize(params)
@CallbackCount = params['CallbackCount']
@RequestSuccessCount = params['RequestSuccessCount']
@CallbackFailCount = params['CallbackFailCount']
@CallbackSuccessCount = params['CallbackSuccessCount']
@InternalErrorCount = params['InternalErrorCount']
@InvalidNumberCount = params['InvalidNumberCount']
@ShutdownErrorCount = params['ShutdownErrorCount']
@BlackListCount = params['BlackListCount']
@FrequencyLimitCount = params['FrequencyLimitCount']
end
end
# CallbackStatusStatistics请求参数结构体
class CallbackStatusStatisticsRequest < TencentCloud::Common::AbstractModel
# @param StartDateTime: 开始时间,yyyymmddhh 需要拉取的起始时间,精确到小时。
# @type StartDateTime: Integer
# @param EndDataTime: 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时。
# 注:EndDataTime 必须大于等于 StartDateTime。
# @type EndDataTime: Integer
# @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
# @type SmsSdkAppid: String
# @param Limit: 最大上限。
# 注:目前固定设置为0。
# @type Limit: Integer
# @param Offset: 偏移量。
# 注:目前固定设置为0。
# @type Offset: Integer
attr_accessor :StartDateTime, :EndDataTime, :SmsSdkAppid, :Limit, :Offset
def initialize(startdatetime=nil, enddatatime=nil, smssdkappid=nil, limit=nil, offset=nil)
@StartDateTime = startdatetime
@EndDataTime = enddatatime
@SmsSdkAppid = smssdkappid
@Limit = limit
@Offset = offset
end
def deserialize(params)
@StartDateTime = params['StartDateTime']
@EndDataTime = params['EndDataTime']
@SmsSdkAppid = params['SmsSdkAppid']
@Limit = params['Limit']
@Offset = params['Offset']
end
end
# CallbackStatusStatistics返回参数结构体
class CallbackStatusStatisticsResponse < TencentCloud::Common::AbstractModel
# @param CallbackStatusStatistics: 回执数据统计响应包体。
# @type CallbackStatusStatistics: :class:`Tencentcloud::Sms.v20190711.models.CallbackStatusStatistics`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :CallbackStatusStatistics, :RequestId
def initialize(callbackstatusstatistics=nil, requestid=nil)
@CallbackStatusStatistics = callbackstatusstatistics
@RequestId = requestid
end
def deserialize(params)
unless params['CallbackStatusStatistics'].nil?
@CallbackStatusStatistics = CallbackStatusStatistics.new
@CallbackStatusStatistics.deserialize(params['CallbackStatusStatistics'])
end
@RequestId = params['RequestId']
end
end
# 删除签名响应
class DeleteSignStatus < TencentCloud::Common::AbstractModel
# @param DeleteStatus: 删除状态信息。
# @type DeleteStatus: String
# @param DeleteTime: 删除时间,UNIX 时间戳(单位:秒)。
# @type DeleteTime: Integer
attr_accessor :DeleteStatus, :DeleteTime
def initialize(deletestatus=nil, deletetime=nil)
@DeleteStatus = deletestatus
@DeleteTime = deletetime
end
def deserialize(params)
@DeleteStatus = params['DeleteStatus']
@DeleteTime = params['DeleteTime']
end
end
# DeleteSmsSign请求参数结构体
class DeleteSmsSignRequest < TencentCloud::Common::AbstractModel
# @param SignId: 待删除的签名 ID。
# @type SignId: Integer
attr_accessor :SignId
def initialize(signid=nil)
@SignId = signid
end
def deserialize(params)
@SignId = params['SignId']
end
end
# DeleteSmsSign返回参数结构体
class DeleteSmsSignResponse < TencentCloud::Common::AbstractModel
# @param DeleteSignStatus: 删除签名响应
# @type DeleteSignStatus: :class:`Tencentcloud::Sms.v20190711.models.DeleteSignStatus`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :DeleteSignStatus, :RequestId
def initialize(deletesignstatus=nil, requestid=nil)
@DeleteSignStatus = deletesignstatus
@RequestId = requestid
end
def deserialize(params)
unless params['DeleteSignStatus'].nil?
@DeleteSignStatus = DeleteSignStatus.new
@DeleteSignStatus.deserialize(params['DeleteSignStatus'])
end
@RequestId = params['RequestId']
end
end
# DeleteSmsTemplate请求参数结构体
class DeleteSmsTemplateRequest < TencentCloud::Common::AbstractModel
# @param TemplateId: 待删除的模板 ID。
# @type TemplateId: Integer
attr_accessor :TemplateId
def initialize(templateid=nil)
@TemplateId = templateid
end
def deserialize(params)
@TemplateId = params['TemplateId']
end
end
# DeleteSmsTemplate返回参数结构体
class DeleteSmsTemplateResponse < TencentCloud::Common::AbstractModel
# @param DeleteTemplateStatus: 删除模板响应
# @type DeleteTemplateStatus: :class:`Tencentcloud::Sms.v20190711.models.DeleteTemplateStatus`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :DeleteTemplateStatus, :RequestId
def initialize(deletetemplatestatus=nil, requestid=nil)
@DeleteTemplateStatus = deletetemplatestatus
@RequestId = requestid
end
def deserialize(params)
unless params['DeleteTemplateStatus'].nil?
@DeleteTemplateStatus = DeleteTemplateStatus.new
@DeleteTemplateStatus.deserialize(params['DeleteTemplateStatus'])
end
@RequestId = params['RequestId']
end
end
# 删除模板响应
class DeleteTemplateStatus < TencentCloud::Common::AbstractModel
# @param DeleteStatus: 删除状态信息。
# @type DeleteStatus: String
# @param DeleteTime: 删除时间,UNIX 时间戳(单位:秒)。
# @type DeleteTime: Integer
attr_accessor :DeleteStatus, :DeleteTime
def initialize(deletestatus=nil, deletetime=nil)
@DeleteStatus = deletestatus
@DeleteTime = deletetime
end
def deserialize(params)
@DeleteStatus = params['DeleteStatus']
@DeleteTime = params['DeleteTime']
end
end
# 获取短信签名信息响应
class DescribeSignListStatus < TencentCloud::Common::AbstractModel
# @param SignId: 签名Id
# @type SignId: Integer
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# @type International: Integer
# @param StatusCode: 申请签名状态。其中0表示审核通过且已生效,1表示审核中,2表示审核通过待生效,-1表示审核未通过或审核失败。
# @type StatusCode: Integer
# @param ReviewReply: 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
# @type ReviewReply: String
# @param SignName: 签名名称。
# @type SignName: String
# @param CreateTime: 提交审核时间,UNIX 时间戳(单位:秒)。
# @type CreateTime: Integer
# @param QualificationId: 国内短信的资质 ID。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。
# 注:国际短信不涉及,默认为0。
# @type QualificationId: Integer
# @param QualificationName: 国内短信的资质名称。
# 注:国际短信不涉及,默认为空。
# @type QualificationName: String
# @param QualificationStatusCode: 国内短信的资质状态。其中0表示待审核,1表示已通过,2表示已拒绝,3表示待补充后提交,4表示变更后待审核,5表示变更后被驳回。可参考 [实名资质审核状态说明](https://cloud.tencent.com/document/product/382/13444#.E5.AE.A1.E6.A0.B8.E7.8A.B6.E6.80.81.E8.AF.B4.E6.98.8E) 。
# 注:国际短信不涉及,默认为0。
# @type QualificationStatusCode: Integer
attr_accessor :SignId, :International, :StatusCode, :ReviewReply, :SignName, :CreateTime, :QualificationId, :QualificationName, :QualificationStatusCode
def initialize(signid=nil, international=nil, statuscode=nil, reviewreply=nil, signname=nil, createtime=nil, qualificationid=nil, qualificationname=nil, qualificationstatuscode=nil)
@SignId = signid
@International = international
@StatusCode = statuscode
@ReviewReply = reviewreply
@SignName = signname
@CreateTime = createtime
@QualificationId = qualificationid
@QualificationName = qualificationname
@QualificationStatusCode = qualificationstatuscode
end
def deserialize(params)
@SignId = params['SignId']
@International = params['International']
@StatusCode = params['StatusCode']
@ReviewReply = params['ReviewReply']
@SignName = params['SignName']
@CreateTime = params['CreateTime']
@QualificationId = params['QualificationId']
@QualificationName = params['QualificationName']
@QualificationStatusCode = params['QualificationStatusCode']
end
end
# DescribeSmsSignList请求参数结构体
class DescribeSmsSignListRequest < TencentCloud::Common::AbstractModel
# @param SignIdSet: 签名 ID 数组。
# @type SignIdSet: Array
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# @type International: Integer
attr_accessor :SignIdSet, :International
def initialize(signidset=nil, international=nil)
@SignIdSet = signidset
@International = international
end
def deserialize(params)
@SignIdSet = params['SignIdSet']
@International = params['International']
end
end
# DescribeSmsSignList返回参数结构体
class DescribeSmsSignListResponse < TencentCloud::Common::AbstractModel
# @param DescribeSignListStatusSet: 获取签名信息响应
# @type DescribeSignListStatusSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :DescribeSignListStatusSet, :RequestId
def initialize(describesignliststatusset=nil, requestid=nil)
@DescribeSignListStatusSet = describesignliststatusset
@RequestId = requestid
end
def deserialize(params)
unless params['DescribeSignListStatusSet'].nil?
@DescribeSignListStatusSet = []
params['DescribeSignListStatusSet'].each do |i|
describesignliststatus_tmp = DescribeSignListStatus.new
describesignliststatus_tmp.deserialize(i)
@DescribeSignListStatusSet << describesignliststatus_tmp
end
end
@RequestId = params['RequestId']
end
end
# DescribeSmsTemplateList请求参数结构体
class DescribeSmsTemplateListRequest < TencentCloud::Common::AbstractModel
# @param TemplateIdSet: 模板 ID 数组。
# @type TemplateIdSet: Array
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# @type International: Integer
attr_accessor :TemplateIdSet, :International
def initialize(templateidset=nil, international=nil)
@TemplateIdSet = templateidset
@International = international
end
def deserialize(params)
@TemplateIdSet = params['TemplateIdSet']
@International = params['International']
end
end
# DescribeSmsTemplateList返回参数结构体
class DescribeSmsTemplateListResponse < TencentCloud::Common::AbstractModel
# @param DescribeTemplateStatusSet: 获取短信模板信息响应
# @type DescribeTemplateStatusSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :DescribeTemplateStatusSet, :RequestId
def initialize(describetemplatestatusset=nil, requestid=nil)
@DescribeTemplateStatusSet = describetemplatestatusset
@RequestId = requestid
end
def deserialize(params)
unless params['DescribeTemplateStatusSet'].nil?
@DescribeTemplateStatusSet = []
params['DescribeTemplateStatusSet'].each do |i|
describetemplateliststatus_tmp = DescribeTemplateListStatus.new
describetemplateliststatus_tmp.deserialize(i)
@DescribeTemplateStatusSet << describetemplateliststatus_tmp
end
end
@RequestId = params['RequestId']
end
end
# 获取短信模板信息响应
class DescribeTemplateListStatus < TencentCloud::Common::AbstractModel
# @param TemplateId: 模板Id
# @type TemplateId: Integer
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# @type International: Integer
# @param StatusCode: 申请模板状态,其中0表示审核通过且已生效,1表示审核中,2表示审核通过待生效,-1表示审核未通过或审核失败。
# @type StatusCode: Integer
# @param ReviewReply: 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
# @type ReviewReply: String
# @param TemplateName: 模板名称。
# @type TemplateName: String
# @param CreateTime: 提交审核时间,UNIX 时间戳(单位:秒)。
# @type CreateTime: Integer
attr_accessor :TemplateId, :International, :StatusCode, :ReviewReply, :TemplateName, :CreateTime
def initialize(templateid=nil, international=nil, statuscode=nil, reviewreply=nil, templatename=nil, createtime=nil)
@TemplateId = templateid
@International = international
@StatusCode = statuscode
@ReviewReply = reviewreply
@TemplateName = templatename
@CreateTime = createtime
end
def deserialize(params)
@TemplateId = params['TemplateId']
@International = params['International']
@StatusCode = params['StatusCode']
@ReviewReply = params['ReviewReply']
@TemplateName = params['TemplateName']
@CreateTime = params['CreateTime']
end
end
# 修改签名响应
class ModifySignStatus < TencentCloud::Common::AbstractModel
# @param SignId: 签名Id
# @type SignId: Integer
# @param SignApplyId: 签名修改申请Id
# @type SignApplyId: String
attr_accessor :SignId, :SignApplyId
def initialize(signid=nil, signapplyid=nil)
@SignId = signid
@SignApplyId = signapplyid
end
def deserialize(params)
@SignId = params['SignId']
@SignApplyId = params['SignApplyId']
end
end
# ModifySmsSign请求参数结构体
class ModifySmsSignRequest < TencentCloud::Common::AbstractModel
# @param SignId: 待修改的签名 ID。
# @type SignId: Integer
# @param SignName: 签名名称。
# @type SignName: String
# @param SignType: 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
# 0:公司,可选 DocumentType 有(0,1)。
# 1:APP,可选 DocumentType 有(0,1,2,3,4) 。
# 2:网站,可选 DocumentType 有(0,1,2,3,5)。
# 3:公众号,可选 DocumentType 有(0,1,2,3,8)。
# 4:商标,可选 DocumentType 有(7)。
# 5:政府/机关事业单位/其他机构,可选 DocumentType 有(2,3)。
# 6:小程序,可选 DocumentType 有(0,1,2,3,6)。
# 注:必须按照对应关系选择证明类型,否则会审核失败。
# @type SignType: Integer
# @param DocumentType: 证明类型:
# 0:三证合一。
# 1:企业营业执照。
# 2:组织机构代码证书。
# 3:社会信用代码证书。
# 4:应用后台管理截图(个人开发APP)。
# 5:网站备案后台截图(个人开发网站)。
# 6:小程序设置页面截图(个人认证小程序)。
# 7:商标注册书。
# 8:公众号设置页面截图(个人认证公众号)。
# @type DocumentType: Integer
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# 注:需要和待修改签名International值保持一致,该参数不能直接修改国内签名到国际签名。
# @type International: Integer
# @param UsedMethod: 签名用途:
# 0:自用。
# 1:他用。
# @type UsedMethod: Integer
# @param ProofImage: 签名对应的资质证明图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
# @type ProofImage: String
# @param CommissionImage: 委托授权证明。选择 UsedMethod 为他用之后需要提交委托的授权证明。
# 图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
# 注:只有 UsedMethod 在选择为 1(他用)时,这个字段才会生效。
# @type CommissionImage: String
# @param Remark: 签名的申请备注。
# @type Remark: String
# @param QualificationId: 已审核通过的国内短信的资质 ID。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。
# @type QualificationId: Integer
attr_accessor :SignId, :SignName, :SignType, :DocumentType, :International, :UsedMethod, :ProofImage, :CommissionImage, :Remark, :QualificationId
def initialize(signid=nil, signname=nil, signtype=nil, documenttype=nil, international=nil, usedmethod=nil, proofimage=nil, commissionimage=nil, remark=nil, qualificationid=nil)
@SignId = signid
@SignName = signname
@SignType = signtype
@DocumentType = documenttype
@International = international
@UsedMethod = usedmethod
@ProofImage = proofimage
@CommissionImage = commissionimage
@Remark = remark
@QualificationId = qualificationid
end
def deserialize(params)
@SignId = params['SignId']
@SignName = params['SignName']
@SignType = params['SignType']
@DocumentType = params['DocumentType']
@International = params['International']
@UsedMethod = params['UsedMethod']
@ProofImage = params['ProofImage']
@CommissionImage = params['CommissionImage']
@Remark = params['Remark']
@QualificationId = params['QualificationId']
end
end
# ModifySmsSign返回参数结构体
class ModifySmsSignResponse < TencentCloud::Common::AbstractModel
# @param ModifySignStatus: 修改签名响应
# @type ModifySignStatus: :class:`Tencentcloud::Sms.v20190711.models.ModifySignStatus`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :ModifySignStatus, :RequestId
def initialize(modifysignstatus=nil, requestid=nil)
@ModifySignStatus = modifysignstatus
@RequestId = requestid
end
def deserialize(params)
unless params['ModifySignStatus'].nil?
@ModifySignStatus = ModifySignStatus.new
@ModifySignStatus.deserialize(params['ModifySignStatus'])
end
@RequestId = params['RequestId']
end
end
# ModifySmsTemplate请求参数结构体
class ModifySmsTemplateRequest < TencentCloud::Common::AbstractModel
# @param TemplateId: 待修改的模板的模板 ID。
# @type TemplateId: Integer
# @param TemplateName: 新的模板名称。
# @type TemplateName: String
# @param TemplateContent: 新的模板内容。
# @type TemplateContent: String
# @param SmsType: 短信类型,1表示营销短信,2表示通知短信,3表示验证码短信。
# 注:为进一步提升短信发送质量、提高短信模板审核通过率,从2024年5月16日起,腾讯云短信模板类型优化为“验证码短信”、“通知短信”、“营销短信”,可参考[关于腾讯云短信模板类型优化公告](https://cloud.tencent.com/document/product/382/106171)。新开通短信服务的客户需严格参考新的短信类型申请短信模板。
# @type SmsType: Integer
# @param International: 是否国际/港澳台短信:
# 0:表示国内短信。
# 1:表示国际/港澳台短信。
# @type International: Integer
# @param Remark: 模板备注,例如申请原因,使用场景等。
# @type Remark: String
attr_accessor :TemplateId, :TemplateName, :TemplateContent, :SmsType, :International, :Remark
def initialize(templateid=nil, templatename=nil, templatecontent=nil, smstype=nil, international=nil, remark=nil)
@TemplateId = templateid
@TemplateName = templatename
@TemplateContent = templatecontent
@SmsType = smstype
@International = international
@Remark = remark
end
def deserialize(params)
@TemplateId = params['TemplateId']
@TemplateName = params['TemplateName']
@TemplateContent = params['TemplateContent']
@SmsType = params['SmsType']
@International = params['International']
@Remark = params['Remark']
end
end
# ModifySmsTemplate返回参数结构体
class ModifySmsTemplateResponse < TencentCloud::Common::AbstractModel
# @param ModifyTemplateStatus: 修改模板参数响应
# @type ModifyTemplateStatus: :class:`Tencentcloud::Sms.v20190711.models.ModifyTemplateStatus`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :ModifyTemplateStatus, :RequestId
def initialize(modifytemplatestatus=nil, requestid=nil)
@ModifyTemplateStatus = modifytemplatestatus
@RequestId = requestid
end
def deserialize(params)
unless params['ModifyTemplateStatus'].nil?
@ModifyTemplateStatus = ModifyTemplateStatus.new
@ModifyTemplateStatus.deserialize(params['ModifyTemplateStatus'])
end
@RequestId = params['RequestId']
end
end
# 修改模板参数响应
class ModifyTemplateStatus < TencentCloud::Common::AbstractModel
# @param TemplateId: 模板参数
# @type TemplateId: Integer
attr_accessor :TemplateId
def initialize(templateid=nil)
@TemplateId = templateid
end
def deserialize(params)
@TemplateId = params['TemplateId']
end
end
# 短信回复状态
class PullSmsReplyStatus < TencentCloud::Common::AbstractModel
# @param ExtendCode: 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
# @type ExtendCode: String
# @param NationCode: 国家(或地区)码。
# @type NationCode: String
# @param PhoneNumber: 手机号码,E.164标准,+[国家或地区码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
# @type PhoneNumber: String
# @param Sign: 短信签名。
# @type Sign: String
# @param ReplyContent: 用户回复的内容。
# @type ReplyContent: String
# @param ReplyTime: 回复时间(例如:2019-10-08 17:18:37)。
# @type ReplyTime: String
# @param ReplyUnixTime: 回复时间,UNIX 时间戳(单位:秒)。
# @type ReplyUnixTime: Integer
attr_accessor :ExtendCode, :NationCode, :PhoneNumber, :Sign, :ReplyContent, :ReplyTime, :ReplyUnixTime
def initialize(extendcode=nil, nationcode=nil, phonenumber=nil, sign=nil, replycontent=nil, replytime=nil, replyunixtime=nil)
@ExtendCode = extendcode
@NationCode = nationcode
@PhoneNumber = phonenumber
@Sign = sign
@ReplyContent = replycontent
@ReplyTime = replytime
@ReplyUnixTime = replyunixtime
end
def deserialize(params)
@ExtendCode = params['ExtendCode']
@NationCode = params['NationCode']
@PhoneNumber = params['PhoneNumber']
@Sign = params['Sign']
@ReplyContent = params['ReplyContent']
@ReplyTime = params['ReplyTime']
@ReplyUnixTime = params['ReplyUnixTime']
end
end
# PullSmsReplyStatusByPhoneNumber请求参数结构体
class PullSmsReplyStatusByPhoneNumberRequest < TencentCloud::Common::AbstractModel
# @param SendDateTime: 拉取起始时间,UNIX 时间戳(时间:秒)。
# 注:最大可拉取当前时期7天前的数据。
# @type SendDateTime: Integer
# @param Offset: 偏移量。
# 注:目前固定设置为0。
# @type Offset: Integer
# @param Limit: 拉取最大条数,最多 100。
# @type Limit: Integer
# @param PhoneNumber: 下发目的手机号码,依据 E.164 标准为:+[国家(或地区)码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
# @type PhoneNumber: String
# @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
# @type SmsSdkAppid: String
# @param EndDateTime: 拉取截止时间,UNIX 时间戳(时间:秒)。
# @type EndDateTime: Integer
attr_accessor :SendDateTime, :Offset, :Limit, :PhoneNumber, :SmsSdkAppid, :EndDateTime
def initialize(senddatetime=nil, offset=nil, limit=nil, phonenumber=nil, smssdkappid=nil, enddatetime=nil)
@SendDateTime = senddatetime
@Offset = offset
@Limit = limit
@PhoneNumber = phonenumber
@SmsSdkAppid = smssdkappid
@EndDateTime = enddatetime
end
def deserialize(params)
@SendDateTime = params['SendDateTime']
@Offset = params['Offset']
@Limit = params['Limit']
@PhoneNumber = params['PhoneNumber']
@SmsSdkAppid = params['SmsSdkAppid']
@EndDateTime = params['EndDateTime']
end
end
# PullSmsReplyStatusByPhoneNumber返回参数结构体
class PullSmsReplyStatusByPhoneNumberResponse < TencentCloud::Common::AbstractModel
# @param PullSmsReplyStatusSet: 回复状态响应集合。
# @type PullSmsReplyStatusSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :PullSmsReplyStatusSet, :RequestId
def initialize(pullsmsreplystatusset=nil, requestid=nil)
@PullSmsReplyStatusSet = pullsmsreplystatusset
@RequestId = requestid
end
def deserialize(params)
unless params['PullSmsReplyStatusSet'].nil?
@PullSmsReplyStatusSet = []
params['PullSmsReplyStatusSet'].each do |i|
pullsmsreplystatus_tmp = PullSmsReplyStatus.new
pullsmsreplystatus_tmp.deserialize(i)
@PullSmsReplyStatusSet << pullsmsreplystatus_tmp
end
end
@RequestId = params['RequestId']
end
end
# PullSmsReplyStatus请求参数结构体
class PullSmsReplyStatusRequest < TencentCloud::Common::AbstractModel
# @param Limit: 拉取最大条数,最多100条。
# @type Limit: Integer
# @param SmsSdkAppid: 短信 SdkAppid 在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际 SdkAppid,例如1400006666。
# @type SmsSdkAppid: String
attr_accessor :Limit, :SmsSdkAppid
def initialize(limit=nil, smssdkappid=nil)
@Limit = limit
@SmsSdkAppid = smssdkappid
end
def deserialize(params)
@Limit = params['Limit']
@SmsSdkAppid = params['SmsSdkAppid']
end
end
# PullSmsReplyStatus返回参数结构体
class PullSmsReplyStatusResponse < TencentCloud::Common::AbstractModel
# @param PullSmsReplyStatusSet: 回复状态响应集合。
# @type PullSmsReplyStatusSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :PullSmsReplyStatusSet, :RequestId
def initialize(pullsmsreplystatusset=nil, requestid=nil)
@PullSmsReplyStatusSet = pullsmsreplystatusset
@RequestId = requestid
end
def deserialize(params)
unless params['PullSmsReplyStatusSet'].nil?
@PullSmsReplyStatusSet = []
params['PullSmsReplyStatusSet'].each do |i|
pullsmsreplystatus_tmp = PullSmsReplyStatus.new
pullsmsreplystatus_tmp.deserialize(i)
@PullSmsReplyStatusSet << pullsmsreplystatus_tmp
end
end
@RequestId = params['RequestId']
end
end
# 短信的下发状态详细信息
class PullSmsSendStatus < TencentCloud::Common::AbstractModel
# @param UserReceiveTime: 用户实际接收到短信的时间。
# @type UserReceiveTime: String
# @param UserReceiveUnixTime: 用户实际接收到短信的时间,UNIX 时间戳(单位:秒)。
# @type UserReceiveUnixTime: Integer
# @param NationCode: 国家(或地区)码。
# @type NationCode: String
# @param PurePhoneNumber: 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
# @type PurePhoneNumber: String
# @param PhoneNumber: 手机号码,普通格式,示例如:18501234444。
# @type PhoneNumber: String
# @param SerialNo: 本次发送标识 ID。
# @type SerialNo: String
# @param ReportStatus: 实际是否收到短信接收状态,SUCCESS(成功)、FAIL(失败)。
# @type ReportStatus: String
# @param Description: 用户接收短信状态描述。
# @type Description: String
attr_accessor :UserReceiveTime, :UserReceiveUnixTime, :NationCode, :PurePhoneNumber, :PhoneNumber, :SerialNo, :ReportStatus, :Description
def initialize(userreceivetime=nil, userreceiveunixtime=nil, nationcode=nil, purephonenumber=nil, phonenumber=nil, serialno=nil, reportstatus=nil, description=nil)
@UserReceiveTime = userreceivetime
@UserReceiveUnixTime = userreceiveunixtime
@NationCode = nationcode
@PurePhoneNumber = purephonenumber
@PhoneNumber = phonenumber
@SerialNo = serialno
@ReportStatus = reportstatus
@Description = description
end
def deserialize(params)
@UserReceiveTime = params['UserReceiveTime']
@UserReceiveUnixTime = params['UserReceiveUnixTime']
@NationCode = params['NationCode']
@PurePhoneNumber = params['PurePhoneNumber']
@PhoneNumber = params['PhoneNumber']
@SerialNo = params['SerialNo']
@ReportStatus = params['ReportStatus']
@Description = params['Description']
end
end
# PullSmsSendStatusByPhoneNumber请求参数结构体
class PullSmsSendStatusByPhoneNumberRequest < TencentCloud::Common::AbstractModel
# @param SendDateTime: 拉取起始时间,UNIX 时间戳(时间:秒)。
# 注:最大可拉取当前时期7天前的数据。
# @type SendDateTime: Integer
# @param Offset: 偏移量。
# 注:目前固定设置为0。
# @type Offset: Integer
# @param Limit: 拉取最大条数,最多 100。
# @type Limit: Integer
# @param PhoneNumber: 下发目的手机号码,依据 E.164 标准为:+[国家(或地区)码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
# @type PhoneNumber: String
# @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
# @type SmsSdkAppid: String
# @param EndDateTime: 拉取截止时间,UNIX 时间戳(时间:秒)。
# @type EndDateTime: Integer
attr_accessor :SendDateTime, :Offset, :Limit, :PhoneNumber, :SmsSdkAppid, :EndDateTime
def initialize(senddatetime=nil, offset=nil, limit=nil, phonenumber=nil, smssdkappid=nil, enddatetime=nil)
@SendDateTime = senddatetime
@Offset = offset
@Limit = limit
@PhoneNumber = phonenumber
@SmsSdkAppid = smssdkappid
@EndDateTime = enddatetime
end
def deserialize(params)
@SendDateTime = params['SendDateTime']
@Offset = params['Offset']
@Limit = params['Limit']
@PhoneNumber = params['PhoneNumber']
@SmsSdkAppid = params['SmsSdkAppid']
@EndDateTime = params['EndDateTime']
end
end
# PullSmsSendStatusByPhoneNumber返回参数结构体
class PullSmsSendStatusByPhoneNumberResponse < TencentCloud::Common::AbstractModel
# @param PullSmsSendStatusSet: 下发状态响应集合。
# @type PullSmsSendStatusSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :PullSmsSendStatusSet, :RequestId
def initialize(pullsmssendstatusset=nil, requestid=nil)
@PullSmsSendStatusSet = pullsmssendstatusset
@RequestId = requestid
end
def deserialize(params)
unless params['PullSmsSendStatusSet'].nil?
@PullSmsSendStatusSet = []
params['PullSmsSendStatusSet'].each do |i|
pullsmssendstatus_tmp = PullSmsSendStatus.new
pullsmssendstatus_tmp.deserialize(i)
@PullSmsSendStatusSet << pullsmssendstatus_tmp
end
end
@RequestId = params['RequestId']
end
end
# PullSmsSendStatus请求参数结构体
class PullSmsSendStatusRequest < TencentCloud::Common::AbstractModel
# @param Limit: 拉取最大条数,最多100条。
# @type Limit: Integer
# @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
# @type SmsSdkAppid: String
attr_accessor :Limit, :SmsSdkAppid
def initialize(limit=nil, smssdkappid=nil)
@Limit = limit
@SmsSdkAppid = smssdkappid
end
def deserialize(params)
@Limit = params['Limit']
@SmsSdkAppid = params['SmsSdkAppid']
end
end
# PullSmsSendStatus返回参数结构体
class PullSmsSendStatusResponse < TencentCloud::Common::AbstractModel
# @param PullSmsSendStatusSet: 下发状态响应集合。
# @type PullSmsSendStatusSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :PullSmsSendStatusSet, :RequestId
def initialize(pullsmssendstatusset=nil, requestid=nil)
@PullSmsSendStatusSet = pullsmssendstatusset
@RequestId = requestid
end
def deserialize(params)
unless params['PullSmsSendStatusSet'].nil?
@PullSmsSendStatusSet = []
params['PullSmsSendStatusSet'].each do |i|
pullsmssendstatus_tmp = PullSmsSendStatus.new
pullsmssendstatus_tmp.deserialize(i)
@PullSmsSendStatusSet << pullsmssendstatus_tmp
end
end
@RequestId = params['RequestId']
end
end
# SendSms请求参数结构体
class SendSmsRequest < TencentCloud::Common::AbstractModel
# @param PhoneNumberSet: 下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
# 例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
# @type PhoneNumberSet: Array
# @param TemplateID: 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。
# @type TemplateID: String
# @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
# @type SmsSdkAppid: String
# @param Sign: 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。注:国内短信为必填参数。
# @type Sign: String
# @param TemplateParamSet: 模板参数,若无模板参数,则设置为空。
# @type TemplateParamSet: Array
# @param ExtendCode: 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
# @type ExtendCode: String
# @param SessionContext: 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。
# @type SessionContext: String
# @param SenderId: 国内短信无senderid,无需填写该项;若需开通国际/港澳台短信senderid,请联系smshelper。
# @type SenderId: String
attr_accessor :PhoneNumberSet, :TemplateID, :SmsSdkAppid, :Sign, :TemplateParamSet, :ExtendCode, :SessionContext, :SenderId
def initialize(phonenumberset=nil, templateid=nil, smssdkappid=nil, sign=nil, templateparamset=nil, extendcode=nil, sessioncontext=nil, senderid=nil)
@PhoneNumberSet = phonenumberset
@TemplateID = templateid
@SmsSdkAppid = smssdkappid
@Sign = sign
@TemplateParamSet = templateparamset
@ExtendCode = extendcode
@SessionContext = sessioncontext
@SenderId = senderid
end
def deserialize(params)
@PhoneNumberSet = params['PhoneNumberSet']
@TemplateID = params['TemplateID']
@SmsSdkAppid = params['SmsSdkAppid']
@Sign = params['Sign']
@TemplateParamSet = params['TemplateParamSet']
@ExtendCode = params['ExtendCode']
@SessionContext = params['SessionContext']
@SenderId = params['SenderId']
end
end
# SendSms返回参数结构体
class SendSmsResponse < TencentCloud::Common::AbstractModel
# @param SendStatusSet: 短信发送状态。
# @type SendStatusSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :SendStatusSet, :RequestId
def initialize(sendstatusset=nil, requestid=nil)
@SendStatusSet = sendstatusset
@RequestId = requestid
end
def deserialize(params)
unless params['SendStatusSet'].nil?
@SendStatusSet = []
params['SendStatusSet'].each do |i|
sendstatus_tmp = SendStatus.new
sendstatus_tmp.deserialize(i)
@SendStatusSet << sendstatus_tmp
end
end
@RequestId = params['RequestId']
end
end
# 发送短信状态
class SendStatus < TencentCloud::Common::AbstractModel
# @param SerialNo: 发送流水号。
# @type SerialNo: String
# @param PhoneNumber: 手机号码,E.164标准,+[国家或地区码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。
# @type PhoneNumber: String
# @param Fee: 计费条数,计费规则请查询 [计费策略](https://cloud.tencent.com/document/product/382/36135)。
# @type Fee: Integer
# @param SessionContext: 用户Session内容。
# @type SessionContext: String
# @param Code: 短信请求错误码,具体含义请参考错误码。
# @type Code: String
# @param Message: 短信请求错误码描述。
# @type Message: String
# @param IsoCode: 国家码或地区码,例如CN,US等,对于未识别出国家码或者地区码,默认返回DEF,具体支持列表请参考国际/港澳台计费总览。
# @type IsoCode: String
attr_accessor :SerialNo, :PhoneNumber, :Fee, :SessionContext, :Code, :Message, :IsoCode
def initialize(serialno=nil, phonenumber=nil, fee=nil, sessioncontext=nil, code=nil, message=nil, isocode=nil)
@SerialNo = serialno
@PhoneNumber = phonenumber
@Fee = fee
@SessionContext = sessioncontext
@Code = code
@Message = message
@IsoCode = isocode
end
def deserialize(params)
@SerialNo = params['SerialNo']
@PhoneNumber = params['PhoneNumber']
@Fee = params['Fee']
@SessionContext = params['SessionContext']
@Code = params['Code']
@Message = params['Message']
@IsoCode = params['IsoCode']
end
end
# 发送数据统计响应包体
class SendStatusStatistics < TencentCloud::Common::AbstractModel
# @param FeeCount: 短信计费条数统计,例如提交成功量为100条,其中有20条是长短信(长度为80字)被拆分成2条,则计费条数为: ```80 * 1 + 20 * 2 = 120``` 条。
# @type FeeCount: Integer
# @param RequestCount: 短信提交量统计。
# @type RequestCount: Integer
# @param RequestSuccessCount: 短信提交成功量统计。
# @type RequestSuccessCount: Integer
attr_accessor :FeeCount, :RequestCount, :RequestSuccessCount
def initialize(feecount=nil, requestcount=nil, requestsuccesscount=nil)
@FeeCount = feecount
@RequestCount = requestcount
@RequestSuccessCount = requestsuccesscount
end
def deserialize(params)
@FeeCount = params['FeeCount']
@RequestCount = params['RequestCount']
@RequestSuccessCount = params['RequestSuccessCount']
end
end
# SendStatusStatistics请求参数结构体
class SendStatusStatisticsRequest < TencentCloud::Common::AbstractModel
# @param StartDateTime: 拉取起始时间,yyyymmddhh 需要拉取的起始时间,精确到小时。
# @type StartDateTime: Integer
# @param EndDataTime: 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时
# 注:EndDataTime 必须大于等于 StartDateTime。
# @type EndDataTime: Integer
# @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
# @type SmsSdkAppid: String
# @param Limit: 最大上限。
# 注:目前固定设置为0。
# @type Limit: Integer
# @param Offset: 偏移量。
# 注:目前固定设置为0。
# @type Offset: Integer
attr_accessor :StartDateTime, :EndDataTime, :SmsSdkAppid, :Limit, :Offset
def initialize(startdatetime=nil, enddatatime=nil, smssdkappid=nil, limit=nil, offset=nil)
@StartDateTime = startdatetime
@EndDataTime = enddatatime
@SmsSdkAppid = smssdkappid
@Limit = limit
@Offset = offset
end
def deserialize(params)
@StartDateTime = params['StartDateTime']
@EndDataTime = params['EndDataTime']
@SmsSdkAppid = params['SmsSdkAppid']
@Limit = params['Limit']
@Offset = params['Offset']
end
end
# SendStatusStatistics返回参数结构体
class SendStatusStatisticsResponse < TencentCloud::Common::AbstractModel
# @param SendStatusStatistics: 发送数据统计响应包体。
# @type SendStatusStatistics: :class:`Tencentcloud::Sms.v20190711.models.SendStatusStatistics`
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :SendStatusStatistics, :RequestId
def initialize(sendstatusstatistics=nil, requestid=nil)
@SendStatusStatistics = sendstatusstatistics
@RequestId = requestid
end
def deserialize(params)
unless params['SendStatusStatistics'].nil?
@SendStatusStatistics = SendStatusStatistics.new
@SendStatusStatistics.deserialize(params['SendStatusStatistics'])
end
@RequestId = params['RequestId']
end
end
# 套餐包信息统计响应包体
class SmsPackagesStatistics < TencentCloud::Common::AbstractModel
# @param PackageCreateTime: 套餐包创建时间,标准时间,例如:2019-10-08 17:18:37。
# @type PackageCreateTime: String
# @param PackageCreateUnixTime: 套餐包创建时间,UNIX 时间戳(单位:秒)。
# @type PackageCreateUnixTime: Integer
# @param PackageEffectiveTime: 套餐包生效时间,标准时间,例如:2019-10-08 17:18:37。
# @type PackageEffectiveTime: String
# @param PackageEffectiveUnixTime: 套餐包生效时间,UNIX 时间戳(单位:秒)。
# @type PackageEffectiveUnixTime: Integer
# @param PackageExpiredTime: 套餐包过期时间,标准时间,例如:2019-10-08 17:18:37。
# @type PackageExpiredTime: String
# @param PackageExpiredUnixTime: 套餐包过期时间,UNIX 时间戳(单位:秒)。
# @type PackageExpiredUnixTime: Integer
# @param AmountOfPackage: 套餐包条数。
# @type AmountOfPackage: Integer
# @param TypeOfPackage: 0表示赠送套餐包,1表示购买套餐包。
# @type TypeOfPackage: Integer
# @param PackageId: 套餐包 ID。
# @type PackageId: Integer
# @param CurrentUsage: 当前使用量。
# @type CurrentUsage: Integer
attr_accessor :PackageCreateTime, :PackageCreateUnixTime, :PackageEffectiveTime, :PackageEffectiveUnixTime, :PackageExpiredTime, :PackageExpiredUnixTime, :AmountOfPackage, :TypeOfPackage, :PackageId, :CurrentUsage
def initialize(packagecreatetime=nil, packagecreateunixtime=nil, packageeffectivetime=nil, packageeffectiveunixtime=nil, packageexpiredtime=nil, packageexpiredunixtime=nil, amountofpackage=nil, typeofpackage=nil, packageid=nil, currentusage=nil)
@PackageCreateTime = packagecreatetime
@PackageCreateUnixTime = packagecreateunixtime
@PackageEffectiveTime = packageeffectivetime
@PackageEffectiveUnixTime = packageeffectiveunixtime
@PackageExpiredTime = packageexpiredtime
@PackageExpiredUnixTime = packageexpiredunixtime
@AmountOfPackage = amountofpackage
@TypeOfPackage = typeofpackage
@PackageId = packageid
@CurrentUsage = currentusage
end
def deserialize(params)
@PackageCreateTime = params['PackageCreateTime']
@PackageCreateUnixTime = params['PackageCreateUnixTime']
@PackageEffectiveTime = params['PackageEffectiveTime']
@PackageEffectiveUnixTime = params['PackageEffectiveUnixTime']
@PackageExpiredTime = params['PackageExpiredTime']
@PackageExpiredUnixTime = params['PackageExpiredUnixTime']
@AmountOfPackage = params['AmountOfPackage']
@TypeOfPackage = params['TypeOfPackage']
@PackageId = params['PackageId']
@CurrentUsage = params['CurrentUsage']
end
end
# SmsPackagesStatistics请求参数结构体
class SmsPackagesStatisticsRequest < TencentCloud::Common::AbstractModel
# @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
# @type SmsSdkAppid: String
# @param Limit: 最大上限(需要拉取的套餐包个数)。
# 注:Limit默认最大值为500,可结合Offset实现分页查询。
# @type Limit: Integer
# @param Offset: 偏移量。
# @type Offset: Integer
attr_accessor :SmsSdkAppid, :Limit, :Offset
def initialize(smssdkappid=nil, limit=nil, offset=nil)
@SmsSdkAppid = smssdkappid
@Limit = limit
@Offset = offset
end
def deserialize(params)
@SmsSdkAppid = params['SmsSdkAppid']
@Limit = params['Limit']
@Offset = params['Offset']
end
end
# SmsPackagesStatistics返回参数结构体
class SmsPackagesStatisticsResponse < TencentCloud::Common::AbstractModel
# @param SmsPackagesStatisticsSet: 发送数据统计响应包体。
# @type SmsPackagesStatisticsSet: Array
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :SmsPackagesStatisticsSet, :RequestId
def initialize(smspackagesstatisticsset=nil, requestid=nil)
@SmsPackagesStatisticsSet = smspackagesstatisticsset
@RequestId = requestid
end
def deserialize(params)
unless params['SmsPackagesStatisticsSet'].nil?
@SmsPackagesStatisticsSet = []
params['SmsPackagesStatisticsSet'].each do |i|
smspackagesstatistics_tmp = SmsPackagesStatistics.new
smspackagesstatistics_tmp.deserialize(i)
@SmsPackagesStatisticsSet << smspackagesstatistics_tmp
end
end
@RequestId = params['RequestId']
end
end
end
end
end