查询去电
查询当前 IPPBX 系统分机通过外线呼出的所有通话的详细信息,如:主叫、被叫、通话状态、通过的中继、目的地等。
Endpoint
POST /api/v1.1.0/outbound/query?token={token}
请求参数
- 不带参数表示查询所有。
- 带参数表示查询单个或多个,多个时需用
,
隔开。
名称 | 是否必需 | 类型 | 描述 |
---|---|---|---|
outboundid |
否 | Int | 外线去电编号。 |
响应参数
名称 | 类型 | 描述 |
---|---|---|
outbound |
Object | 去电,为呼出到外线的外部通话。 |
outboundid |
String | 外线去电编号,通过该参数对去电进行转接、查询、挂断等操作。 |
from |
String | 主叫号码。 |
to |
String | 被叫号码。 |
trunk |
String | 呼出时通过的中继名称。 |
status |
String |
通话状态
|
实际示例
请求示例
POST /api/v1.1.0/outbound/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1 Content-Type:application/json; charset=utf-8 Host: api.yeastarcloud.com { "outboundid": "1495705009.316" }
HTTP/1.1 200 OK Access-control-allow-origin: * Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE { "status": "Success", "outbound": [ { "outboundid": "1495705009.316", "from": "1002", "to": "41000", "trunk": "SIP-142", "status": "Talking" } ] }