监听通话

如果分机启用了被监听的功能，第三方应用可通过此接口，在另一个分机上监听该分机的通话。

前提条件

被监听者的分机需要启用 允许被监听 的功能 (在 PBX 上的 分机 > 功能 > 呼叫监听 设置)，否则此 API 接口无法生效。

支持的监听模式

通过此接口可实现以下三种方式的监听：
普通监听
监听者只能听，不能与通话中的任意一方通话。
密语监听
监听者能与被监听者对话，但通话中的另一方听不见监听者的声音。
强插监听
监听者可以加入通话，即进入三方通话。

请求 URL

POST {base_url}/{api_path}/call/listen?access_token={access_token}

请求参数

参数 是否必填 类型 说明
monitor 是 String 监听者的分机号。
channel_id 是 String 通话中，被监听者的通话通道 ID。
注： 可在 (30011) 通话状态变更 事件报告中获取通话通道 ID。
type 是 String 监听模式。

取值范围：

  • listen：普通监听
  • whisper：密语监听
  • barge：强插监听

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
call_id String 通话的唯一 ID。

示例

请求示例

分机 2008 监听分机 2000 的通话。

POST /openapi/v1.0/call/listen?access_token=LymgRxH3mFJmIU7M5QR2MUlTo69RclR5 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "monitor": "2008",
    "channel_id":"PJSIP/2000-00000114",
    "type": "listen"
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "call_id": "1650094666.549"
}