查询 IVR 设置

查询单个或多个 IVR 的详细信息,如:IVR 号码、名称、按键事件、响应超时时间。

Endpoint

POST /api/v1.1.0/ivr/query?token={token}

请求参数

名称 是否必需 类型 描述
ivrid String IVR号码。
  • 查询单个 IVR:设置 ivrid 为 IVR 号码。

    例如:"ivrid":"6500"

  • 查询多个 IVR:设置 ivrid 为 IVR 号码,多个 IVR之间用 , 隔开。

    例如:"ivrid":"6500,6501,6502"

  • 查询所有 IVR:不带 ivrid 请求参数。

响应参数

名称 类型 描述
ivrnumber String IVR 号码。
ivrname String IVR 名称。
prompt String IVR 提示音。
promptrepeat String 提示音播放次数。
responsetimeout Int 响应超时时间。
digittimeout Int 按键超时时间。
dialext String 允许从分机呼出。
  • on:允许。
  • off:不允许。
dialoutboundroutes String 允许从呼出路由拨出。
  • on:允许。
  • off:不允许。
selectedrouters String 所选择的路由。
dialtocheckvoicemail String 允许查阅语音留言。
  • on:允许。
  • off:不允许。

实际示例

请求示例

查询 IVR 6500。

POST /api/v1.1.0/ivr/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "ivrid": "6500"
}

查询所有IVR。

POST /api/v1.1.0/ivr/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "ivr": [
        {
            "ivrnumber": "6500",
            "ivrname": "6500",
            "prompt": "[Default]",
            "promptrepeat": "3",
            "responsetimeout": "3",
            "digittimeout": "3",
            "dialext": "on",
            "dialoutboundroutes": "off",
            "dialtocheckvoicemail": "off"
        }
    ]
}