使用 Postman 监控 WebSocket API 事件

本文以监控通话事件为例,介绍如何使用 Postman 监控 Yeastar P 系列 IPPBX 的 API 事件。

前提条件

操作步骤

  1. 登录 Postman。
  2. 在侧边栏,点击 New > WebSocket,打开一个新的请求页签。

  3. 建立与 Yeastar P 系列 IPPBX API 的 WebSocket 连接。

    1. 在请求栏中,编写 WebSocket 连接请求

      在本例中,编写以下请求:

      wss://192.168.5.150:8088/openapi/v1.0/subscribe?access_token=ah1i5B5uGYBY4W4ITiOV9lBwrDp2KPyQ
    2. 点击 Connect

      Response 栏中返回 "Connected",表示已成功建立 WebSocket 连接。

  4. 订阅要监控的事件。

    1. API 事件列表 中查询要监控的事件的 ID,并在 Message 页签中编写事件订阅信息。

      在本例中,订阅 (30011) Call Status Changed(30012) New CDR 事件。

      {"topic_list":[30011,30012]}
    2. 点击 Send

      Response 栏中显示 "SUCCESS",表示事件订阅已成功。

  5. 定期发送心跳请求,以保持 WebSocket 连接有效性。

    1. Message 页签,输入 heartbeat
    2. 点击 Send

      Response 栏中返回心跳响应,表示请求成功。

执行结果

当被监控的事件发生时,系统将自动发送对应事件的报告。

在本例中,被监控的分机收到来电,应答来电和挂断通话时,系统自动发送 “(30011) Call Status Changed” 和 “(30012) New CDR” 事件报告。