待修改的签名 ID。
*/ SignId: number; /** *签名名称。
*/ SignName: string; /** *签名类型。其中每种类型后面标注了其可选的 DocumentType（证明类型）：
0：公司，可选 DocumentType 有（0，1）。
1：APP，可选 DocumentType 有（0，1，2，3，4） 。
4：商标，可选 DocumentType 有（7）。
5：政府/机关事业单位/其他机构，可选 DocumentType 有（2，3）。
注1：必须按照对应关系选择证明类型，否则会审核失败。
注2：签名类型2（网站）、3（公众号）、6（小程序）已不再支持，具体可参考 关于腾讯云短信签名申请规则更新的公告。
注3：申请国内短信签名已不再支持签名类型1（APP），具体可参考 关于腾讯云短信签名申请规则更新的公告。
证明类型：
0：三证合一。
1：企业营业执照。
2：组织机构代码证书。
3：社会信用代码证书。
4：应用后台管理截图（个人开发APP）。
7：商标注册书。
注1：证明类型5（网站备案后台截图）、6（小程序设置页面截图）、8（公众号设置页面截图）已不再支持，具体可参考 关于腾讯云短信签名申请规则更新的公告。
注2：申请国内短信签名已不再支持证明类型4（应用后台管理截图），具体可参考 关于腾讯云短信签名申请规则更新的公告。
是否国际/港澳台短信：
0：表示国内短信。
1：表示国际/港澳台短信。
注：需要和待修改签名International值保持一致，该参数不能直接修改国内签名到国际签名。
签名用途：
0：自用。
1：他用。
签名对应的资质证明图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
委托授权证明。选择 SignPurpose 为他用之后需要提交委托的授权证明。
图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
注：只有 SignPurpose 在选择为 1（他用）时，这个字段才会生效。
签名的申请备注。
*/ Remark?: string; /** *已审核通过的国内短信的资质 ID。资质 ID 信息可前往国内短信的 实名资质管理 页查看。
*/ QualificationId?: number; } /** * SmsPackagesStatistics请求参数结构体 */ export interface SmsPackagesStatisticsRequest { /** * 短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。 */ SmsSdkAppId: string; /** * 最大上限(需要拉取的套餐包个数)。 注：Limit默认最大值为500，可结合Offset实现分页查询。 */ Limit: number; /** * 偏移量。 */ Offset: number; /** * 起始时间，格式为yyyymmddhh，精确到小时，例如2024050113，表示2024年5月1号13时。 注：接口会返回 BeginTime 到 EndTime 之间创建的套餐包的统计信息。 */ BeginTime: string; /** * 结束时间，格式为yyyymmddhh，精确到小时，例如2024050118，表示2024年5月1号18时。 注：EndTime 必须大于 BeginTime 且小于当前时间。 */ EndTime: string; } /** * 转化率上报响应。 */ export interface ReportConversionStatus { /** * 错误码。上报成功返回 ok。 */ Code: string; /** * 错误码描述。 */ Message: string; } /** * AddSmsSign请求参数结构体 */ export interface AddSmsSignRequest { /** *说明
- 国内短信需填写资质ID，国际短信无需填写。
签名名称。
注：不能重复申请已通过或待审核的签名。
签名类型。其中每种类型后面标注了其可选的 DocumentType（证明类型）：
0：公司，可选 DocumentType 有（0，1）。
1：APP，可选 DocumentType 有（0，1，2，3，4） 。
4：商标，可选 DocumentType 有（7）。
5：政府/机关事业单位/其他机构，可选 DocumentType 有（2，3）。
注1：必须按照对应关系选择证明类型，否则会审核失败。
注2：签名类型2（网站）、3（公众号）、6（小程序）已不再支持，具体可参考 关于腾讯云短信签名申请规则更新的公告。
注3：申请国内短信签名已不再支持签名类型1（APP），具体可参考 关于腾讯云短信签名申请规则更新的公告。
证明类型：
0：三证合一。
1：企业营业执照。
2：组织机构代码证书。
3：社会信用代码证书。
4：应用后台管理截图（个人开发APP）。
7：商标注册书。
注1：证明类型5（网站备案后台截图）、6（小程序设置页面截图）、8（公众号设置页面截图）已不再支持，具体可参考 关于腾讯云短信签名申请规则更新的公告。
注2：申请国内短信签名已不再支持证明类型4（应用后台管理截图），具体可参考 关于腾讯云短信签名申请规则更新的公告。
是否国际/港澳台短信：
0：表示国内短信。
1：表示国际/港澳台短信。
签名用途：
0：自用。
1：他用。
签名对应的资质证明图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
委托授权证明。选择 SignPurpose 为他用之后需要提交委托的授权证明。
图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
注：只有 SignPurpose 在选择为 1（他用）时，这个字段才会生效。
签名的申请备注。
*/ Remark?: string; /** *已审核通过的国内短信的资质 ID。资质 ID 信息可前往国内短信的 实名资质管理 页查看。
*/ QualificationId?: number; } /** * 添加模板参数响应 */ export interface AddTemplateStatus { /** * 模板ID。 */ TemplateId: string; } /** * DescribeSmsTemplateList返回参数结构体 */ export interface DescribeSmsTemplateListResponse { /** * 获取短信模板信息响应 */ DescribeTemplateStatusSet?: Array说明
- 国内短信需填写资质ID，国际短信无需填写。
短信下发记录集合。
*/ SendRecordSet?: Array查询时间范围内的下发记录总数，注：最大支持查询单个下发手机号码 72 小时内的 1000 条记录。
*/ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySmsTemplate请求参数结构体 */ export interface ModifySmsTemplateRequest { /** * 待修改模板的ID。 */ TemplateId: number; /** * 新的模板名称。 */ TemplateName: string; /** * 新的模板内容。 */ TemplateContent: string; /** * 短信类型，1表示营销短信，2表示通知短信，3表示验证码短信。 注：为进一步提升短信发送质量、提高短信模板审核通过率，从2024年5月16日起，腾讯云短信模板类型优化为“验证码短信”、“通知短信”、“营销短信”，可参考[关于腾讯云短信模板类型优化公告](https://cloud.tencent.com/document/product/382/106171)。新开通短信服务的客户需严格参考新的短信类型申请短信模板。 */ SmsType: number; /** * 是否国际/港澳台短信： 0：表示国内短信。 1：表示国际/港澳台短信。 注：需要和待修改模板 International 值保持一致，该参数不能直接修改国内模板到国际模板。 */ International: number; /** * 模板备注，例如申请原因，使用场景等。 */ Remark: string; } /** * 短信回复状态 */ export interface PullSmsReplyStatus { /** * 短信码号扩展号，默认未开通，如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。 */ ExtendCode?: string; /** * 国家（或地区）码。 */ CountryCode?: string; /** * 手机号码，E.164标准，+[国家或地区码][手机号] ，示例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 */ PhoneNumber?: string; /** * 短信签名名称。 */ SignName?: string; /** * 用户回复的内容。 */ ReplyContent?: string; /** * 回复时间，UNIX 时间戳（单位：秒）。 */ ReplyTime?: number; /** * 用户号码，普通格式，示例如：18501234444。 */ SubscriberNumber?: string; } /** * DescribeSendRecordList请求参数结构体 */ export interface DescribeSendRecordListRequest { /** *下发的手机号码，依据 E.164 标准为：+[国家（或地区）码][手机号] ，示例如：+8613601238015， 其中前面有一个+号 ，86为国家码，13601238015为手机号。
*/ PhoneNumber: string; /** *短信 SdkAppId 在 短信控制台 添加应用后生成的实际 SdkAppId。
*/ SmsSdkAppId: string; /** *查询起始时间，以短信发送时间为准，UNIX 时间戳（单位：秒）。注：最早可查询当前时间前 72 小时的数据。
单位：秒
*/ BeginTime: number; /** *查询截止时间，以短信发送时间为准，UNIX 时间戳（时间：秒）。注：不可以超过当前时间。
单位：秒
默认值：腾讯云服务当前时间
*/ EndTime?: number; /** *单次查询最大条数。
取值范围：[1, 50]
默认值：20
*/ Limit?: number; /** *偏移量。
取值范围：[0, 1000]
默认值：0
注：查询范围内超过 1000 条记录将被截断，最大查询 1000 条，查询记录按发送时间降序。
*/ Offset?: number; } /** * CallbackStatusStatistics返回参数结构体 */ export interface CallbackStatusStatisticsResponse { /** * 回执数据统计响应包体。 */ CallbackStatusStatistics?: CallbackStatusStatistics; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * PullSmsSendStatus请求参数结构体 */ export interface PullSmsSendStatusRequest { /** * 拉取最大条数，最多100条。 */ Limit: number; /** * 短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，例如1400006666。 */ SmsSdkAppId: string; } /** * 套餐包信息统计响应包体 */ export interface SmsPackagesStatistics { /** *套餐包创建时间，UNIX 时间戳。
单位：秒
*/ PackageCreateTime?: number; /** *套餐包生效时间，UNIX 时间戳。
单位：秒
*/ PackageEffectiveTime?: number; /** *套餐包过期时间，UNIX 时间戳。
单位：秒
*/ PackageExpiredTime?: number; /** *套餐包条数。
单位：条
*/ PackageAmount?: number; /** *套餐包类别。
枚举值：
套餐包 ID。
*/ PackageId?: number; /** *当前使用套餐包条数。
单位：条
*/ CurrentUsage?: number; } /** * PullSmsSendStatusByPhoneNumber返回参数结构体 */ export interface PullSmsSendStatusByPhoneNumberResponse { /** * 下发状态响应集合。 */ PullSmsSendStatusSet?: Array发送数据统计响应包体。
*/ SendStatusStatistics?: SendStatusStatistics; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SendSms请求参数结构体 */ export interface SendSmsRequest { /** * 下发手机号码，采用 E.164 标准，格式为+[国家或地区码][手机号]，单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。 例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。 */ PhoneNumberSet: Array是否国际/港澳台短信：
0：表示国内短信。
1：表示国际/港澳台短信。
签名 ID 数组。
注：默认数组最大长度100。
最大上限，最多100。注：默认为10，SignIdSet 为空时启用。
*/ Limit?: number; /** *偏移量。注：默认为0，SignIdSet 为空时启用。
*/ Offset?: number; } /** * DescribePhoneNumberInfo返回参数结构体 */ export interface DescribePhoneNumberInfoResponse { /** * 获取号码信息。 */ PhoneNumberInfoSet?: Array发送流水号。
*/ SerialNo?: string; /** *手机号码，E.164标准，+[国家或地区码][手机号] ，示例如：+60198890000， 其中前面有一个+号 ，60为国家码，198890000为手机号。
*/ PhoneNumber?: string; /** *计费条数，计费规则请查询 计费策略。
*/ Fee?: number; /** *用户 session 内容。
*/ SessionContext?: string; /** *短信请求错误码，具体含义请参考 错误码，发送成功返回 "Ok"。
*/ Code?: string; /** *短信请求错误码描述。
*/ Message?: string; /** *国家码或地区码，例如 US、MY 等，对于未识别出国家码或者地区码，默认返回 DEF，具体支持列表请参考 国际/港澳台短信价格总览。
*/ IsoCode?: string; } /** * AddSmsTemplate返回参数结构体 */ export interface AddSmsTemplateResponse { /** * 添加短信模板响应包体 */ AddTemplateStatus?: AddTemplateStatus; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 短信的下发状态详细信息 */ export interface PullSmsSendStatus { /** * 用户实际接收到短信的时间，UNIX 时间戳（单位：秒）。 */ UserReceiveTime?: number; /** * 国家（或地区）码。 */ CountryCode?: string; /** * 用户号码，普通格式，示例如：18501234444。 */ SubscriberNumber?: string; /** * 手机号码，E.164标准，+[国家或地区码][手机号] ，示例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 */ PhoneNumber?: string; /** * 本次发送标识 ID。 */ SerialNo?: string; /** * 实际是否收到的短信接收状态，SUCCESS（下发成功）、FAIL（下发失败）。 注：仅当运营商有返回短信接收状态时回包中才会有状态数据。 */ ReportStatus?: string; /** * 用户接收短信状态描述。 */ Description?: string; /** * 用户的 session 内容。与请求中的 SessionContext 一致，默认为空，如需开通请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 评估。 */ SessionContext?: string; } /** * DescribeSmsSignList返回参数结构体 */ export interface DescribeSmsSignListResponse { /** *获取签名信息响应
*/ DescribeSignListStatusSet?: Array短信批量发送状态。
*/ SendMultiStatusSet?: Array短信回执量统计。
单位：个
*/ CallbackCount?: number; /** *短信提交成功量统计。
单位：个
*/ RequestSuccessCount?: number; /** *短信回执失败量统计。
单位：个
*/ CallbackFailCount?: number; /** *短信回执成功量统计。
单位：个
*/ CallbackSuccessCount?: number; /** *运营商内部错误统计。
单位：个
*/ InternalErrorCount?: number; /** *号码无效或空号统计。
单位：个
*/ InvalidNumberCount?: number; /** *停机、关机等错误统计。
单位：个
*/ ShutdownErrorCount?: number; /** *号码拉入免打扰名单统计。
单位：个
*/ BlackListCount?: number; /** *运营商频率限制统计。
单位：个
*/ FrequencyLimitCount?: number; } /** * 号码信息。 */ export interface PhoneNumberInfo { /** * 号码信息查询错误码，查询成功返回 "Ok"。 */ Code?: string; /** * 号码信息查询错误码描述。 */ Message?: string; /** * 国家（或地区）码。 */ NationCode?: string; /** * 用户号码，去除国家或地区码前缀的普通格式，示例如：18501234444。 */ SubscriberNumber?: string; /** * 解析后的规范的 E.164 号码，与下发短信的号码解析结果一致。解析失败时会原样返回。 */ PhoneNumber?: string; /** * 国家码或地区码，例如 CN、US 等，对于未识别出国家码或者地区码，默认返回 DEF。 */ IsoCode?: string; /** * 国家码或地区名，例如 China，可参考 [国际/港澳台短信价格总览](https://cloud.tencent.com/document/product/382/18051) */ IsoName?: string; } /** * SendStatusStatistics请求参数结构体 */ export interface SendStatusStatisticsRequest { /** *起始时间，格式为yyyymmddhh，精确到小时，例如2024050113，表示2024年5月1号13时。注：统计范围包含当前小时。
参数格式：yyyymmddhh
*/ BeginTime: string; /** *结束时间，格式为yyyymmddhh，精确到小时，例如2024050118，表示2024年5月1号18时。注：EndTime 必须大于等于 BeginTime，统计范围包含当前小时。
参数格式：yyyymmddhh
*/ EndTime: string; /** *短信 SdkAppId 在 短信控制台 添加应用后生成的实际 SdkAppId，示例如1400006666。
*/ SmsSdkAppId: string; /** *最大上限。
注：目前固定设置为0。
偏移量。
注：目前固定设置为0。
下发手机号码，采用 E.164 标准，格式为+[国家或地区码][手机号]，单次请求最多支持200个手机号且要求全为国际/港澳台手机号。 例如：+60198890000， 其中前面有一个+号 ，60为国家码，198890000为手机号。
*/ PhoneNumber: string; /** *模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 国际/港澳台短信 的正文模板管理查看，仅支持使用国际/港澳台短信模板。
*/ TemplateId: string; /** *模板参数，若无模板参数，则设置为空。
*/ TemplateParamSet?: Array注意模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。
国际/港澳台短信 Sender ID。可参考 Sender ID 说明。注：国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。
*/ SenderId?: string; /** *用户的 session 内容，可以携带用户侧 ID 等上下文信息，server 会原样返回。注意长度需小于512字节。
*/ SessionContext?: string; } /** * DeleteSmsSign返回参数结构体 */ export interface DeleteSmsSignResponse { /** * 删除签名响应 */ DeleteSignStatus?: DeleteSignStatus; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddSmsSign返回参数结构体 */ export interface AddSmsSignResponse { /** *添加签名响应
*/ AddSignStatus?: AddSignStatus; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSmsSign请求参数结构体 */ export interface DeleteSmsSignRequest { /** * 待删除的签名 ID。 */ SignId: number; } /** * SendMultiGlobalSms请求参数结构体 */ export interface SendMultiGlobalSmsRequest { /** *短信 SdkAppId，在 短信控制台 添加应用后生成的实际 SdkAppId。
*/ SmsSdkAppId: string; /** *批量发送信息列表，单次请求最多支持200个号码且要求全为国际/港澳台号码。每个元素包含一个手机号码及其对应的模板、模板参数等信息。
*/ MultiSmsInfoSet: Array修改签名响应
*/ ModifySignStatus?: ModifySignStatus; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReportConversion请求参数结构体 */ export interface ReportConversionRequest { /** * 短信应用ID。在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。 */ SmsSdkAppId: string; /** * 发送短信返回的流水号。对应SendSms接口返回的SendStatusSet参数中的SerialNo字段。 */ SerialNo: string; /** * 用户回填时间，UNIX 时间戳（单位：秒）。 */ ConversionTime?: number; } /** * 添加签名响应 */ export interface AddSignStatus { /** * 签名ID。 */ SignId: number; } /** * 修改模板参数响应 */ export interface ModifyTemplateStatus { /** * 模板ID。 */ TemplateId: number; } /** * 短信发送记录信息 */ export interface SendRecord { /** *下发的手机号码，依据 E.164 标准为：+[国家（或地区）码][手机号] ，示例如：+8613601238015， 其中前面有一个+号 ，86为国家码，13601238015为手机号。
*/ PhoneNumber?: string; /** *发送流水号，与短信发送接口返回的发送流水号一致。
*/ SerialNo?: string; /** *发送状态。
枚举值：
请求状态码，可参考 短信 API 3.0 发送错误码。
*/ RequestCode?: string; /** *回执状态码，仅发送状态为 2（提交成功，送达成功）和 4（提交成功，送达失败）时有值，其余状态为空字符串，可参考 回执状态错误码。
*/ StatusCode?: string; /** *国家码或地区码，例如 CN、US 等，对于未识别出国家码或者地区码，默认返回 DEF，具体支持列表请参考 国际/港澳台短信价格总览。
*/ IsoCode?: string; /** *短信下发内容，为保证信息安全，短信中的部分入参信息会脱敏存储，对应发送记录查询结果中包含的打码内容，用户实际接收到的短信内容为正常完整内容。有疑问可咨询 腾讯云小助手 。
*/ Content?: string; /** *发送时间，UNIX 时间戳（秒）。
单位：秒
*/ SendTime?: number; /** *用户实际收到短信的时间，UNIX 时间戳（秒），仅发送状态为2（提交成功，送达成功）时有值 ，其余状态默认为 0 。
单位：秒
*/ UserReceiveTime?: number; } /** * PullSmsSendStatus返回参数结构体 */ export interface PullSmsSendStatusResponse { /** * 下发状态响应集合。 */ PullSmsSendStatusSet?: Array删除状态信息。
*/ DeleteStatus: string; /** *删除时间，UNIX 时间戳（单位：秒）。
*/ DeleteTime: number; } /** * PullSmsReplyStatus返回参数结构体 */ export interface PullSmsReplyStatusResponse { /** * 回复状态响应集合。 */ PullSmsReplyStatusSet?: Array