{
  "name": "sms",
  "display_name": "短信",
  "description": "介绍如何使用 API 对短信进行操作，包括发送短信、短信签名、短信模板、短信统计等。",
  "domain": "other",
  "api_version": "2021-01-11",
  "endpoint": "sms.tencentcloudapi.com",
  "actions": [
    {
      "name": "AddSmsSign",
      "description": "本接口 (AddSmsSign) 用于添加短信签名。 说明：添加短信签名前，请先认真参阅 腾讯云短信签名审核标准。个人认证用户不支持使用 API 申请短信签名，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 申请短信签名。",
      "status": "online",
      "parameters": [
        {
          "name": "SignName",
          "type": "string",
          "required": true,
          "description": "签名名称。 注：不能重复申请已通过或待审核的签名。",
          "example": "腾讯云"
        },
        {
          "name": "SignType",
          "type": "integer",
          "required": true,
          "description": "签名类型。其中每种类型后面标注了其可选的 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（小程序）已不再支持\ufffd...",
          "example": "0"
        },
        {
          "name": "DocumentType",
          "type": "integer",
          "required": true,
          "description": "证明类型： 0：三证合一。 1：企业营业执照。 2：组织机构代码证书。 3：社会信用代码证书。 4：应用后台管理截图（个人开发APP）。 7：商标注册书。 注：证明类型5（网站备案后台截图）、6（小程序设置页面截图）、8（公众号设置页面截图）已不再支持，具体可参考 [关于腾讯云短信签名申请规则更新的公告](https://cloud.tencent.com/document/product/382/116397)。",
          "example": "1"
        },
        {
          "name": "International",
          "type": "integer",
          "required": true,
          "description": "是否国际/港澳台短信： 0：表示国内短信。 1：表示国际/港澳台短信。",
          "example": "0"
        },
        {
          "name": "SignPurpose",
          "type": "integer",
          "required": true,
          "description": "签名用途： 0：自用。 1：他用。",
          "example": "0"
        },
        {
          "name": "ProofImage",
          "type": "string",
          "required": true,
          "description": "签名对应的资质证明图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。",
          "example": "base64"
        },
        {
          "name": "CommissionImage",
          "type": "string",
          "required": false,
          "description": "委托授权证明。选择 SignPurpose 为他用之后需要提交委托的授权证明。 图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。 注：只有 SignPurpose 在选择为 1（他用）时，这个字段才会生效。",
          "example": "base64"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "签名的申请备注。",
          "example": "业务自用申请"
        },
        {
          "name": "QualificationId",
          "type": "integer",
          "required": false,
          "description": "已审核通过的国内短信的资质 ID。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。国内短信需填写资质ID，国际短信无需填写。",
          "example": "1000001"
        }
      ],
      "required": [
        "SignName",
        "SignType",
        "DocumentType",
        "International",
        "SignPurpose",
        "ProofImage"
      ]
    },
    {
      "name": "AddSmsTemplate",
      "description": "本接口 (AddSmsTemplate) 用于创建短信模板。 说明：申请短信模板前，请先认真参阅 腾讯云短信正文模板审核标准。个人认证用户不支持使用 API 申请短信正文模板，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 申请短信正文模板。",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateName",
          "type": "string",
          "required": true,
          "description": "模板名称。",
          "example": "验证码"
        },
        {
          "name": "TemplateContent",
          "type": "string",
          "required": true,
          "description": "模板内容。",
          "example": "您的验证码是{1}"
        },
        {
          "name": "SmsType",
          "type": "integer",
          "required": true,
          "description": "短信类型，1表示营销短信，2表示通知短信，3表示验证码短信。 注：为进一步提升短信发送质量、提高短信模板审核通过率，从2024年5月16日起，腾讯云短信模板类型优化为“验证码短信”、“通知短信”、“营销短信”，可参考[关于腾讯云短信模板类型优化公告](https://cloud.tencent.com/document/product/382/106171)。新开通短信服务的客户需严格参考新的短信类型申请短信模板。",
          "example": "3"
        },
        {
          "name": "International",
          "type": "integer",
          "required": true,
          "description": "是否国际/港澳台短信： 0：表示国内短信。 1：表示国际/港澳台短信。",
          "example": "0"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": true,
          "description": "模板备注，例如申请原因，使用场景等。",
          "example": "业务验证码"
        }
      ],
      "required": [
        "TemplateName",
        "TemplateContent",
        "SmsType",
        "International",
        "Remark"
      ]
    },
    {
      "name": "CallbackStatusStatistics",
      "description": "本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。",
      "status": "online",
      "parameters": [
        {
          "name": "BeginTime",
          "type": "string",
          "required": true,
          "description": "起始时间，格式为yyyymmddhh，精确到小时，例如2024050113，表示2024年5月1号13时。",
          "example": "2024090800"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "结束时间，格式为yyyymmddhh，精确到小时，例如2024050118，表示2024年5月1号18时。 注：EndTime 必须大于等于 BeginTime，且相差不超过32天。",
          "example": "2024090823"
        },
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "最大上限。 注：目前固定设置为0。",
          "example": "0"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。 注：目前固定设置为0。",
          "example": "0"
        }
      ],
      "required": [
        "BeginTime",
        "EndTime",
        "SmsSdkAppId",
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DeleteSmsSign",
      "description": "本接口 (DeleteSmsSign) 用于删除短信签名。 说明：个人认证用户不支持使用 API 删除短信签名，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 删除短信签名。",
      "status": "online",
      "parameters": [
        {
          "name": "SignId",
          "type": "integer",
          "required": true,
          "description": "待删除的签名 ID。",
          "example": "1110"
        }
      ],
      "required": [
        "SignId"
      ]
    },
    {
      "name": "DeleteSmsTemplate",
      "description": "本接口 (DeleteSmsTemplate) 用于删除短信模板。 说明：个人认证用户不支持使用 API 删除短信正文模板，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 删除短信正文模板。",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateId",
          "type": "integer",
          "required": true,
          "description": "待删除的模板 ID。",
          "example": "1110"
        }
      ],
      "required": [
        "TemplateId"
      ]
    },
    {
      "name": "DescribePhoneNumberInfo",
      "description": "本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。 - 例如：查询号码 +86018501234444，可以得到国家码 86、规范的 E.164 号码 +8618501234444 等信息。",
      "status": "online",
      "parameters": [
        {
          "name": "PhoneNumberSet",
          "type": "array",
          "required": true,
          "description": "查询手机号码，采用 E.164 标准，格式为+[国家或地区码][手机号]，单次请求最多支持200个手机号。 例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。",
          "example": "[\"+8618501234444\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "PhoneNumberSet"
      ]
    },
    {
      "name": "DescribeSmsSignList",
      "description": "本接口 (DescribeSmsSignList) 用于查询短信签名状态。 说明：个人认证用户不支持使用 API 查询短信签名，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 查询短信签名。",
      "status": "online",
      "parameters": [
        {
          "name": "SignIdSet",
          "type": "array",
          "required": true,
          "description": "签名 ID 数组。 注：默认数组最大长度100。",
          "example": "[1110]",
          "item_type": "integer"
        },
        {
          "name": "International",
          "type": "integer",
          "required": true,
          "description": "是否国际/港澳台短信： 0：表示国内短信。 1：表示国际/港澳台短信。",
          "example": "0"
        }
      ],
      "required": [
        "SignIdSet",
        "International"
      ]
    },
    {
      "name": "DescribeSmsTemplateList",
      "description": "本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。 说明：个人认证用户不支持使用 API 查询短信正文模板，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 查询短信正文模板。",
      "status": "online",
      "parameters": [
        {
          "name": "International",
          "type": "integer",
          "required": true,
          "description": "是否国际/港澳台短信： 0：表示国内短信。 1：表示国际/港澳台短信。",
          "example": "0"
        },
        {
          "name": "TemplateIdSet",
          "type": "array",
          "required": false,
          "description": "模板 ID 数组。数组为空时默认查询模板列表信息，请使用 Limit 和 Offset 字段设置查询范围。 默认数组长度最大100",
          "example": "[1110]",
          "item_type": "integer"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "最大上限，最多100。 注：默认为0，TemplateIdSet 为空时启用。",
          "example": "0"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量。 注：默认为0，TemplateIdSet 为空时启用。",
          "example": "0"
        }
      ],
      "required": [
        "International"
      ]
    },
    {
      "name": "ModifySmsSign",
      "description": "本接口 (ModifySmsSign) 用于修改短信签名。 说明：修改短信签名前，请先认真参阅 腾讯云短信签名审核标准。个人认证用户不支持使用 API 修改短信签名，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 修改短信签名。修改短信签名，仅当签名为待审核或已拒绝状态时，才能进行修改，已审核通过的签名不支持修改。",
      "status": "online",
      "parameters": [
        {
          "name": "SignId",
          "type": "integer",
          "required": true,
          "description": "待修改的签名 ID。",
          "example": "1110"
        },
        {
          "name": "SignName",
          "type": "string",
          "required": true,
          "description": "签名名称。",
          "example": "腾讯云"
        },
        {
          "name": "SignType",
          "type": "integer",
          "required": true,
          "description": "签名类型。其中每种类型后面标注了其可选的 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（小程序）已不再支持\ufffd...",
          "example": "0"
        },
        {
          "name": "DocumentType",
          "type": "integer",
          "required": true,
          "description": "证明类型： 0：三证合一。 1：企业营业执照。 2：组织机构代码证书。 3：社会信用代码证书。 4：应用后台管理截图（个人开发APP）。 7：商标注册书。 注：证明类型5（网站备案后台截图）、6（小程序设置页面截图）、8（公众号设置页面截图）已不再支持，具体可参考 [关于腾讯云短信签名申请规则更新的公告](https://cloud.tencent.com/document/product/382/116397)。",
          "example": "1"
        },
        {
          "name": "International",
          "type": "integer",
          "required": true,
          "description": "是否国际/港澳台短信： 0：表示国内短信。 1：表示国际/港澳台短信。 注：需要和待修改签名International值保持一致，该参数不能直接修改国内签名到国际签名。",
          "example": "0"
        },
        {
          "name": "SignPurpose",
          "type": "integer",
          "required": true,
          "description": "签名用途： 0：自用。 1：他用。",
          "example": "0"
        },
        {
          "name": "ProofImage",
          "type": "string",
          "required": true,
          "description": "签名对应的资质证明图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。",
          "example": "base64"
        },
        {
          "name": "CommissionImage",
          "type": "string",
          "required": false,
          "description": "委托授权证明。选择 SignPurpose 为他用之后需要提交委托的授权证明。 图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。 注：只有 SignPurpose 在选择为 1（他用）时，这个字段才会生效。",
          "example": "base64"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "签名的申请备注。",
          "example": "自用业务申请"
        },
        {
          "name": "QualificationId",
          "type": "integer",
          "required": false,
          "description": "已审核通过的国内短信的资质 ID。资质 ID 信息可前往国内短信的 [实名资质管理](https://console.cloud.tencent.com/smsv2/enterprise) 页查看。国内短信需填写资质ID，国际短信无需填写。",
          "example": "1000001"
        }
      ],
      "required": [
        "SignId",
        "SignName",
        "SignType",
        "DocumentType",
        "International",
        "SignPurpose",
        "ProofImage"
      ]
    },
    {
      "name": "ModifySmsTemplate",
      "description": "本接口 (ModifySmsTemplate) 用于修改短信模板。 说明：修改短信正文模板前，请先认真参阅 腾讯云短信正文模板审核标准。个人认证用户不支持使用 API 修改短信正文模板，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 修改短信正文模板。修改短信模板，仅当正文模板为待审核或已拒绝状态时，才能进行修改，已审核通过的正文模板不支持修改。",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateId",
          "type": "integer",
          "required": true,
          "description": "待修改模板的ID。",
          "example": "1110"
        },
        {
          "name": "TemplateName",
          "type": "string",
          "required": true,
          "description": "新的模板名称。",
          "example": "腾讯云"
        },
        {
          "name": "TemplateContent",
          "type": "string",
          "required": true,
          "description": "新的模板内容。",
          "example": "您的验证码是{1}"
        },
        {
          "name": "SmsType",
          "type": "integer",
          "required": true,
          "description": "短信类型，1表示营销短信，2表示通知短信，3表示验证码短信。 注：为进一步提升短信发送质量、提高短信模板审核通过率，从2024年5月16日起，腾讯云短信模板类型优化为“验证码短信”、“通知短信”、“营销短信”，可参考[关于腾讯云短信模板类型优化公告](https://cloud.tencent.com/document/product/382/106171)。新开通短信服务的客户需严格参考新的短信类型申请短信模板。",
          "example": "3"
        },
        {
          "name": "International",
          "type": "integer",
          "required": true,
          "description": "是否国际/港澳台短信： 0：表示国内短信。 1：表示国际/港澳台短信。 注：需要和待修改模板 International 值保持一致，该参数不能直接修改国内模板到国际模板。",
          "example": "0"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": true,
          "description": "模板备注，例如申请原因，使用场景等。",
          "example": "业务验证码"
        }
      ],
      "required": [
        "TemplateId",
        "TemplateName",
        "TemplateContent",
        "SmsType",
        "International",
        "Remark"
      ]
    },
    {
      "name": "PullSmsReplyStatus",
      "description": "本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。 说明：此接口需要联系 腾讯云短信小助手 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。上行回复也支持 配置回复回调 的方式获取。",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "拉取最大条数，最多100条。",
          "example": "100"
        },
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，例如1400006666。",
          "example": "1400006666"
        }
      ],
      "required": [
        "Limit",
        "SmsSdkAppId"
      ]
    },
    {
      "name": "PullSmsReplyStatusByPhoneNumber",
      "description": "本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。 说明：上行回复也支持 配置回复回调 的方式获取。",
      "status": "online",
      "parameters": [
        {
          "name": "BeginTime",
          "type": "integer",
          "required": true,
          "description": "拉取起始时间，UNIX 时间戳（时间：秒）。 注：最大可拉取当前时期前7天的数据。",
          "example": "1464624000"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。 注：目前固定设置为0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "拉取最大条数，最多 100。",
          "example": "2"
        },
        {
          "name": "PhoneNumber",
          "type": "string",
          "required": true,
          "description": "下发目的手机号码，依据 E.164 标准为：+[国家（或地区）码][手机号] ，示例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。",
          "example": "+8618501234444"
        },
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": false,
          "description": "拉取截止时间，UNIX 时间戳（时间：秒）。",
          "example": "1464624123"
        }
      ],
      "required": [
        "BeginTime",
        "Offset",
        "Limit",
        "PhoneNumber",
        "SmsSdkAppId"
      ]
    },
    {
      "name": "PullSmsSendStatus",
      "description": "本接口 (PullSmsSendStatus) 用于拉取短信下发状态。 说明：此接口需要联系 腾讯云短信小助手 开通。接口拉取的状态数据为队列模式，同一号码一次下发的状态数据仅能拉取一次。下发状态也支持 配置回调 的方式获取。",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "拉取最大条数，最多100条。",
          "example": "100"
        },
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，例如1400006666。",
          "example": "1400006666"
        }
      ],
      "required": [
        "Limit",
        "SmsSdkAppId"
      ]
    },
    {
      "name": "PullSmsSendStatusByPhoneNumber",
      "description": "本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。 说明：下发状态也支持 配置回调 的方式获取。",
      "status": "online",
      "parameters": [
        {
          "name": "BeginTime",
          "type": "integer",
          "required": true,
          "description": "拉取起始时间，UNIX 时间戳（时间：秒）。 注：最大可拉取当前时期前7天的数据。",
          "example": "1464624000"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。 注：目前固定设置为0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "拉取最大条数，最多 100。",
          "example": "2"
        },
        {
          "name": "PhoneNumber",
          "type": "string",
          "required": true,
          "description": "下发目的手机号码，依据 E.164 标准为：+[国家（或地区）码][手机号] ，示例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。",
          "example": "+8618501234444"
        },
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": false,
          "description": "拉取截止时间，UNIX 时间戳（时间：秒）。",
          "example": "1464624123"
        }
      ],
      "required": [
        "BeginTime",
        "Offset",
        "Limit",
        "PhoneNumber",
        "SmsSdkAppId"
      ]
    },
    {
      "name": "ReportConversion",
      "description": "本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。 说明：该接口当前以白名单方式对外开放，如有需要请联系 腾讯云短信小助手 开通。",
      "status": "online",
      "parameters": [
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信应用ID。在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。",
          "example": "1400000001"
        },
        {
          "name": "SerialNo",
          "type": "string",
          "required": true,
          "description": "发送短信返回的流水号。对应SendSms接口返回的SendStatusSet参数中的SerialNo字段。",
          "example": "a12gb4e2-sd11-5dx6-aav9-8f3d97xa2xu7"
        },
        {
          "name": "ConversionTime",
          "type": "integer",
          "required": false,
          "description": "用户回填时间，UNIX 时间戳（单位：秒）。",
          "example": "1658310430"
        }
      ],
      "required": [
        "SmsSdkAppId",
        "SerialNo"
      ]
    },
    {
      "name": "SendSms",
      "description": "本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。 - 当前接口属于 2021-01-11 版本，如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778)，建议您使用当前最新版本的接口，版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。",
      "status": "online",
      "parameters": [
        {
          "name": "PhoneNumberSet",
          "type": "array",
          "required": true,
          "description": "下发手机号码，采用 E.164 标准，格式为+[国家或地区码][手机号]，单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。 例如：+8618501234444， 其中前面有一个+号 ，86为国家码，18501234444为手机号。 注：发送国内短信格式还支持0086、86或无任何国家或地区码的11位手机号码，前缀默认为+86。",
          "example": "[\"+8618501234444\"]",
          "item_type": "string"
        },
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId，在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": true,
          "description": "模板 ID，必须填写已审核通过的模板 ID。模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看，若向境外手机号发送短信，仅支持使用国际/港澳台短信模板。",
          "example": "1110"
        },
        {
          "name": "SignName",
          "type": "string",
          "required": false,
          "description": "短信签名内容，使用 UTF-8 编码，必须填写已审核通过的签名，例如：腾讯云，签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看。 发送国内短信该参数必填，且需填写签名内容而非签名ID。 发送国际/港澳台短信该参数非必填。",
          "example": "腾讯云"
        },
        {
          "name": "TemplateParamSet",
          "type": "array",
          "required": false,
          "description": "模板参数，若无模板参数，则设置为空。 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致。",
          "example": "[\"4370\"]",
          "item_type": "string"
        },
        {
          "name": "ExtendCode",
          "type": "string",
          "required": false,
          "description": "短信码号扩展号，默认未开通，如需开通请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。",
          "example": "10"
        },
        {
          "name": "SessionContext",
          "type": "string",
          "required": false,
          "description": "用户的 session 内容，可以携带用户侧 ID 等上下文信息，server 会原样返回。注意长度需小于512字节。",
          "example": "outsid_1729495320_1011"
        },
        {
          "name": "SenderId",
          "type": "string",
          "required": false,
          "description": "国际/港澳台短信 Sender ID。可参考 [Sender ID 说明](https://cloud.tencent.com/document/product/382/102831)。 注：国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。",
          "example": "Qsms"
        }
      ],
      "required": [
        "PhoneNumberSet",
        "SmsSdkAppId",
        "TemplateId"
      ]
    },
    {
      "name": "SendStatusStatistics",
      "description": "本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。",
      "status": "online",
      "parameters": [
        {
          "name": "BeginTime",
          "type": "string",
          "required": true,
          "description": "起始时间，格式为yyyymmddhh，精确到小时，例如2024050113，表示2024年5月1号13时。",
          "example": "2024090800"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "结束时间，格式为yyyymmddhh，精确到小时，例如2024050118，表示2024年5月1号18时。 注：EndTime 必须大于等于 BeginTime。",
          "example": "2024090823"
        },
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "最大上限。 注：目前固定设置为0。",
          "example": "0"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。 注：目前固定设置为0。",
          "example": "0"
        }
      ],
      "required": [
        "BeginTime",
        "EndTime",
        "SmsSdkAppId",
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "SmsPackagesStatistics",
      "description": "本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。",
      "status": "online",
      "parameters": [
        {
          "name": "SmsSdkAppId",
          "type": "string",
          "required": true,
          "description": "短信 SdkAppId 在 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 添加应用后生成的实际 SdkAppId，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "最大上限(需要拉取的套餐包个数)。 注：Limit默认最大值为500，可结合Offset实现分页查询。",
          "example": "2"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。",
          "example": "0"
        },
        {
          "name": "BeginTime",
          "type": "string",
          "required": true,
          "description": "起始时间，格式为yyyymmddhh，精确到小时，例如2024050113，表示2024年5月1号13时。 注：接口会返回 BeginTime 到 EndTime 之间创建的套餐包的统计信息。",
          "example": "2024050113"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "结束时间，格式为yyyymmddhh，精确到小时，例如2024050118，表示2024年5月1号18时。 注：EndTime 必须大于 BeginTime 且小于当前时间。",
          "example": "2024050118"
        }
      ],
      "required": [
        "SmsSdkAppId",
        "Limit",
        "Offset",
        "BeginTime",
        "EndTime"
      ]
    }
  ]
}