PHP实现调用短信接口及其常见问题的解决方法
又是一年元旦,必须预祝自己和在座的所有人在新的一年里一定,财源滚滚,步步高升!头发越来越多,烦恼越来越少!
好了,步入正题!下面带大家一起实现PHP调用短信接口的功能,以及一些避坑,和解决问题的技巧:
在这里呢我推荐初学者们可以选择腾讯云的短信接口:国内短信地址:https://console.cloud.tencent.com/smsv2
不要问为什么,大厂出品多属精品,而且豪气!通常初学者注册账号并通过实名认证之后一般都可以免费领取到100到几百条不等的短信额度,对于初次上手的小伙伴来说非常友好。(当然其他企业的短信接口的调用方式和腾讯云大同小异,学会一种其他企业都可以简单的举一反三轻松上手,所以这里就以腾讯云为例:)
一:准备工作(老猿可以略过)
1:申请账号+实名认证
2:创建签名和模板 等待官方认证通过
3:已开通短信服务,具体操作请参见 国内短信快速入门。
4:如需发送国内短信,需要先 购买国内短信套餐包。
5::准备依赖环境:PHP 5.6.33 及以上版本。
6:在访问管理控制台 >API密钥管理页面获取 SecretID 和 SecretKey。
SecretID 用于标识 API 调用者的身份。
SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥,SecretKey 需妥善保管,避免泄露。
二:安装SDK
通过 Composer 获取安装是使用 PHP SDK 推荐方法,Composer 是 PHP 的依赖管理工具。关于 Composer 详细可参见 Composer 官网。(Composer 需要 PHP 5.3.2+ 以上版本,且需要开启 openssl。)
步骤1:安装 Composer
- Windows 环境请访问 Composer 官网下载安装包安装。
- Unix 环境在命令行中执行以下命令安装:
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer
步骤2:添加镜像源
中国大陆地区的用户可以使用腾讯云镜像源提高下载速度,在打开的命令窗口执行以下命令:
composer config -g repos.packagist composer https://mirrors.tencent.com/composer/
步骤3:添加依赖
在打开的命令窗口执行命令安装 SDK(安装到指定位置),例如安装到C:\Users\···>
目录下,则在指定的位置打开命令窗口,并执行以下命令:
composer require tencentcloud/tencentcloud-sdk-php
步骤4:添加引用
在代码中添加以下引用代码。注意:如下仅为示例,Composer 会在项目根目录下生成 vendor 目录,/path/to/ 为项目根目录的实际绝对路径(如果是在当前目录执行,可以省略绝对路径)。
require '/path/to/vendor/autoload.php';
三:使用SDK
- 推荐使用 API 3.0 Explorer,提供在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 3.0 和 SDK 的难度。
- 还可以参考 SDK 仓库中 examples 目录中的示例,展示了更多的用法。
步骤1:引入发送短信的类文件
// 导入对应产品模块的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;
步骤2:实例代码
public function sendSms(){
try {
/* 必要步骤:
* 实例化一个认证对象,入参需要传入腾讯云账户密钥对secretId,secretKey。
* 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。
* 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人,
* 以免泄露密钥对危及你的财产安全。
* CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/
/********************************************1.secretId,secretKey***********************************************/
$cred = new Credential("XXX", "YYY");
//$cred = new Credential(getenv("TENCENTCLOUD_SECRET_ID"), getenv("TENCENTCLOUD_SECRET_KEY"));
// 实例化一个http选项,可选的,没有特殊需求可以跳过
$httpProfile = new HttpProfile();
// 配置代理
// $httpProfile->setProxy("https://ip:port");
$httpProfile->setReqMethod("GET"); // post请求(默认为post请求)
$httpProfile->setReqTimeout(30); // 请求超时时间,单位为秒(默认60秒)
$httpProfile->setEndpoint("sms.tencentcloudapi.com"); // 指定接入地域域名(默认就近接入)
// 实例化一个client选项,可选的,没有特殊需求可以跳过
$clientProfile = new ClientProfile();
$clientProfile->setSignMethod("TC3-HMAC-SHA256"); // 指定签名算法(默认为HmacSHA256)
$clientProfile->setHttpProfile($httpProfile);
// 实例化要请求产品(以sms为例)的client对象,clientProfile是可选的
// 第二个参数是地域信息,可以直接填写字符串 ap-guangzhou,或者引用预设的常量
$client = new SmsClient($cred, "ap-guangzhou", $clientProfile);
// 实例化一个 sms 发送短信请求对象,每个接口都会对应一个request对象。
$req = new SendSmsRequest();
/* 填充请求参数,这里request对象的成员变量即对应接口的入参
* 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
* 基本类型的设置:
* 帮助链接:
* 短信控制台: https://console.cloud.tencent.com/smsv2
* sms helper: https://cloud.tencent.com/document/product/382/3773 */
/************************ 2.短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如1400006666 */
$req->SmsSdkAppId = "你的SdkAppId";
/**************************3.短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台] 查看 */
$req->SignName = "芒果鱼个人网";
/* 短信码号扩展号: 默认未开通,如需开通请联系 [sms helper] */
$req->ExtendCode = "";
/* 下发手机号码,采用 E.164 标准,+[国家或地区码][手机号]
* 示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号,最多不要超过200个手机号*/
/**************************4.手机号*****************************/
$req->PhoneNumberSet = array("+8615238831671");
/* 国际/港澳台短信 SenderId: 国内短信填空,默认未开通,如需开通请联系 [sms helper] */
$req->SenderId = "";
/* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
$req->SessionContext = "xxx";
/****************************5.模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
$req->TemplateId = "你的模板ID";
/****************************6.模板变量 模板参数: 若无模板参数,则设置为空*/
$code = mt_rand(1000,9999);
$req->TemplateParamSet = array($code);
// 通过client对象调用SendSms方法发起请求。注意请求方法名与请求对象是对应的
// 返回的resp是一个SendSmsResponse类的实例,与请求对象对应
$resp = $client->SendSms($req);
// 输出json格式的字符串回包
print_r($resp->toJsonString());
}
catch(TencentCloudSDKException $e) {
echo $e;
}
}
步骤3:检查发送成功后的响应
{"SendStatusSet":[{"SerialNo":"2997:184567926916409342794633167","PhoneNumber":"+8615238831671","Fee":1,"SessionContext":"xxx","Code":"Ok","Message":"send success","IsoCode":"CN"}],"RequestId":"0922c611-4392-48f2-8619-4cfa9657155c"}
四:避坑篇
当我们做完上述工作之后一般情况下都是可以实现调用腾讯云短信接口功能的,但是也不排除有些小伙伴会遇到一些常见的问题
1:安装包中缺少某些文件或者路径错误
解决方法:
方法一
步骤一:
下载SDK源码,下载地址如下:
https://tencent-1251123904.cos.ap-chengdu.myqcloud.com/tencentcloud-sdk-php.zip
步骤二:
将下载的源码放入解压后放入项目根目录,通过API Explorer获取识别API在SDK下的调用Demo,复制Demo为一个php可运行文件到项目中直接运行即可,相关路径需要您自己核实修改
API Explorer工具地址:https://console.cloud.tencent.com/api/explorer?Product=iai&Version=2018-03-01&Action=AnalyzeFace&SignVersion=
或者文字识别类的云API控制台https://console.cloud.tencent.com/api/explorer?Product=ocr&Version=2018-11-19&Action=IDCardOCR&SignVersion=
方法二
当确定是文件路径的读取错误导致的问题,比如。
使用composer安装好后,可把云API控制台提供的引用代码“require_once '../../../TCloudAutoLoader.php';
改成添加以下引用代码,引用方法可参考示例
require_once 'vendor/autoload.php'
就不会再报错了。
2:相关配置问题
1)代理问题
解决方法:如果是有代理的环境下,需要设置系统环境变量
https_proxy
否则可能无法正常调用,抛出连接超时的异常。
2)证书问题
如果你的 PHP 环境证书有问题,可能会遇到报错,类似于
cURL error 60: See http://curl.haxx.se/libcurl/c/libcurl-errors.html
解决方法:
步骤一:
到 https://curl.haxx.se/ca/cacert.pem 下载证书文件 cacert.pem
,将其保存到 PHP 安装路径下。
步骤二:
编辑 php.ini
文件,删除 curl.cainfo
配置项前的分号注释符(;),值设置为保存的证书文件 cacert.pem
的绝对路径。
步骤三:
重启依赖 PHP 的服务。