tencent cloud

文档反馈

最后更新时间:2024-06-27 15:48:01
    SDK 3.0是云 API 3.0平台的配套工具,您可以通过 SDK 使用所有 短信 API。新版 SDK 实现了统一化,具有各个语言版本的 SDK 使用方法相同,接口调用方式相同,错误码相同以及返回包格式相同等优点。
    注意:
    接入国际站要求的接口版本。
    接入国际站需要使用短信 API 2021-01-11 版本,可参考示例代码。
    发送短信相关接口。
    一次群发请求最多支持200个号码。
    签名、正文模板相关接口。
    个人认证用户不支持使用签名、正文模板相关接口,只能通过短信控制台 管理短信签名管理短信正文模板。如需使用该类接口,请将 “个人认证” 变更为 “企业认证”。

    前提条件

    了解 地域 概念,选择需求的地域接入。
    已开通短信服务,具体操作请参见 国际/港澳台短信快速入门
    已在访问管理控制台 > API 密钥管理 页面获取 SecretID 和 SecretKey。
    SecretID 用于标识 API 调用者的身份。
    SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥,SecretKey 需妥善保管,避免泄露
    短信的调用地址为sms.tencentcloudapi.com

    相关资料

    各个接口及其参数的详细介绍请参见 API 文档
    下载 SDK 源码请访问 Github 仓库 或者 Gitee 仓库

    安装 SDK

    通过 Composer 安装

    Github 仓库参见:通过 Composer 安装
    Gitee 仓库参见:通过 Composer 安装

    示例代码

    说明:
    所有示例代码仅作参考,无法直接编译和运行,需根据实际情况进行修改,您也可以根据实际需求使用 API 3.0 Explorer 自动化生成 Demo 代码。
    每个接口都有一个对应的 Request 结构和一个 Response 结构。本文仅列举几个常用功能的示例代码,如下所示。

    发送短信

    <?php
    require_once '/path/to/vendor/autoload.php';
    // 导入对应产品模块的client
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // 导入要请求接口对应的Request类
    use TencentCloud\\Sms\\V20210111\\Models\\SendSmsRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // 导入可选配置类
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    
    try {
    // 实例化一个证书对象,入参需要传入腾讯云账户 SecretId,SecretKey
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // $cred = new Credential("SecretId", "SecretKey");
    $cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"),
    getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个http选项,可选的,没有特殊需求可以跳过
    $httpProfile = new HttpProfile();
    // 配置代理
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // get请求(默认为post请求)
    $httpProfile->setReqTimeout(10); // 请求超时时间,单位为秒(默认60秒)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // 指定接入地域域名(默认就近接入)
    
    // 实例化一个client选项,可选的,没有特殊需求可以跳过
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // 指定签名算法
    $clientProfile->setHttpProfile($httpProfile);
    
    // 实例化要请求产品(以sms为例)的client对象,clientProfile是可选的
    // 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // 实例化一个 sms 发送短信请求对象,每个接口都会对应一个request对象。
    $req = new SendSmsRequest();
    
    /* 填充请求参数,这里request对象的成员变量即对应接口的入参
    * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    $req->SmsSdkAppId = "2400006666";
    /* 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台] 查看 */
    $req->SignName = "xxx";
    /* 短信码号扩展号: 默认未开通,如需开通请联系 [sms helper] */
    $req->ExtendCode = "";
    /* 下发手机号码,采用 E.164 标准,+[国家或地区码][手机号]
    * 示例如:+60198890000, 其中前面有一个+号 ,60为国家码,198890000为手机号,最多不要超过200个手机号*/
    $req->PhoneNumberSet = array("+60198890000");
    /* 国际/港澳台短信 SenderId: 中国大陆地区短信填空,默认未开通,如需开通请联系 [sms helper] */
    $req->SenderId = "";
    /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
    $req->SessionContext = "xxx";
    /* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
    $req->TemplateId = "449739";
    /* 模板参数: 若无模板参数,则设置为空*/
    $req->TemplateParamSet = array("0");
    
    
    // 通过client对象调用SendSms方法发起请求。注意请求方法名与请求对象是对应的
    // 返回的resp是一个SendSmsResponse类的实例,与请求对象对应
    $resp = $client->SendSms($req);
    
    // 输出json格式的字符串回包
    print_r($resp->toJsonString());
    
    // 也可以取出单个值。
    // 您可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    拉取回执状态

    <?php
    require_once '/path/to/vendor/autoload.php';
    // 导入对应产品模块的client
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // 导入要请求接口对应的Request类
    use TencentCloud\\Sms\\V20210111\\Models\\PullSmsSendStatusRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // 导入可选配置类
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    
    try {
    // 实例化一个证书对象,入参需要传入腾讯云账户 SecretId,SecretKey
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // $cred = new Credential("SecretId", "SecretKey");
    $cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"),
    getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个http选项,可选的,没有特殊需求可以跳过
    $httpProfile = new HttpProfile();
    // 配置代理
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // get请求(默认为post请求)
    $httpProfile->setReqTimeout(30); // 请求超时时间,单位为秒(默认60秒)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // 指定接入地域域名(默认就近接入)
    
    // 实例化一个client选项,可选的,没有特殊需求可以跳过
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // 指定签名算法
    $clientProfile->setHttpProfile($httpProfile);
    
    // 实例化要请求产品(以sms为例)的client对象,clientProfile是可选的
    // 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // 实例化一个 sms 发送短信请求对象,每个接口都会对应一个request对象。
    $req = new PullSmsSendStatusRequest();
    
    /* 填充请求参数,这里request对象的成员变量即对应接口的入参
    * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    $req->SmsSdkAppId = "2400006666";
    /* 拉取最大条数,最多100条 */
    $req->Limit = 10;
    
    
    // 通过client对象调用PullSmsSendStatus方法发起请求。注意请求方法名与请求对象是对应的
    // 返回的resp是一个PullSmsSendStatusResponse类的实例,与请求对象对应
    $resp = $client->PullSmsSendStatus($req);
    
    // 输出json格式的字符串回包
    print_r($resp->toJsonString());
    
    // 也可以取出单个值。
    // 你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    统计短信发送数据

    <?php
    require_once '/path/to/vendor/autoload.php';
    // 导入对应产品模块的client
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // 导入要请求接口对应的Request类
    use TencentCloud\\Sms\\V20210111\\Models\\SendStatusStatisticsRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // 导入可选配置类
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    
    try {
    // 实例化一个证书对象,入参需要传入腾讯云账户 SecretId,SecretKey
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // $cred = new Credential("SecretId", "SecretKey");
    $cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"),
    getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个http选项,可选的,没有特殊需求可以跳过
    $httpProfile = new HttpProfile();
    // 配置代理
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // get请求(默认为post请求)
    $httpProfile->setReqTimeout(30); // 请求超时时间,单位为秒(默认60秒)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // 指定接入地域域名(默认就近接入)
    
    // 实例化一个client选项,可选的,没有特殊需求可以跳过
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // 指定签名算法
    $clientProfile->setHttpProfile($httpProfile);
    
    // 实例化要请求产品(以sms为例)的client对象,clientProfile是可选的
    // 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // 实例化一个 sms 发送短信请求对象,每个接口都会对应一个request对象。
    $req = new SendStatusStatisticsRequest();
    
    /* 填充请求参数,这里request对象的成员变量即对应接口的入参
    * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    $req->SmsSdkAppId = "2400006666";
    /* 拉取最大条数,最多100条 */
    $req->Limit = 10;
    /* 偏移量 注:目前固定设置为0 */
    $req->Offset = 0;
    /* 开始时间,yyyymmddhh 需要拉取的起始时间,精确到小时 */
    $req->BeginTime = "2019122500";
    /* 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时
    * 注:EndTime 必须大于 BeginTime */
    $req->EndTime = "2019122523";
    
    // 通过client对象调用SendStatusStatistics方法发起请求。注意请求方法名与请求对象是对应的
    // 返回的resp是一个SendStatusStatisticsResponse类的实例,与请求对象对应
    $resp = $client->SendStatusStatistics($req);
    
    // 输出json格式的字符串回包
    print_r($resp->toJsonString());
    
    // 也可以取出单个值。
    // 你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    申请短信模板

    <?php
    require_once '/path/to/vendor/autoload.php';
    // 导入 SMS 模块的 client
    use TencentCloud\\Sms\\V20210111\\SmsClient;
    // 导入要请求接口对应的 Request 类
    use TencentCloud\\Sms\\V20210111\\Models\\AddSmsTemplateRequest;
    use TencentCloud\\Common\\Exception\\TencentCloudSDKException;
    use TencentCloud\\Common\\Credential;
    // 导入可选配置类
    use TencentCloud\\Common\\Profile\\ClientProfile;
    use TencentCloud\\Common\\Profile\\HttpProfile;
    try {
    // 实例化一个证书对象,入参需要传入腾讯云账户 SecretId,SecretKey
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // $cred = new Credential("SecretId", "SecretKey");
    $cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"),
    getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个 http 选项,可选,无特殊需求时可以跳过
    $httpProfile = new HttpProfile();
    // 配置代理
    // $httpProfile->setProxy("https://ip:port");
    $httpProfile->setReqMethod("GET"); // get请求(默认为 POST 请求)
    $httpProfile->setReqTimeout(30); // 请求超时时间,单位为秒(默认60秒)
    $httpProfile->setEndpoint("sms.tencentcloudapi.com"); // 指定接入地域域名(默认就近接入)
    
    // 实例化一个 client 选项,可选,无特殊需求时可以跳过
    $clientProfile = new ClientProfile();
    $clientProfile->setSignMethod("TC3-HMAC-SHA256"); // 指定签名算法
    $clientProfile->setHttpProfile($httpProfile);
    
    // 实例化 SMS 的 client 对象,clientProfile 是可选的
    // 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list
    $client = new SmsClient($cred, "ap-singapore", $clientProfile);
    
    // 实例化一个 AddSmsTemplateRequest 请求对象,每个接口都会对应一个 request 对象。
    $req = new AddSmsTemplateRequest();
    
    /* 填充请求参数,这里 request 对象的成员变量即对应接口的入参
    * 您可以通过官网接口文档或跳转到 request 对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台:https://console.tencentcloud.com/smsv2
    * sms helper:https://www.tencentcloud.com/document/product/382/3773
    */
    
    /* 模板名称 */
    $req->TemplateName = "腾讯云";
    /* 模板内容 */
    $req->TemplateContent = "{1}为您的登录验证码,请于{2}分钟内填写,如非本人操作,请忽略本短信。";
    /* 短信类型,1表示营销短信,2表示通知短信,3表示验证码短信 */
    $req->SmsType = 3;
    /* 是否国际/港澳台短信:
    0表示中国大陆地区短信
    1表示国际/港澳台短信 */
    $req->International = 0;
    /* 模板备注:例如申请原因,使用场景等 */
    $req->Remark = "xxx";
    // 通过 client 对象调用 AddSmsTemplate 方法发起请求。注意请求方法名与请求对象是对应的
    $resp = $client->AddSmsTemplate($req);
    // 输出 JSON 格式的字符串回包
    print_r($resp->toJsonString());
    
    // 可以取出单个值,您可以通过官网接口文档或跳转到 response 对象的定义处查看返回字段的定义
    print_r($resp->TotalCount);
    }
    catch(TencentCloudSDKException $e) {
    echo $e;
    }

    常见问题

    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持