PHP SDK

最近更新时间:2019-09-20 10:01:08

SDK 功能简介

语音消息 SDK 支持以下操作:

说明:

  • 发送语音验证码
    只需提供验证码数字,如需自定义内容,可以 发送语音通知。例如,当 msg=“5678” 时,您收到的语音通知为您的语音验证码是五六七八。
  • 发送语音通知
    数字默认按照个十百千万进行播报,可通过在数字前添加英文逗号(,)改变播报方式。例如,当 msg=您的语音验证码是5678。 时,您收到的语音通知为您的语音验证码是五千六百七十八。,当 msg=您的语音验证码是5,6,7,8。时,您收到的语音通知为您的语音验证码是五六七八。

SDK 使用指南

相关资料

各个接口及其参数的详情介绍请参见 API 指南SDK 文档错误码

前提条件

在使用 SDK 前,您需要准备以下信息:

  • 获取 SDK AppID 和 App Key
    语音消息应用 SDK AppIDApp Key 可在 语音消息控制台 的应用信息里获取。如您尚未添加应用,请登录语音消息控制台 创建应用
  • 申请模板并确认审核通过
    语音正文内容模板需申请和审核,模板可在 语音消息控制台 的【应用管理】>【语音模板】页面申请,详细申请操作请参见 配置语音模板

配置 SDK

  • Composer 配置:
    qcloudsms_php 采用 composer 进行安装,要使用 qcloudsms 功能,只需要在 composer.json 中添加如下依赖:

    {
      "require": {
          "qcloudsms/qcloudsms_php": "0.1.*"
      }
    }
    说明:

    Composer 的使用可以参考 demo 目录下面的示例。

  • 手动配置:

    1. 手动下载或 clone 最新版本 qcloudsms_php 代码。
    2. 把 qcloudsms_php src 目录下的代码放入 Autoloading 目录。
    3. 引入 require qcloudsms_php src 目录下面的 index.php 即可使用,如把 qcloudsms 放在当前目录下,只需要执行以下命令:
      require __DIR__ . "/qcloudsms_php/src/index.php";

示例代码

说明:

所有示例代码仅作参考,无法直接编译和运行,需根据实际情况进行修改。

  • 准备必要参数
    // 语音消息应用 SDK AppID
    $appid = 1400009099; // SDK AppID 以1400开头
    // 语音消息应用 App Key
    $appkey = "9ff91d87c2cd7cd0ea762f141975d1df37481d48700d70ac37470aefc60f9bad";
    // 需要发送语音消息的手机号码
    $phoneNumbers = ["21212313123", "12345678902", "12345678903"];
    // 语音模板 ID,需要在语音消息控制台中申请
    $templateId = 7839;  // NOTE: 这里的模板 ID`7839`只是示例,真实的模板 ID 需要在语音消息控制台中申请

  • 发送语音验证码
    use Qcloud\Sms\SmsVoiceVerifyCodeSender;
    try {
      $vvcsender = new SmsVoiceVerifyCodeSender($appid, $appkey);
      $result = $vvcsender->send("86", $phoneNumbers[0], "5678");
      $rsp = json_decode($result);
      echo $result;
    } catch (\Exception $e) {
      echo var_dump($e);
    }

  • 指定模板发送语音通知
    use Qcloud\Sms\TtsVoiceSender;
    try {
      $templateId = 1013;
      $params = ["54321"];
      $tvsender = new TtsVoiceSender($appid, $appkey);
      $result = $tvsender->send("86", $phoneNumbers[0], $templateId, $params);
      $rsp = json_decode($result);
      echo $result;
    } catch (\Exception $e) {
      echo var_dump($e);
    }