播放自定义提示音

通过本接口向指定号码 (如内部分机号码、广播组和外部号码) 播放自定义提示音。

请求 URL

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

请求参数

参数 是否必填 类型 说明
number 是 String 目标号码。
prompts 是 Array<String> 播放的音频文件。
注：
  • 仅支持播放 PBX 自定义提示音 中的音频文件。
  • 参数中不要携带文件扩展名 .wav、.mp3 或 .gsm；使用半角逗号 , 分隔多个音频文件。

    例：["test_prompt1","test_prompt2"]。
count 否 Integer 播放音频文件的次数。
dial_permission 否 String 如果 number 为外部号码，你需要输入具有外线呼出权限的分机号码。
auto_answer 否 String 可通过此参数控制话机自动应答，即话机无需响铃，自动接听电话。
注： 此功能仅在支持自动应答功能的 IP 话机上生效。
取值范围：
  • yes：启用自动应答
  • no：禁用自动应答 (默认)
volume 否 Integer 播放音频文件的音量。

取值范围：0-20。

响应参数

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

示例

请求示例

向分机 2000 播放自定义提示音。

POST /openapi/v1.0/call/play_prompt?access_token=X8Mjlm9aQvyOnnSAbGJWtrOFmGpkz046 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "number": "2000",
    "prompts": ["test_prompt1","test_prompt2"],
    "count": 1 ,
    "auto_answer": "yes",
    "volume": 20
}

响应示例 

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