Class: TencentCloud::Sms::V20190711::SendSmsRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20190711/models.rb

Overview

SendSms请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(phonenumberset = nil, templateid = nil, smssdkappid = nil, sign = nil, templateparamset = nil, extendcode = nil, sessioncontext = nil, senderid = nil) ⇒ SendSmsRequest

Returns a new instance of SendSmsRequest.



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
# File 'lib/v20190711/models.rb', line 1145

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

Instance Attribute Details

#ExtendCode ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def ExtendCode
  @ExtendCode
end

#PhoneNumberSet ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def PhoneNumberSet
  @PhoneNumberSet
end

#SenderId ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def SenderId
  @SenderId
end

#SessionContext ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def SessionContext
  @SessionContext
end

#Sign ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def Sign
  @Sign
end

#SmsSdkAppid ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def SmsSdkAppid
  @SmsSdkAppid
end

#TemplateID ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def TemplateID
  @TemplateID
end

#TemplateParamSet ⇒ Object

例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 注:国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。

Parameters:

  • PhoneNumberSet: —

    下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。

  • TemplateID: —

    模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 短信控制台 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。

  • SmsSdkAppid: —

    短信SdkAppid在 短信控制台 添加应用后生成的实际SdkAppid,示例如1400006666。

  • Sign: —

    短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 短信控制台 查看。注:国内短信为必填参数。

  • TemplateParamSet: —

    模板参数,若无模板参数,则设置为空。

  • ExtendCode: —

    短信码号扩展号,默认未开通,如需开通请联系 sms helper。

  • SessionContext: —

    用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。注意长度需小于512字节。

  • SenderId: —

    国际/港澳台短信 Sender ID。可参考 Sender ID 说明。



1143
1144
1145
# File 'lib/v20190711/models.rb', line 1143

def TemplateParamSet
  @TemplateParamSet
end

Instance Method Details

#deserialize(params) ⇒ Object



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
# File 'lib/v20190711/models.rb', line 1156

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