发起呼叫

支持的呼叫类型

表 1.
主叫	被叫
分机	分机 IVR 响铃组队列广播组会议室外部号码
IVR	外部号码
响铃组	外部号码
队列	外部号码
外部号码	外部号码

背景信息

此接口受限于主叫的呼叫权限。

呼叫内部用户: 如果被叫为分机号码，而主叫禁止查看被叫号码 (由 PBX 上的客户端权限设置)，则呼叫会失败，并触发 (30015) 呼叫失败事件。
呼叫外部用户: 如果被叫为外部号码，而主叫无外线呼出权限，则呼叫会失败，并触发 (30015) 呼叫失败事件。

提示：在这种情况下，可使用 dial_permission 参数，借助其他分机的拨号权限发起呼叫。

请求 URL

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

请求参数


参数	是否必填	类型	说明
caller	是	String	主叫号码。
callee	是	String	被叫号码。
dial_permission	否	String	输入具有呼叫权限的分机号码。注： `callee` 为分机时，如果 `caller` 的分机无法查看到 `callee` 的分机，你需要在此参数中输入可查看 `callee` 的分机号码。 `callee` 为外部号码时，如果 `caller` 不具有外呼权限，你需要在此参数中输入具有外线呼出权限的分机号码。
auto_answer	否	String	如果 `caller` 为分机号码，可通过此参数控制话机自动应答，即话机无需响铃，自动接听电话。注：此功能仅在支持自动应答功能的 IP 话机上生效。取值范围： `yes`：启用自动应答 `no`：禁用自动应答 (默认)

响应参数


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

示例

请求示例

分机 1005 借助分机 2002 的外呼权限呼叫外线电话 5503301。

POST /openapi/v1.0/call/dial?access_token=4aR4RzkFGEfIvGDJVbAd4vEWg6NtoWog HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "caller": "1005",
    "callee": "5503301",
    "dial_permission": "2002",
    "auto_answer": "yes"
}

响应示例

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