服务端
服务端API文档

查询呼入路由

更新时间: 2022/01/14 07:41:24

查询呼入路由

  • 查询呼入路由相关信息

查询呼入路由提供3个接口

  • 通过企业id查询呼入路由
  • 通过企业id和呼入路由id查询唯一一条呼入路由
  • 通过企业id和号码查询唯一一条呼入路由

1、通过企业id查询呼入路由

URL

  • GET
  • URL:http://voip-host/api/v1/voip/cti/app/in/call/route/{appId}

请求参数

参数名称 类型 是否必选 示例 描述
appId String 必填 eca23f68c66d4acfceee77c200200359 应用ID。

示例

请求示例

http://voip-host/api/v1/voip/cti/app/in/call/route/776c3a0f2a7b3f3c6cff9ba0a6ecd445

正常返回示例

{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "id": 4005,
      "appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
      "number": "0451586840321",
      "defaultIvrId": 5027,
      "rule": "",
      "ext1": "第一个外呼路由数据",
      "description": "第一个呼入呼路由数据",
      "dbUpdateTime": "2022-01-14T07:24:05.000+0000",
      "dbCreateTime": "2022-01-14T06:52:04.000+0000"
    }
  ]
}

2、通过企业id和呼入路由id查询唯一一条呼入路由

URL

  • GET
  • URL:http://voip-host/api/v1/voip/cti/app/in/call/route/id/{appId}/{routeRuleId}

请求参数

参数名称 类型 是否必选 示例 描述
appId String 必填 eca23f68c66d4acfceee77c200200359 应用ID。
routeRuleId long 必填 4005 呼入路由唯一id。

示例

请求示例

http://voip-host/api/v1/voip/cti/app/in/call/route/id/776c3a0f2a7b3f3c6cff9ba0a6ecd445/4005

正常返回示例

{
  "code": 0,
  "message": "OK",
  "data": {
    "id": 4005,
    "appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
    "number": "0451586840321",
    "defaultIvrId": 5027,
    "rule": "",
    "ext1": "第一个外呼路由数据",
    "description": "第一个呼入呼路由数据",
    "dbUpdateTime": "2022-01-14T07:24:05.000+0000",
    "dbCreateTime": "2022-01-14T06:52:04.000+0000"
  }
}

3、通过企业id和号码查询唯一一条呼入路由

URL

  • GET
  • URL:http://voip-host/api/v1/voip/cti/app/in/call/route/number/{appId}/{number}

请求参数

参数名称 类型 是否必选 示例 描述
appId String 必填 eca23f68c66d4acfceee77c200200359 应用ID。
number string 必填 0451586840321 呼入you。

示例

请求示例

http://voip-host/api/v1/voip/cti/app/in/call/route/number/776c3a0f2a7b3f3c6cff9ba0a6ecd445/0451586840321

正常返回示例

{
  "code": 0,
  "message": "OK",
  "data": {
    "id": 4005,
    "appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
    "number": "0451586840321",
    "defaultIvrId": 5027,
    "rule": "",
    "ext1": "第一个外呼路由数据",
    "description": "第一个呼入呼路由数据",
    "dbUpdateTime": "2022-01-14T07:24:05.000+0000",
    "dbCreateTime": "2022-01-14T06:52:04.000+0000"
  }
}

返回参数

  • 节点参数说明请查看ivr子节点相关操作
参数名称 类型 示例 描述
code int 0 状态码。
message string OK 请求成功或者失败描述信息。
data json {json} 返回的ivr树信息。
id long 962220 呼入路由唯一id。
appId String eca23f68c66d4acfceee77c200200359 应用ID。
domain int 2 呼入路由作用域,2,中继号号码,3主叫号码。
number String 045123569325 中继号码或者用户手机号。
defaultIvrId long 25639 IVR树id。
description String 第一个呼入路由 描述信息。
此文档是否对你有帮助?
有帮助
去反馈
  • 查询呼入路由
  • 查询呼入路由提供3个接口
  • 1、通过企业id查询呼入路由
  • URL
  • 请求参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 2、通过企业id和呼入路由id查询唯一一条呼入路由
  • URL
  • 请求参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 3、通过企业id和号码查询唯一一条呼入路由
  • URL
  • 请求参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 返回参数