语音机器人

零、注意事项：

0.1 格式说明

所有API，若未特殊注明，Content-Type 全部使用 application/json。

0.2 出参约定格式

如无特殊说明，出参固定为以下格式：

参数	类型	说明
code	int	状态码，0 - 成功，其余为失败
message	string	提示信息
data	mixed	数据

data 具体格式见每个接口具体说明

0.3 域名

如果无特殊说明，以下 API 中，所有域名均为: https://autocall.icsoc.net

一、语音机器人-所有列表

1.1 路由

GET /api/v1/robot/all

1.2 入参

参数	类型	说明	必填	默认值
type	int	机器人类型：1，呼入机器人；2，外呼机器人	否	2

1.3 出参

参数	类型	说明
id	int	机器人id
name	string	机器人名称

1.4 举例

1.4.1 入参

无

1.4.2 出参

{
    "code":0,
    "message":"操作成功",
    "request_id":"2fe0d92dcaba8401d338214cf7121087",
    "data":[
        {
            "id":83,
            "name":"yansongda-test"
        },
        {
            "id":87,
            "name":"icsoc-test"
        }
    ]
}

二、语音机器人-新增

2.1 路由

POST https://m.icsoc.net/v3/portal/api/v3/open_api/robot/create

2.2 入参

参数	类型	必填	说明
name	string	是	机器人名称
type	int	是	机器人用途：1 呼出 2 呼入
nlp	int	是	机器人类型：3 自定义机器人（注：目前对外只有自定义机器人可用）
dept_id	int	是	部门id
remark	string	否	备注
config	json	是	配置信息，自定义参数。(以实际需求为准，如需要，请联系我方售后人员)

2.3 出参

参数	类型	说明
id	int	机器人id
name	string	机器人名称
type	int	机器人用途：1 呼出 2 呼入
nlp	int	机器人类型：3 自定义机器人（注：目前对外只有自定义机器人可用）
dept_id	int	部门id
remark	string	备注
config	array	配置信息，自定义参数。(以实际需求为准，如需要，请联系我方售后人员)
created_at	string	创建时间
updated_at	string	更新时间

2.4 举例

2.4.1 入参

{
  "name":"cc自定义",
  "dept_id":115667,
  "type":1,
  "nlp":3,
  "config":{
    "public_key":"dasjdlask",
    "url":"www.baidu.com",
    "ext_id":"d2dd"
  },
  "remark":"222"
}

2.4.2 出参

{
  "code":0,
  "message":"ok",
  "data":{
    "id":432,
    "dept_id":115667,
    "name":"cc自定义",
    "type":1,
    "nlp":3,
    "remark":"222",
    "config":{
      "public_key":"dasjdlask",
      "url":"www.baidu.com",
      "ext_id":"d2dd"
    },
    "created_user_id": 1053839,
    "created_at":"2023-09-08 15:00:28",
    "updated_at":"2023-09-08 15:54:59"
  }
}

三、语音机器人-列表

3.1 路由

POST/GET https://m.icsoc.net/v3/portal/api/v3/open_api/robot/lists

3.2 入参

参数	类型	必填	说明	默认值
name	string	否	机器人名称
type	int	否	机器人用途
page	int	否	页码	1
per_page	int	否	每页条数	20

3.3 出参

参数	类型	说明
current_page	int	当前页码
total_page	int	总页数
per_page	int	每页条数
total	int	总条数
data	Robot[]	机器人列表

3.3.1 Robot 定义

参数	类型	说明
name	string	机器人名称
type	int	机器人用途：1 呼出 2 呼入
dept_name	string	部门
dept_id	int	部门id
created_at	string	创建时间
updated_at	string	更新时间
remark	string	备注
config	array	配置信息，自定义参数。(以实际需求为准，如需要，请联系我方售后人员)

3.4 举例

3.4.1 入参

{
    "name":"test",
    "type":2,
    "page":1,
    "per_page":20
}

3.4.2 出参

{
  "code": 0,
  "message": "ok",
  "data": {
    "current_page": 1,
    "total_page": 1,
    "per_page": 20,
    "total": 1,
    "data": [
      {
        "id": 432,
        "dept_id": 115667,
        "name": "cc自定义",
        "type": 1,
        "remark": "222",
        "config": {
          "public_key": "dasjdlask",
          "url": "www.baidu.com",
          "ext_id": "ddd"
        },
        "created_at": "2023-09-08 15:00:28",
        "updated_at": "2023-09-08 15:00:28",
        "dept_name": "shishi1"
      }
    ]
  }
}

四、语音机器人-详情

4.1 路由

GET https://m.icsoc.net/v3/portal/api/v3/open_api/robot/detail

4.2 入参

参数	类型	说明	必填	默认值
id	int	机器人id	是

4.3 出参

参数	类型	说明
id	int	机器人id
name	string	机器人名称
type	int	机器人用途：1 呼出 2 呼入
dept_name	string	部门
dept_id	int	部门id
created_at	string	创建时间
updated_at	string	更新时间
remark	string	备注
config	array	配置信息，自定义参数。(以实际需求为准，如需要，请联系我方售后人员)

