uaCSTA - 挂断通话

通过 uaCSTA 挂断通话。

前提条件

Yeastar P 系列云 PBX 支持通过 API 接口对特定 IP 话机进行 uaCSTA 控制操作。要实现此功能，需满足以下前提要求：

请求 URL

POST {base_url}/{api_path}/uacsta_call/hangup?access_token={access_token}

请求参数

参数 是否必填 类型 说明
extension 是 String 要控制的分机。
call_id 是 String 每个 uaCSTA 通话的唯一 ID。
注： 可从 (30020) uaCSTA 通话事件 事件报告中获取此 ID。
ip_address 是 String 分机注册的 IP 话机的 IP 地址和 SIP 端口。

例：192.168.5.2:5060。

响应参数

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

示例

请求示例

通过 uaCSTA 挂断分机 2000 的通话。

POST /openapi/v1.0/uacsta_call/hangup?access_token=Ey7Ty0kL7bpOfPHgpJH2Qq4ozMvU4IEs HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "extension": "2000",
  "call_id": "32786",
  "ip_address": "192.168.5.2:5060"
}

响应示例

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