拒接来电

背景信息

如果在 PBX 管理网页上对特定中继启用了呼入来电控制 (路径：应用对接 > 二次开发接口 > 高级设置 > 中继状态监控)，则每当有外线呼入进入该中继时，PBX 会将此通话保持最多 10 秒的时间，并向第三方应用程序发送一个 (30016) 来电呼叫请求事件。

在此10秒的时间内，第三方应用可以决定如何处理该呼入通话：

接受来电：调用 call/accept_inbound 接口。PBX 将立即根据呼入路由设置，将来电路由至预设目的地。
拒接来电：调用 call/refuse_inbound 接口。PBX 将立即放弃该通话，且预设目的地不会响铃。

重要：超出该 10 秒的时间段后调用这些接口将不会生效。10 秒后，PBX 将自动接受该来电，并将其路由至预设目的地。

前提条件

你已启用中继的呼入来电控制功能。更多信息，请参见启用 Yeastar P 系列 IPPBX 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: 192.168.5.150:8088
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"
}