4.4 举例

4.4.1 入参

{
    "id":5
}

4.4.2 出参

{
  "code":0,
  "message":"ok",
  "data":{
    "id":432,
    "dept_id":115667,
    "name":"cc自定义",
    "type":1,
    "remark":"222",
    "config":{
      "public_key":"dasjdlask",
      "url":"www.baidu.com",
      "ext_id":"ddd"
    },
    "created_at":"2023-09-08 15:00:28",
    "updated_at":"2023-09-08 15:00:28",
    "dept_name":"shishi1"
  }
}

五、语音机器人-修改

5.1 路由

POST https://m.icsoc.net/v3/portal/api/v3/open_api/robot/update

5.2 入参

参数	类型	必填	说明
id	int	是	机器人id
name	string	是	机器人名称
type	int	是	机器人用途：1 呼出 2 呼入
nlp	int	是	机器人类型：3 自定义机器人（注：目前对外只有自定义机器人可用）
dept_id	int	是	部门id
remark	string	否	备注
config	json	是	配置信息，自定义参数。(以实际需求为准，如需要，请联系我方售后人员)

5.3 出参

参数	类型	说明
id	int	机器人id
name	string	机器人名称
type	int	机器人用途：1 呼出 2 呼入
nlp	int	机器人类型：3 自定义机器人（注：目前对外只有自定义机器人可用）
dept_id	int	部门id
remark	string	备注
config	array	配置信息，自定义参数。(以实际需求为准，如需要，请联系我方售后人员)
created_at	string	创建时间
updated_at	string	更新时间

5.4 举例

5.4.1 入参

{
  "name":"cc自定义",
  "dept_id":115667,
  "type":1,
  "nlp":3,
  "config":{
    "public_key":"dasjdlask",
    "url":"www.baidu.com",
    "ext_id":"d2dd"
  },
  "remark":"222",
  "id":432
}

5.4.2 出参

{
  "code":0,
  "message":"ok",
  "data":{
    "id":432,
    "dept_id":115667,
    "dept_name": "测试部",
    "name":"cc自定义",
    "type":1,
    "nlp":3,
    "remark":"222",
    "config":{
      "public_key":"dasjdlask",
      "url":"www.baidu.com",
      "ext_id":"d2dd"
    },
    "created_at":"2023-09-08 15:00:28",
    "updated_at":"2023-09-08 15:54:59"
  }
}

六、语音机器人-删除

6.1 路由

POST https://m.icsoc.net/v3/portal/api/v3/open_api/robot/delete

6.2 入参

参数	类型	必填	说明
id	int	是	机器人id

6.3 出参

无

6.4 举例

6.4.1 入参

{
  "id":432
}

6.4.2 出参

{
  "code": 0,
  "message": "ok",
  "data": []
}

零、注意事项：​

0.1 格式说明​

0.2 出参约定格式​

0.3 域名​

一、语音机器人-所有列表​

1.1 路由​

1.2 入参​

1.3 出参​

1.4 举例​

1.4.1 入参​

1.4.2 出参​

二、语音机器人-新增​

2.1 路由​

2.2 入参​

2.3 出参​

2.4 举例​

2.4.1 入参​

2.4.2 出参​

三、语音机器人-列表​

3.1 路由​

3.2 入参​

3.3 出参​

3.3.1 Robot 定义​

3.4 举例​

3.4.1 入参​

3.4.2 出参​

四、语音机器人-详情​

4.1 路由​

4.2 入参​

4.3 出参​

4.4 举例​

4.4.1 入参​

4.4.2 出参​

五、语音机器人-修改​

5.1 路由​

5.2 入参​

5.3 出参​

5.4 举例​

5.4.1 入参​

5.4.2 出参​

六、语音机器人-删除​

6.1 路由​

6.2 入参​

6.3 出参​

6.4 举例​

6.4.1 入参​

6.4.2 出参​

零、注意事项：

0.1 格式说明

0.2 出参约定格式

0.3 域名

一、语音机器人-所有列表

1.1 路由

1.2 入参

1.3 出参

1.4 举例

1.4.1 入参

1.4.2 出参

二、语音机器人-新增

2.1 路由

2.2 入参

2.3 出参

2.4 举例

2.4.1 入参

2.4.2 出参

三、语音机器人-列表

3.1 路由

3.2 入参

3.3 出参

3.3.1 Robot 定义

3.4 举例

3.4.1 入参

3.4.2 出参

四、语音机器人-详情

4.1 路由

4.2 入参

4.3 出参

4.4 举例

4.4.1 入参

4.4.2 出参

五、语音机器人-修改

5.1 路由

5.2 入参

5.3 出参

5.4 举例

5.4.1 入参

5.4.2 出参

六、语音机器人-删除

6.1 路由

6.2 入参

6.3 出参

6.4 举例

6.4.1 入参

6.4.2 出参