IVR

IVR流程节点统计

接口地址

POST https://m.icsoc.net/v3/portal/api/v1/statistic/ivrNodes

支持http和https两种

接口header

key	value	备注
Content-Type	application/json	标识请求参数为json
Authorization	d5156955e2a6ec760f25366f5626b167ac8bfc97	Authorization为token，用于认证，token获取方式参考最下面的附录，不带Bearer

接口参数

{
  "ivrCode":"ivr-v3_2000006_4d78d5",
  "dataFormat": "all",
  "startTime":"2023-11-22",
  "endTime":"2023-11-24"
}

参数说明

参数	类型	说明	必填
ivrCode	string	查询 IVR 统计的唯一标识	是
dataFormat	string	返回的数据格式 默认 all-所有 day-天	否
startTime	string	当前 IVR 的开始时间 (时间格式：Y-m-d) 时间筛选只支持一周	否
endTime	string	当前 IVR 的结束时间 (时间格式：Y-m-d) 时间筛选只支持一周	否

接口返回结果示例

{
  "code": 0,
  "message": "成功",
  "data": {
    "format": "all",
    "data": [
      {
        "format_name": "",
        "nodes": {
          "name": "开始",
          "node_id": "node1",
          "value": 20,
          "children": [
            {
              "name": "播放语音",
              "node_id": "node2",
              "value": 20,
              "children": [
                {
                  "name": "按键导航",
                  "node_id": "node3",
                  "value": 20,
                  "children": [
                    {
                      "name": "按键1",
                      "node_id": "node3-1",
                      "value": 12,
                      "children": [
                        {
                          "name": "转坐席",
                          "ivr_node": "node4",
                          "value": 11
                        },
                        {
                          "name": "other",
                          "value": 1
                        }
                      ]
                    },
                    {
                      "name": "按键2",
                      "node_id": "node3-2",
                      "value": 4
                    },
                    {
                      "name": "按键3",
                      "node_id": "node3-3",
                      "value": 3
                    },
                    {
                      "name": "F",
                      "node_id": "node3-4",
                      "value": 1
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

结果字段说明

参数名称	类型	说明	是否必须
code	int	0 标识成功，非 0 关注 message 说明	是
message	string	状态码描述	是
data	object	响应对象	是
data.format	string	参照请求参数 dataFormat 原样返回	是
data.data	array	数据	是
data.data.*.format_name	string	数据格式释义	是
data.data.*.nodes	object	ivr 所有节点的统计数据	是
data.data.*.nodes.name	string	节点名称	是
data.data.*.nodes.value	int	节点命中数量	是
data.data.*.nodes.children	array	当前节点子节点	是
data.data.*.nodes.children.name	string	当前节点子节点名称（注意值为other的节点为other为统计IVR在流转过程中放弃未到达后续节点的量，例如按键导航节点，用户可能没有按键即挂机，则other为统计此种情况的数量）	否

IVR流程创建

接口地址

POST https://m.icsoc.net/v3/portal/api/v3/custom-ivr/create

接口参数

{
  "ivr_name":"test-name",
  "ivr_info": {
    "node1": {
      "recIdx": 4,
      "type": 1,
      "name": "wuhanIVR流程-1017",
      "id": "node1",
      "ivr_count": false,
      "ivr_count_name": "wuhanIVR流程-1017",
      "web_id": "1",
      "jump": "node2"
    },
    "node2": {
      "type": 12,
      "name": "转坐席",
      "id": "node2",
      "transfer_type": "fixed",
      "agent": 1053831,
      "transfer_mode": "1",
      "if_lucency_phone": 0,
      "ivr_count": false,
      "ringType": "0",
      "params_type": 1,
      "call_timeout_limit": 30,
      "agent_time_wait": {
        "params_type": 1
      },
      "caller_sound": [],
      "agent_side_sound": [],
      "agent_ring": "0",
      "ivr_count_name": "转坐席",
      "web_id": "2",
      "jump": "node3",
      "parentId": "node1"
    },
    "node3": {
      "type": 7,
      "name": "挂机",
      "id": "node3",
      "ivr_count": false,
      "ivr_count_name": "挂机",
      "web_id": "3",
      "parentId": "node2"
    }
  }
}

参数说明

参数	类型	说明	必填
ivr_name	string	IVR 流程名称（唯一）	是
ivr_info	object	ivr流程节点（具体对接参数请联系商务）	是

接口返回结果示例

{
  "code": 0,
  "message": "成功",
  "data": {
    "ivr_id": 10091,
    "ivr_code": "ivr-v3_2000006_4d78d5"
  }
}

结果字段说明

参数名称	类型	说明	是否必须
code	int	0 标识成功，非 0 关注 message 说明	是
message	string	状态码描述	是
data	object	响应对象	是
data.ivr_id	int	ivr流程ID	是
data.ivr_code	string	ivr流程编码	是

所有IVR流程

接口地址

POST https://m.icsoc.net/v3/portal/api/v3/custom-ivr/all

接口参数

无

参数说明

无

接口返回结果示例

{
  "code": 0,
  "message": "成功",
  "data": [{
    "ivr_id": 10091,
    "ivr_code": "ivr-v3_2000006_4d78d5",
    "ivr_name": "test-ivr",
    "ivr_info": {
      "node1": {
        "recIdx": 4,
        "type": 1,
        "name": "wuhanIVR流程-1017",
        "id": "node1",
        "ivr_count": false,
        "ivr_count_name": "wuhanIVR流程-1017",
        "web_id": "1",
        "jump": "node2"
      }
    }
  }]
}

结果字段说明

参数名称	类型	说明	是否必须
code	int	0 标识成功，非 0 关注 message 说明	是
message	string	状态码描述	是
data.*.ivr_id	int	ivr流程ID	是
data.*.ivr_code	string	ivr流程编码	是
data.*.ivr_name	string	ivr流程名称	是
data.*.ivr_info	object	ivr流程节点	是

IVR流程删除

接口地址

GET|POST https://m.icsoc.net/v3/portal/api/v3/custom-ivr/delete

参数说明

参数名称	类型	说明	是否必须
ivr_id	int	ivr流程ID	是

接口返回结果示例

{
  "code": 0,
  "message": "成功"
}

结果字段说明

参数名称	类型	说明	是否必须
code	int	0 标识成功，非 0 关注 message 说明	是
message	string	状态码描述	是

IVR流程编辑

接口地址

GET|POST https://m.icsoc.net/v3/portal/api/v3/custom-ivr/update

接口参数

{
  "ivr_name":"test-name",
  "ivr_id":10091,
  "ivr_info": {
    "node1": {
      "recIdx": 4,
      "type": 1,
      "name": "wuhanIVR流程-1017",
      "id": "node1",
      "ivr_count": false,
      "ivr_count_name": "wuhanIVR流程-1017",
      "web_id": "1",
      "jump": "node2"
    }
  }
}

参数说明

参数名称	类型	说明	是否必须
ivr_id	int	ivr流程ID	是
ivr_name	string	ivr流程名称	否
ivr_info	object	ivr流程节点	否

接口返回结果示例

{
  "code": 0,
  "message": "成功",
  "data": {
    "ivr_id": 10091,
    "ivr_code": "ivr-v3_2000006_4d78d5"
  }
}

结果字段说明

参数名称	类型	说明	是否必须
code	int	0 标识成功，非 0 关注 message 说明	是
message	string	状态码描述	是
data	object	响应对象	是
data.ivr_id	int	ivr流程ID	是
data.ivr_code	string	ivr流程编码	是