配置 Apidaze SMS 短信渠道

本文介绍如何在 Yeastar P 系列云 PBX 上配置 Apidaze SMS 短信渠道，以便企业坐席可以在 Linkus UC 客户端上接收并回复客户的 SMS 消息。

使用要求

Yeastar PBX 需满足以下要求：
  • 固件版本：84.20.0.128 或更高版本
  • 订阅服务：企业版 或 旗舰版
  • 域名：由于第三方平台限制，域名中不能包含下划线，否则消息渠道会出现验证失败或无法接收消息的问题。
  • 域名证书：安装有效的域名证书。
    注： 如果你的云 PBX 的一级域名不是 Yeastar 提供的标准域名 (ycmcloud.com、yeastarcloud.com 或 yeastarycm.co.za)，则必须确保已为 PBX 安装有效的域名证书，否则消息渠道会出现验证失败或无法接收消息的问题。

支持的消息类型和限制

支持的消息类型
Apidaze SMS 短信渠道支持发送文字消息和多媒体消息 (MMS)，其中支持的 MMS 文件类型取决于 Apidaze。
重要： 发送多媒体消息 (例如图片) 时，SMS 运营商会通过 PBX 提供的链接下载文件。因此，如果你设置了 国家地区 IP 访问防御 安全规则，需确保 PBX 允许 SMS 运营商所在国家的 IP 访问，否则文件传输会失败。
限制
  • 文件大小：最大 100 MB
  • 文件保留时间：72 小时

前提条件

向 Apidaze SMS 运营商获取以下信息：
  • API key (API 密钥)
  • Secret (密钥)
  • 用于发送和接收信息的电话号码
    注： 如果企业需要与美国客户联系，须确保此电话号码已经完成 10DLC 注册，以防止发送到美国号码的 SMS 消息被拦截。

操作步骤

步骤一、在 PBX 上创建并配置 SMS 短信渠道

  1. 登录 PBX 管理网页，进入 讯息管理 > 消息渠道。
  2. 点击 添加，选择 SMS。
  3. 在 鉴权信息 栏，填写 Apidaze 的鉴权信息。

    • 名称：为渠道设置一个便于识别的名称。
    • 运营商：选择 Apidaze。
    • API Key：输入从 Apidaze 获取的 API key。
    • Secret：输入从 Apidaze 获取的 Secret。
  4. 在 消息设置 栏，配置该渠道。
    1. 在 消息发送速率 栏，指定 PBX 每秒可发送多少条消息。
      注：
      • 如果消息发送的速率超过此处设置的值，PBX 会将消息排队，并按照设置的速率发送。
      • 如果设置的消息发送速率超过 SMS 运营商设置的速率，可能会导致消息发送失败。因此，请联系 SMS 运营商确认你的账户的发送速率限制，并根据需要提高限制。
    2. 可选： 如果你想要系统自动关闭在指定时间内无任何互动的会话，勾选 自动关闭会话，并在 会话超时时间 (天) 栏中设置超时时间。

    3. 在 聊天文件的附带文本 字段，指定发送聊天文件时附带的默认文本内容。

      消息接收方将会看到该文本与聊天文件一起显示。

    4. 在 号码 栏，点击 添加，添加消息路由规则。

      • 号码：填写购买的号码，或指定字母数字发件人 ID。
        注： 若填写号码，则需以 E.164 格式填写 ([+][国家区号][电话号码])。例如 +14102161183。
      • 消息目的地：设置通过此号码送入的消息会被送往哪个目的地。
        选项 说明
        分机 若选择此项，需在 分机 下拉列表中选择接收消息的分机。

        只有此分机用户可以接收到通过此号码送入的消息。
        消息队列 若选择此项，需在 消息队列 下拉列表中选择接收消息的队列。

        所选队列中的所有坐席都会收到队列中新会话的消息，但只有接管了会话的用户可以接收并回复后续送入的消息。
        第三方分析平台（消息通过二次开发接口传递） 若选择此项，通过此号码送入的消息会通过 API 转发到第三方消息分析平台进行进一步分析或处理。
        注： 要实现入站消息自动转发至第三方消息分析平台，需确保 PBX 系统已经已通过 API 与第三方消息分析平台对接。选择此选项后，PBX 系统就会自动将收到的消息发送到指定平台。你可以通过监控 API 事件 (30031) 新消息通知获取相关事件通知。此外，PBX 提供了完整的讯息管理 API 接口，可用于与对接的第三方消息分析平台进行进一步的消息交互。
      • 允许创建会话的分机：选择一个或多个分机，选择的分机可以向外部用户发送消息。
    5. 点击 保存。
  5. 点击 保存。

步骤二、在 Apidaze 中配置 webhook

  1. 在 PBX 管理网页，进入 讯息管理 > 消息渠道。
  2. 点击创建的短信渠道。
  3. 在 鉴权信息 页签，复制 Webhook URL。

  4. 在 Apidaze 中，使用 PBX 的 Webhook URL 为号码设置消息 Webhook，用于消息回调。

执行结果

  • 你已成功创建了消息渠道，可在列表中查看到此渠道的 状态 显示为 。

  • 系统自动追踪并记录该渠道上发送和接收的消息数量，其中 总发送量 包含了发送成功和发送失败的所有消息数量。
    注：
    • 对于发送消息，PBX 仅追踪坐席在其 Linkus UC 客户端上发送的消息数据。因此，如果你要计算准确的消息发送费用，需要和 SMS 运营商确认精准的消息发送数量，因为在发送的信息超过 160 个字符的情况下，运营商可能将消息拆分发送，并在到达客户手机时将消息整合，这会额外增加发送消息的数量。
    • 可通过时间筛选查看指定时间段内的消息数据。

后续步骤

发送测试消息，确认指定的坐席是否可以在 Linkus UC 客户端上成功接收和发送消息。