挂断通话

通过此接口挂断正在进行的通话。

请求 URL

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

请求参数

参数 是否必填 类型 说明
channel_id 否 String 要挂断的成员的通话通道 ID。
注： 可从 (30011) 通话状态变更 事件报告中获取通话通道 ID。
paging_number 否 String 要挂断的广播组号码。
注： 此参数在要挂断广播组通话时必填。

响应参数

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

示例

请求示例

挂断分机 1005 的通话。

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

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "channel_id": "PJSIP/1005-00000023"
}

响应示例

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