查询单个呼出路由信息
查询单个呼出路由的详细信息。
请求 URL
GET {base_url}/{api_path}/outbound_route/get?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
id | 是 | Integer | 呼出路由的唯一 ID。 注: 可使用 搜索特定呼出路由 接口搜索呼出路由
ID。 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
data | Object<Outroute_Details> | 呼出路由详细信息。 |
- Outroute_Details
-
表 3. 参数 类型 说明 id Integer 呼出路由的唯一 ID。 name String 呼出路由名称。 outbound_cid String 呼出路由去电显示号码。 dial_pattern_list Array<Dialpattern_List> 呼出号码匹配规则列表。 trunk_list Array<Trunk_List> 呼出路由中继列表。 ext_list Array<Ext_List> 呼出路由分机列表。 pos Integer 呼出路由在列表中的当前位置。 pin_protect String 呼出路由密码。 disable
:禁用single_pin
:单个密码pin_list
:PIN 码列表
pin String 单个密码。 pin_list Integer PIN 码列表的唯一 ID。
- Dialpattern_List
-
表 4. 参数 类型 说明 id Integer 呼出号码匹配规则的唯一 ID。 pattern String 号码规则。 strip Integer 删除的前缀位数。 prepend String 增加的前缀号码。
- Trunk_List
-
表 5. 参数 类型 说明 id Integer 中继的唯一 ID。 name String 中继名称。 type String 中继类型。
- Ext_List
-
表 6. 参数 类型 说明 ext_number String 分机号码。 ext_name String 分机/分机组/部门的名称。 type String 所选项目的类型。 extension
:分机ext_group
:分机组organization
:部门
id Integer 分机/分机组/部门的唯一 ID。
示例
请求示例
GET /openapi/v1.0/outbound_route/get?id=11&access_token=nIAuSgDUim0uZgrNuha8hfzwbvY41NWR HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"data": {
"id": 11,
"name": "shared-trunk",
"outbound_cid": "",
"dial_pattern_list": [
{
"id": 12,
"pattern": "55033X.",
"strip": 5
},
{
"id": 22,
"pattern": "123X.",
"strip": 1,
"prepend": "55033"
}
],
"trunk_list": [
{
"id": 27,
"name": "test-peer-trunking",
"type": "peer"
}
],
"ext_list": [
{
"ext_number": "2010",
"ext_name": "Wayne Willis",
"type": "extension",
"id": 58
}
],
"pos": 4,
"pin_protect": "single_pin",
"pin": "1234"
}
}