呼叫停泊

通话期间，将当前通话停泊。

请求 URL

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

请求参数

参数 是否必填 类型 说明
channel_id 是 String 要被停泊的成员的通话通道 ID。
注： 可从 (30011) 通话状态变更 事件报告中获取通话通道 ID。
parking_slot 否 String 指定呼叫停泊号码，通话将被停泊到此停泊号中。
注： 若未添加此参数，系统将自动分配一个空闲的停泊号。

响应参数

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

示例

请求示例

将分机 2005 与分机 2008 的通话停泊到指定停泊号 6000，其中被停泊方为 2005。

POST /openapi/v1.0/call/park?access_token=5PqRn8K4vQdOjCa1lu0ppX6ZwREXicCW HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "channel_id": "PJSIP/2005-00000081",
    "parking_slot": "6000"
}

响应示例

被停泊方 2005 被保持，分机 2008 听到提示音，告知通话驻留的停泊号码为 6000。

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "call_id": "1651497945.90",
    "parking_slot": "6000"
}

取回被停泊的通话

可使用 API 请求 call/dial 拨打呼叫停泊号码取回被停泊的通话。

更多信息，请参考 发起呼叫。