数据结构

最近更新时间:2020-07-22 08:17:18

AddSignStatus

添加签名响应

被如下接口引用:AddSmsSign。

名称 类型 描述
SignId Integer 签名Id。
SignApplyId Integer 签名申请Id。

AddTemplateStatus

添加模板参数响应

被如下接口引用:AddSmsTemplate。

名称 类型 描述
TemplateId String 模板参数

CallbackStatusStatistics

回执数据统计响应包体

被如下接口引用:CallbackStatusStatistics。

名称 类型 描述
CallbackCount Integer 短信回执量统计。
RequestSuccessCount Integer 短信提交成功量统计。
CallbackFailCount Integer 短信回执失败量统计。
CallbackSuccessCount Integer 短信回执成功量统计。
InternalErrorCount Integer 运营商内部错误统计。
InvalidNumberCount Integer 号码无效或空号统计。
ShutdownErrorCount Integer 停机、关机等错误统计。
BlackListCount Integer 号码拉入黑名单统计。
FrequencyLimitCount Integer 运营商频率限制统计。

DeleteSignStatus

删除签名响应

被如下接口引用:DeleteSmsSign。

名称 类型 必选 描述
DeleteStatus String 删除状态信息。
DeleteTime Integer 删除时间,UNIX 时间戳(单位:秒)。

DeleteTemplateStatus

删除模板响应

被如下接口引用:DeleteSmsTemplate。

名称 类型 描述
DeleteStatus String 删除状态信息。
DeleteTime Integer 删除时间,UNIX 时间戳(单位:秒)。

DescribeSignListStatus

获取短信签名信息响应

被如下接口引用:DescribeSmsSignList。

名称 类型 描述
SignId Integer 签名Id
International Integer 是否国际/港澳台短信:
0:表示国内短信。
1:表示国际/港澳台短信。
StatusCode Integer 申请签名状态。其中:
0:表示审核通过。
1:表示审核中。
-1:表示审核未通过或审核失败。
ReviewReply String 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
SignName String 签名名称。
CreateTime Integer 提交审核时间,UNIX 时间戳(单位:秒)。

DescribeTemplateListStatus

获取短信模板信息响应

被如下接口引用:DescribeSmsTemplateList。

名称 类型 描述
TemplateId Integer 模板Id
International Integer 是否国际/港澳台短信:
0:表示国内短信。
1:表示国际/港澳台短信。
StatusCode Integer 申请签名状态。其中:
0:表示审核通过。
1:表示审核中。
-1:表示审核未通过或审核失败。
ReviewReply String 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
TemplateName String 模板名称。
CreateTime Integer 提交审核时间,UNIX 时间戳(单位:秒)。

ModifySignStatus

修改签名响应

被如下接口引用:ModifySmsSign。

名称 类型 描述
SignId Integer 签名Id
SignApplyId String 签名修改申请Id

ModifyTemplateStatus

修改模板参数响应

被如下接口引用:ModifySmsTemplate。

名称 类型 描述
TemplateId Integer 模板参数

PullSmsReplyStatus

短信回复状态

被如下接口引用:PullSmsReplyStatus, PullSmsReplyStatusByPhoneNumber。

名称 类型 描述
ExtendCode String 短信码号扩展号,默认未开通,如需开通请联系 sms helper
NationCode String 国家(或地区)码。
PhoneNumber String 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
Sign String 短信签名。
ReplyContent String 用户回复的内容。
ReplyTime String 回复时间(例如:2019-10-08 17:18:37)。
ReplyUnixTime Integer 回复时间,UNIX 时间戳(单位:秒)。

PullSmsSendStatus

短信的下发状态详细信息

被如下接口引用:PullSmsSendStatus, PullSmsSendStatusByPhoneNumber。

名称 类型 描述
UserReceiveTime String 用户实际接收到短信的时间。
UserReceiveUnixTime Integer 用户实际接收到短信的时间,UNIX 时间戳(单位:秒)。
NationCode String 国家(或地区)码。
PurePhoneNumber String 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
PhoneNumber String 手机号码,普通格式,示例如:13711112222。
SerialNo String 本次发送标识 ID。
ReportStatus String 实际是否收到短信接收状态,SUCCESS(成功)、FAIL(失败)。
Description String 用户接收短信状态描述。

SendStatus

发送短信状态

被如下接口引用:SendSms。

名称 类型 描述
SerialNo String 发送流水号。
PhoneNumber String 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
Fee Integer 计费条数,计费规则请查询 计费策略
SessionContext String 用户Session内容。
Code String 短信请求错误码,具体含义请参考错误码。
Message String 短信请求错误码描述。
IsoCode String 国家码或地区码,例如CN,US等,对于未识别出国家码或者地区码,默认返回DEF,具体支持列表请参考国际/港澳台计费总览。

SendStatusStatistics

发送数据统计响应包体

被如下接口引用:SendStatusStatistics。

名称 类型 描述
FeeCount Integer 短信计费条数统计,例如提交成功量为100条,其中有20条是长短信(长度为80字)被拆分成2条,则计费条数为: 80 * 1 + 20 * 2 = 120 条。
RequestCount Integer 短信提交量统计。
RequestSuccessCount Integer 短信提交成功量统计。

SmsPackagesStatistics

套餐包信息统计响应包体

被如下接口引用:SmsPackagesStatistics。

名称 类型 描述
PackageCreateTime String 套餐包创建时间,标准时间,例如:2019-10-08 17:18:37。
PackageCreateUnixTime Integer 套餐包创建时间,UNIX 时间戳(单位:秒)。
PackageEffectiveTime String 套餐包生效时间,标准时间,例如:2019-10-08 17:18:37。
PackageEffectiveUnixTime Integer 套餐包生效时间,UNIX 时间戳(单位:秒)。
PackageExpiredTime String 套餐包过期时间,标准时间,例如:2019-10-08 17:18:37。
PackageExpiredUnixTime Integer 套餐包过期时间,UNIX 时间戳(单位:秒)。
AmountOfPackage Integer 套餐包条数。
TypeOfPackage Integer 0表示赠送套餐包,1表示购买套餐包。
PackageId Integer 套餐包 ID。
CurrentUsage Integer 当前使用量。
目录