拒接来电

通过此接口拒接外线来电。

背景信息

如果在 PBX 上启用了特定中继的 呼入来电控制 功能,当此中继接收到来电时,PBX 会发送一个 (30016) 来电呼叫请求 的事件报告给第三方应用。在此阶段,PBX 预留 10 秒的时间让第三方应用选择接受或拒接来电。

重要: 超出指定时间后调用此接口不会生效,即,如果第三方应用没有在 10 秒内做出操作,PBX 将接受该来电,并将该来电引导到呼入路由的目的地。

前提条件

你已启用中继的 呼入来电控制 功能。更多信息,请参见 启用 Yeastar P 系列云 PBX API

请求 URL

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

请求参数

参数 是否必填 类型 说明
channel_id String 外线呼入的通话通道 ID。
注: 可从 (30016) 来电呼叫请求 事件报告中获取通话通道 ID。

响应参数

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

示例

请求示例

POST /openapi/v1.0/call/refuse_inbound?access_token=Ey7Ty0kL7bpOfPHgpJH2Qq4ozMvU4IEs HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "channel_id": "PJSIP/trunk-test-peer-trunking-endpoint-00000091"
}

响应示例

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