建立多方通话

通话过程中，通过此接口邀请新成员加入通话，建立三方通话或多方通话。

使用限制

支持最多 9 方通话。

请求 URL

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

请求参数

参数 是否必填 类型 说明
channel_id 是 String 发起通话邀请的成员的通话通道 ID。
注： 可从 (30011) 通话状态变更 事件报告中获取通话通道 ID。
number 是 String 被邀请加入通话的目标号码。
注： 每次调用接口，只能邀请一个成员。
dial_permission 否 String 输入具有呼叫权限的分机号码。
注：
  • 如果 number 为分机号码，且你想要此 API 接口遵循 PBX 上 客户端权限 设置的分机可见性权限，则必须在此参数中输入可查 number 的分机号码。
  • 如果 number 为外部号码，而通话成员的分机不具有外呼权限，你需要在此参数中输入具有外线呼出权限的分机号码。

响应参数

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

示例

请求示例

在已建立的通话中，分机 2005 使用分机 2000 的外线呼出权限邀请外部号码 13900000002 加入通话。

POST /openapi/v1.0/call/add_member?access_token=iT5jNGS42RRrbsr0dRz18dDN2cZtcYTz HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "channel_id": "PJSIP/2005-0000007c",
    "number": "13900000002",
    "dial_permission": "2002"
}

响应示例

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