AddSignStatus
添加签名响应
被如下接口引用:AddSmsSign。
名称 | 类型 | 描述 |
---|---|---|
SignId | Integer | 签名ID。 示例值:1110 |
AddTemplateStatus
添加模板参数响应
被如下接口引用:AddSmsTemplate。
名称 | 类型 | 描述 |
---|---|---|
TemplateId | String | 模板ID。 示例值:1110 |
CallbackStatusStatistics
回执数据统计响应包体
被如下接口引用:CallbackStatusStatistics。
名称 | 类型 | 描述 |
---|---|---|
CallbackCount | Integer | 短信回执量统计。 |
RequestSuccessCount | Integer | 短信提交成功量统计。 |
CallbackFailCount | Integer | 短信回执失败量统计。 |
CallbackSuccessCount | Integer | 短信回执成功量统计。 |
InternalErrorCount | Integer | 运营商内部错误统计。 |
InvalidNumberCount | Integer | 号码无效或空号统计。 |
ShutdownErrorCount | Integer | 停机、关机等错误统计。 |
BlackListCount | Integer | 号码拉入黑名单统计。 |
FrequencyLimitCount | Integer | 运营商频率限制统计。 |
DeleteSignStatus
删除签名响应
被如下接口引用:DeleteSmsSign。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DeleteStatus | String | 是 | 删除状态信息。 示例值:return successfully! |
DeleteTime | Integer | 是 | 删除时间,UNIX 时间戳(单位:秒)。 示例值:1578988506 |
DeleteTemplateStatus
删除模板响应
被如下接口引用:DeleteSmsTemplate。
名称 | 类型 | 描述 |
---|---|---|
DeleteStatus | String | 删除状态信息。 |
DeleteTime | Integer | 删除时间,UNIX 时间戳(单位:秒)。 |
DescribeSignListStatus
获取短信签名信息响应
被如下接口引用:DescribeSmsSignList。
名称 | 类型 | 描述 |
---|---|---|
SignId | Integer | 签名ID。 示例值:1110 |
International | Integer | 是否国际/港澳台短信,其中0表示国内短信,1表示国际/港澳台短信。 示例值:0 |
StatusCode | Integer | 申请签名状态,其中0表示审核通过且已生效,1表示审核中,2表示审核通过待生效,-1表示审核未通过或审核失败。 示例值:0 |
ReviewReply | String | 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。 示例值:通过 |
SignName | String | 签名名称。 示例值:腾讯云 |
CreateTime | Integer | 提交审核时间,UNIX 时间戳(单位:秒)。 示例值:1620734188 |
DescribeTemplateListStatus
获取短信模板信息响应
被如下接口引用:DescribeSmsTemplateList。
名称 | 类型 | 描述 |
---|---|---|
TemplateId | Integer | 模板ID。 示例值:1110 |
International | Integer | 是否国际/港澳台短信,其中0表示国内短信,1表示国际/港澳台短信,3表示该模板既支持国内短信也支持国际/港澳台短信。 示例值:0 |
StatusCode | Integer | 申请模板状态,其中0表示审核通过且已生效,1表示审核中,2表示审核通过待生效,-1表示审核未通过或审核失败。注:只有状态值为0时该模板才能使用。 示例值:0 |
ReviewReply | String | 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。 示例值:通过 |
TemplateName | String | 模板名称。 示例值:业务验证码 |
CreateTime | Integer | 提交审核时间,UNIX 时间戳(单位:秒)。 示例值:1620640474 |
TemplateContent | String | 模板内容。 示例值:验证码是{1} |
ModifySignStatus
修改签名响应
被如下接口引用:ModifySmsSign。
名称 | 类型 | 描述 |
---|---|---|
SignId | Integer | 签名ID。 示例值:1110 |
ModifyTemplateStatus
修改模板参数响应
被如下接口引用:ModifySmsTemplate。
名称 | 类型 | 描述 |
---|---|---|
TemplateId | Integer | 模板ID。 示例值:1110 |
PhoneNumberInfo
号码信息。
被如下接口引用:DescribePhoneNumberInfo。
名称 | 类型 | 描述 |
---|---|---|
Code | String | 号码信息查询错误码,查询成功返回 "Ok"。 示例值:Ok |
Message | String | 号码信息查询错误码描述。 示例值:Describe success |
NationCode | String | 国家(或地区)码。 示例值:86 |
SubscriberNumber | String | 用户号码,去除国家或地区码前缀的普通格式,示例如:18501234444。 示例值:18501234444 |
PhoneNumber | String | 解析后的规范的 E.164 号码,与下发短信的号码解析结果一致。解析失败时会原样返回。 示例值:+8618501234444 |
IsoCode | String | 国家码或地区码,例如 CN、US 等,对于未识别出国家码或者地区码,默认返回 DEF。 示例值:CN |
IsoName | String | 国家码或地区名,例如 China,可参考 国际/港澳台短信价格总览 示例值:China |
PullSmsReplyStatus
短信回复状态
被如下接口引用:PullSmsReplyStatus, PullSmsReplyStatusByPhoneNumber。
名称 | 类型 | 描述 |
---|---|---|
ExtendCode | String | 短信码号扩展号,默认未开通,如需开通请联系 sms helper。 示例值:11 |
CountryCode | String | 国家(或地区)码。 示例值:86 |
PhoneNumber | String | 手机号码,E.164标准,+[国家或地区码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 示例值:+8618501234444 |
SignName | String | 短信签名名称。 示例值:腾讯云 |
ReplyContent | String | 用户回复的内容。 示例值:2 |
ReplyTime | Integer | 回复时间,UNIX 时间戳(单位:秒)。 示例值:1620734188 |
SubscriberNumber | String | 用户号码,普通格式,示例如:18501234444。 示例值:18501234444 |
PullSmsSendStatus
短信的下发状态详细信息
被如下接口引用:PullSmsSendStatus, PullSmsSendStatusByPhoneNumber。
名称 | 类型 | 描述 |
---|---|---|
UserReceiveTime | Integer | 用户实际接收到短信的时间,UNIX 时间戳(单位:秒)。 示例值:1620734188 |
CountryCode | String | 国家(或地区)码。 示例值:86 |
SubscriberNumber | String | 用户号码,普通格式,示例如:18501234444。 示例值:18501234444 |
PhoneNumber | String | 手机号码,E.164标准,+[国家或地区码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 示例值:+8618501234444 |
SerialNo | String | 本次发送标识 ID。 示例值:5000:1045710669157053657849499619 |
ReportStatus | String | 实际是否收到短信接收状态,SUCCESS(成功)、FAIL(失败)。 示例值:SUCCESS |
Description | String | 用户接收短信状态描述。 示例值:DELIVRD |
SessionContext | String | 用户的 session 内容。与请求中的 SessionContext 一致,默认为空,如需开通请联系 腾讯云短信小助手 评估。 示例值:outsid_1729495320_1011 |
ReportConversionStatus
转化率上报响应。
被如下接口引用:ReportConversion。
名称 | 类型 | 描述 |
---|---|---|
Code | String | 错误码。上报成功返回 ok。 示例值:ok |
Message | String | 错误码描述。 示例值:report success |
SendStatus
发送短信状态
被如下接口引用:SendSms。
名称 | 类型 | 描述 |
---|---|---|
SerialNo | String | 发送流水号。 示例值:5000:1045710669157053657849499619 |
PhoneNumber | String | 手机号码,E.164标准,+[国家或地区码][手机号] ,示例如:+8618501234444, 其中前面有一个+号 ,86为国家码,18501234444为手机号。 示例值:+8618501234444 |
Fee | Integer | 计费条数,计费规则请查询 计费策略。 示例值:1 |
SessionContext | String | 用户 session 内容。 示例值:outsid_1729495320_1011 |
Code | String | 短信请求错误码,具体含义请参考 错误码,发送成功返回 "Ok"。 示例值:Ok |
Message | String | 短信请求错误码描述。 示例值:send success |
IsoCode | String | 国家码或地区码,例如 CN、US 等,对于未识别出国家码或者地区码,默认返回 DEF,具体支持列表请参考 国际/港澳台短信价格总览。 示例值:CN |
SendStatusStatistics
发送数据统计响应包体
被如下接口引用:SendStatusStatistics。
名称 | 类型 | 描述 |
---|---|---|
FeeCount | Integer | 短信计费条数统计,例如提交成功量为100条,其中有20条是长短信(长度为80字)被拆分成2条,则计费条数为:
|
RequestCount | Integer | 短信提交量统计。 |
RequestSuccessCount | Integer | 短信提交成功量统计。 |
SmsPackagesStatistics
套餐包信息统计响应包体
被如下接口引用:SmsPackagesStatistics。
名称 | 类型 | 描述 |
---|---|---|
PackageCreateTime | Integer | 套餐包创建时间,UNIX 时间戳(单位:秒)。 示例值:1617206400 |
PackageEffectiveTime | Integer | 套餐包生效时间,UNIX 时间戳(单位:秒)。 示例值:1617206400 |
PackageExpiredTime | Integer | 套餐包过期时间,UNIX 时间戳(单位:秒)。 示例值:1619798400 |
PackageAmount | Integer | 套餐包条数。 示例值:1000 |
PackageType | Integer | 套餐包类别,0表示赠送套餐包,1表示购买套餐包。 示例值:1 |
PackageId | Integer | 套餐包 ID。 示例值:1000791745 |
CurrentUsage | Integer | 当前使用套餐包条数。 示例值:100 |