Class: TencentCloud::Sms::V20210111::SendSmsRequest

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

Overview

SendSms请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SendSmsRequest.



1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/v20210111/models.rb', line 1305

def initialize(phonenumberset=nil, smssdkappid=nil, templateid=nil, signname=nil, templateparamset=nil, extendcode=nil, sessioncontext=nil, senderid=nil)
  @PhoneNumberSet = phonenumberset
  @SmsSdkAppId = smssdkappid
  @TemplateId = templateid
  @SignName = signname
  @TemplateParamSet = templateparamset
  @ExtendCode = extendcode
  @SessionContext = sessioncontext
  @SenderId = senderid
end

Instance Attribute Details

#ExtendCode ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def ExtendCode
  @ExtendCode
end

#PhoneNumberSet ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def PhoneNumberSet
  @PhoneNumberSet
end

#SenderId ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def SenderId
  @SenderId
end

#SessionContext ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def SessionContext
  @SessionContext
end

#SignName ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def SignName
  @SignName
end

#SmsSdkAppId ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def SmsSdkAppId
  @SmsSdkAppId
end

#TemplateId ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def TemplateId
  @TemplateId
end

#TemplateParamSet ⇒ Object

例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。

  • 发送国内短信该参数必填，且需填写签名内容而非签名ID。

  • 发送国际/港澳台短信该参数非必填。
模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。

Parameters:

  • PhoneNumberSet: —

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

  • SmsSdkAppId: —

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

  • TemplateId: —

    模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国内短信 或 国际/港澳台短信 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。

  • SignName: —

    短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 国内短信 或 国际/港澳台短信 的签名管理查看。

  • TemplateParamSet: —

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

  • ExtendCode: —

    短信码号扩展号，默认未开通，如需开通请联系 腾讯云短信小助手。

  • SessionContext: —

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

  • SenderId: —

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



1303
1304
1305
 
# File 'lib/v20210111/models.rb', line 1303

def TemplateParamSet
  @TemplateParamSet
end

Instance Method Details

#deserialize(params) ⇒ Object 



1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/v20210111/models.rb', line 1316

def deserialize(params)
  @PhoneNumberSet = params['PhoneNumberSet']
  @SmsSdkAppId = params['SmsSdkAppId']
  @TemplateId = params['TemplateId']
  @SignName = params['SignName']
  @TemplateParamSet = params['TemplateParamSet']
  @ExtendCode = params['ExtendCode']
  @SessionContext = params['SessionContext']
  @SenderId = params['SenderId']
end