全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
短信服务

短信发送API(SendSms)---PHP

更新时间:2017-11-09 18:56:51

发送短信接口(SendSms)

步骤 1 创建阿里云账号

为了访问短信服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:

  1. 访问阿里云 官方网站,单击页面上的 免费注册 按钮。
  2. 按照屏幕提示完成注册流程并进行实名认证,短信服务只支持实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里

步骤 2 获取阿里云访问密钥

为了使用短信发送API-PHP SDK,您必须申请阿里云的访问密钥。

阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。

您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。

步骤 3 在控制台完成模板与签名的申请,获得调用接口必备的参数

短信签名

根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明,个人用户需要上传证明个人身份的证明。

短信签名需要审核通过后才可以使用。

短信模板

短信模板,即具体发送的短信内容。

短信模板可以支持验证码、短信通知、推广短信三种模式。验证码和短信通知,通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。

短信模板需要审核通过后才可以使用。

为了成功发送一条短信通知,您至少需要完成以下步骤

一、在控制台完成短信签名与短信模板的申请,获得调用接口必备的参数

在“短信签名”页面完成签名的申请,获得短信签名的字符串 签名申请手册

在“短信模板”页面完成模板的申请,获得模板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查询具体的发送状态

技术对接步骤

1:下载SDK工具包

SDK工具包中一共包含了2个类库,一个aliyun-php-sdk-core包,另外一个是alicom-dysms-api包,将这两个包添加到工程类库中依赖。

SDK&DEMO[下载地址]

注:PHP目前仅支持5.5以上版本。其他版本可以参照接口协议自行拼接http请求调用

2: 编写样例程序
  1. // 代码节选,详见aliyun-dysms-php-sdk/api_demo/SmsDemo.php
  2. ...
  3. class SmsDemo
  4. {
  5. ...
  6. /**
  7. * 发送短信
  8. *
  9. * @param string $signName <p>
  10. * 必填, 短信签名,应严格"签名名称"填写,参考:<a href="https://dysms.console.aliyun.com/dysms.htm#/sign">短信签名页</a>
  11. * </p>
  12. * @param string $templateCode <p>
  13. * 必填, 短信模板Code,应严格按"模板CODE"填写, 参考:<a href="https://dysms.console.aliyun.com/dysms.htm#/template">短信模板页</a>
  14. * (e.g. SMS_0001)
  15. * </p>
  16. * @param string $phoneNumbers 必填, 短信接收号码 (e.g. 12345678901)
  17. * @param array|null $templateParam <p>
  18. * 选填, 假如模板中存在变量需要替换则为必填项 (e.g. Array("code"=>"12345", "product"=>"阿里通信"))
  19. * </p>
  20. * @param string|null $outId [optional] 选填, 发送短信流水号 (e.g. 1234)
  21. * @param string|null $smsUpExtendCode [optional] 选填,上行短信扩展码(扩展码字段控制在7位或以下,无特殊需求用户请忽略此字段)
  22. * @return stdClass
  23. */
  24. public static function sendSms($signName, $templateCode, $phoneNumbers, $templateParam = null, $outId = null, $smsUpExtendCode = null) {
  25. // 初始化SendSmsRequest实例用于设置发送短信的参数
  26. $request = new SendSmsRequest();
  27. // 必填,设置雉短信接收号码
  28. $request->setPhoneNumbers($phoneNumbers);
  29. // 必填,设置签名名称
  30. $request->setSignName($signName);
  31. // 必填,设置模板CODE
  32. $request->setTemplateCode($templateCode);
  33. // 可选,设置模板参数
  34. if($templateParam) {
  35. $request->setTemplateParam(json_encode($templateParam));
  36. }
  37. // 可选,设置流水号
  38. if($outId) {
  39. $request->setOutId($outId);
  40. }
  41. // 选填,上行短信扩展码
  42. if($smsUpExtendCode) {
  43. $request->setSmsUpExtendCode($smsUpExtendCode);
  44. }
  45. // 发起访问请求
  46. $acsResponse = static::getAcsClient()->getAcsResponse($request);
  47. // 打印请求结果
  48. // var_dump($acsResponse);
  49. return $acsResponse;
  50. }
  51. }
  52. // 调用示例:
  53. $response = SmsDemo::sendSms(
  54. "短信签名", // 短信签名
  55. "SMS_0000001", // 短信模板编号
  56. "12345678901", // 短信接收者
  57. Array( // 短信模板中字段的值
  58. "code"=>"12345",
  59. "product"=>"dsd"
  60. ),
  61. "123" // 流水号,选填
  62. );
  63. echo "发送短信(sendSms)接口返回的结果:\n";
  64. print_r($response);

错误码列表

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 账户余额不足

注:1、如传递中文出现乱码,请检查编码格式,建议使用utf-8

2、查询所有错误码及解决办法请点击短信接口调用错误码

时间戳格式:

格式为:yyyy-MM-dd’T’HH:mm:ss’Z’;时区为:GMT

本文导读目录