播放语音

通过本接口播放音乐文件给分机、外线号码或广播组。

请求地址

{base_url}/{api_path}/call/playprompt?token={token}

请求参数

参数 是否必选 类型 描述
number 是 String 播放音乐的目标号码。
取值范围：
  • 分机号。
  • 外部号码。
  • 广播组号码。
prompt 是 String 播放的语音文件。

取值范围：

  • 播放 1 个语音文件：音频文件名称，如 music1。
  • 播放多个语音文件：使用符号 “+” 链接多个文件，如 music1+music2。
注：
  • 音乐文件需要提前上传到 PBX。
  • 文件名称必须包含字母，且不得包含符号 “+”。
count 否 Integer 播放语音文件的次数。
dialpermission 否 String number 为外线号码时，需要设置使用哪个分机号的权限将通话转移给外线号码。
autoanswer 否 String 当 caller 为分机号码时，可以通过本项控制话机自动应答。即话机无需响铃，自动接听电话。
注： 该功能仅在 SIP 话机支持的情况下可用。
取值范围：
  • yes：启用自动应答。
  • no：禁用自动应答。

默认值：no。
volume 否 Integer 播放音乐的音量。

取值范围：0~20。

响应参数

参数 类型 描述
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
callid String 每个通话的唯一 ID。

示例

请求参数

POST /api/v2.0.0/call/playprompt?token=16cfa49e417009cf1017aa284217f3ff HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "1023",
	"prompt": "music1+music2",
	"count": "2"
	"autoanswer": "yes",
	"volume": "10"
}
响应参数
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"callid": "1571714617.6"
}