全部产品
云市场

短信批量发送API(SendBatchSms)

更新时间:2019-01-15 16:57:54

注意:使用短信服务新版SDK调用API接口,请查看新版SDK参考API参考

发送批量短信接口(SendBatchSms)

步骤 1 创建阿里云账号

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

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

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

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

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

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

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

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

短信签名

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

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

短信模板

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

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

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

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

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

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

在“短信模板”页面完成模板的申请,获得模板ID。模板申请手册

参数

入参列表
参数名称 参数类型 必填与否 样例取值 参数说明
PhoneNumberJson String 必须 [“15000000000”,”15000000001”] 短信接收号码,JSON格式,批量上限为100个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
SignNameJson String 必须 [“云通信”,”云通信”] 短信签名,JSON格式
TemplateCode String 必须 SMS_0000 短信模板ID
TemplateParamJson String 必须 [{“code”:”1234”,”product”:”ytx1”},{“code”:”5678”,”product”:”ytx2”}] 短信模板变量替换JSON串,友情提示:如果JSON中需要带换行符,请参照标准的JSON协议。
SmsUpExtendCodeJson String 可选 [“90999”,”90998”] 上行短信扩展码,JSON格式,无特殊需要此字段的用户请忽略此字段
出参列表
出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
BizId String 134523^4351232 发送回执ID,可根据该ID查询具体的发送状态

技术对接步骤

1:下载SDK工具包

请下载PHP SDK,并将完整的PHP SDK引用到您的工程中,调用示例存放于api_demo、msg_demo目录中,请您参考或修改示例正确调用api,api及依赖项放置在api_sdk、msg_sdk目录中。

SDK&DEMO[下载地址]

2: 编写样例程序

注:有备注无需修改的位置请勿改动。

  1. * 短信服务API产品的DEMO程序,工程中包含了一个SmsDemo类,直接通过
  2. * 执行此文件即可体验短信服务产品API功能(只需要将AK替换成开通了云通信-短信服务产品功能的AK即可)
  3. * 备注:Demo工程编码采用UTF-8
  4. * @return stdClass
  5. */
  6. public static function sendBatchSms() {
  7. // 初始化SendSmsRequest实例用于设置发送短信的参数
  8. $request = new SendBatchSmsRequest();
  9. // 必填:待发送手机号。支持JSON格式的批量调用,批量上限为100个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
  10. $request->setPhoneNumberJson(json_encode(array(
  11. "1500000000",
  12. "1500000001",
  13. ), JSON_UNESCAPED_UNICODE));
  14. // 必填:短信签名-支持不同的号码发送不同的短信签名
  15. $request->setSignNameJson(json_encode(array(
  16. "云通信",
  17. "云通信"
  18. ), JSON_UNESCAPED_UNICODE));
  19. // 必填:短信模板-可在短信控制台中找到
  20. $request->setTemplateCode("SMS_1000000");
  21. // 必填:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
  22. // 友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
  23. $request->setTemplateParamJson(json_encode(array(
  24. array(
  25. "name" => "Tom",
  26. "code" => "123",
  27. ),
  28. array(
  29. "name" => "Jack",
  30. "code" => "456",
  31. ),
  32. ), JSON_UNESCAPED_UNICODE));
  33. // 可选-上行短信扩展码(扩展码字段控制在7位或以下,无特殊需求用户请忽略此字段)
  34. // $request->setSmsUpExtendCodeJson("[\"90997\",\"90998\"]");
  35. // 发起访问请求
  36. $acsResponse = static::getAcsClient()->getAcsResponse($request);
  37. return $acsResponse;
  38. }
  39. // 调用示例:
  40. $response = SmsDemo::sendBatchSms();
  41. echo "批量发送短信(sendBatchSms)接口返回的结果:\n";
  42. 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 账户余额不足

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