更新时间:2017-08-17 15:16:35 分享:
为了访问短信服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:
为了使用短信发送API-PHP SDK,您必须申请阿里云的访问密钥。
阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。
该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。
您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。
短信签名
根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明,个人用户需要上传证明个人身份的证明。
短信签名需要审核通过后才可以使用。
短信模板
短信模板,即具体发送的短信内容。
短信模板可以支持验证码、短信通知、推广短信三种模式。验证码和短信通知,通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。
短信模板需要审核通过后才可以使用。
为了成功发送一条短信通知,您至少需要完成以下步骤
一、在控制台完成短信全名与短信模板的申请,获得调用接口必备的参数
在“短信签名”页面完成签名的申请,获得短信签名的字符串 签名申请手册
在“短信模板”页面完成模板的申请,获得模板ID。模板申请手册
参数名称 | 参数类型 | 必填与否 | 样例取值 | 参数说明 |
---|---|---|---|---|
PhoneNumbers | String | 必须 | 15000000000 | 短信接收号码。支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式 |
SignName | String | 必须 | 云通信 | 短信签名 |
TemplateCode | String | 必须 | SMS_0000 | 短信模板ID |
TemplateParam | String | 可选 | {“code”:”1234”,”product”:”ytx”} | 短信模板变量替换JSON串,友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\r\n,否则会导致JSON在服务端解析失败 |
OutId | String | 可选 | abcdefgh | 外部流水扩展字段 |
出参名称 | 出参类型 | 样例取值 | 参数说明 |
---|---|---|---|
RequestId | String | 8906582E-6722 | 请求ID |
Code | String | OK | 状态码-返回OK代表请求成功,其他错误码详见错误码列表 |
Message | String | 请求成功 | 状态码的描述 |
BizId | String | 134523^4351232 | 发送回执ID,可根据该ID查询具体的发送状态 |
SDK工具包中一共包含了2个类库,一个aliyun-php-sdk-core包,另外一个是alicom-dysms-api包,将这两个包添加到工程类库中依赖。
SDK&DEMO[下载地址]
//此处需要替换成自己的AK信息
$accessKeyId = "yourAccessKeyId";//参考本文档步骤2
$accessKeySecret = "yourAccessKeySecret";//参考本文档步骤2
//短信API产品名(短信产品名固定,无需修改)
$product = "Dysmsapi";
//短信API产品域名(接口地址固定,无需修改)
$domain = "dysmsapi.aliyuncs.com";
//暂时不支持多Region(目前仅支持cn-hangzhou请勿修改)
$region = "cn-hangzhou";
//初始化访问的acsCleint
$profile = DefaultProfile::getProfile($region, $accessKeyId, $accessKeySecret);
DefaultProfile::addEndpoint("cn-hangzhou", "cn-hangzhou", $product, $domain);
$acsClient= new DefaultAcsClient($profile);
$request = new Dysmsapi\Request\V20170525\SendSmsRequest;
//必填-短信接收号码。支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
$request->setPhoneNumbers("15067126468");
//必填-短信签名
$request->setSignName("云通信");
//必填-短信模板Code
$request->setTemplateCode("SMS_0001");
//选填-假如模板中存在变量需要替换则为必填(JSON格式),友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
$request->setTemplateParam("{\"code\":\"12345\",\"product\":\"云通信服务\"}");
//选填-发送短信流水号
$request->setOutId("1234");
//发起访问请求
$acsResponse = $acsClient->getAcsResponse($request);
Code | 描述 |
---|---|
OK | 请求成功 |
isp.RAM_PERMISSION_DENY | RAM权限DENY |
isv.OUT_OF_SERVICE | 业务停机 |
isv.PRODUCT_UN_SUBSCRIPT | 未开通云通信产品的阿里云客户 |
isv.PRODUCT_UNSUBSCRIBE | 产品未开通 |
isv.ACCOUNT_NOT_EXISTS | 账户不存在 |
isv.ACCOUNT_ABNORMAL | 账户异常 |
isv.SMS_TEMPLATE_ILLEGAL | 短信模板不合法 |
isv.SMS_SIGNATURE_ILLEGAL | 短信签名不合法 |
isv.INVALID_PARAMETERS | 参数异常 |
isp.SYSTEM_ERROR | 系统错误 |
isv.MOBILE_NUMBER_ILLEGAL | 非法手机号 |
isv.MOBILE_COUNT_OVER_LIMIT | 手机号码数量超过限制 |
isv.TEMPLATE_MISSING_PARAMETERS | 模板缺少变量 |
isv.BUSINESS_LIMIT_CONTROL | 业务限流 |
isv.INVALID_JSON_PARAM | JSON参数不合法,只接受字符串值 |
isv.BLACK_KEY_CONTROL_LIMIT | 黑名单管控 |
isv.PARAM_LENGTH_LIMIT | 参数超出长度限制 |
isv.PARAM_NOT_SUPPORT_URL | 不支持URL |
isv.AMOUNT_NOT_ENOUGH | 账户余额不足 |
注:如传递中文出现乱码,请检查编码格式,建议使用utf-8
格式为:yyyy-MM-dd’T’HH:mm:ss’Z’;时区为:GMT