获取调查问卷列表

该接口用于获取公司全局调查问卷模板列表

请求方法

GET /questionnaires/questionnaire_list

请求参数

参数名 必填 说明
page 页码,从1开始,默认为1
per_page 每页数量,默认10,最大100

返回参数

属性名 类型 说明
code 整型 执行结果码,1000代表成功
meta 对象 分页信息,详见通用数据
questionnaires 数组 调查问卷模板列表调查问卷模板

请求示例

  curl https://demo.udesk.cn/open_api_v1/questionnaires/questionnaire_list?page=2&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

返回示例

{
  "code": 1000,
  "questionnaires": [{
    "id": 1,
    "name": "ceshi",
    "status": true,
    "created_at": "2019-01-14T16:01:28.000+08:00"
  }],
  "meta": {
    "current_page": 2,
    "total_pages": 2,
    "total_records": 11
  }
}

获取外呼任务调查问卷数据接口

该接口用于获取外呼任务关联的调查问卷填写列表

请求方法

GET /questionnaires/task_questionnaires

请求参数

参数名 必填 说明
task_type 任务类型(手动外呼:"callout_task"; 自动外呼:"ad_task")
task_id 自动外呼或手动外呼任务id
page 页码,从1开始,默认为1
per_page 每页数量,默认10,最大100

返回参数

属性名 类型 说明
code 整型 执行结果码, 1000代表成功
meta 对象 分页信息,详见通用数据
customer_questionnaires 数组 调查问卷填写列表调查问卷填写数据

请求示例

  curl https://demo.udesk.cn/open_api_v1/questionnaires/task_questionnaires?task_type=callout_task&task_id=210&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

返回示例

{
    "code": 1000,
    "customer_questionnaires": [
        {
            "customer_id": 3933,
            "agent_id": 757,
            "created_at": "2022-03-14T20:17:18.000+08:00",
            "agent_name": "Testerkun",
            "customer_name": "S1qilin",
            "questionnaire_name": "Tester的问卷",
            "customer_questionnair_id": 639,
            "questionnaire_id": 17,
            "contents": {
                "在干嘛": "XXX",
                "喜欢谁": "XXX",
                "测试测试赛": "XXX"
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_records": 1
    }
}

获取调查问卷数据接口

该接口用于获取调查问卷模板对应的调查问卷填写数据列表

请求方法

GET /questionnaires/customer_questionnaires

请求参数

参数名 必填 说明
questionnaire_id 调查问卷模板id
page 页码,从1开始,默认为1
per_page 每页数量,默认10,最大100

返回参数

属性名 类型 说明
code 整型 执行结果码, 1000代表成功
meta 对象 分页信息,详见通用数据
customer_questionnaires 数组 调查问卷填写数据列表调查问卷填写数据

请求示例

curl http://linapp.udeskcat.com/open_api_v1/questionnaires/customer_questionnaires?questionnaire_id=11&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

返回示例

{
  "code": 1000,
  "customer_questionnaires": [{
    "customer_id": 196329,
    "agent_id": 365,
    "created_at": "2019-06-26T19:59:07.000+08:00",
    "agent_name": "bai",
    "customer_name": null,
    "contents": {
      "问题2": null,
      "问题3": "1;2;4",
      "问题1": "2"
    }
  }, {
    "customer_id": 196329,
    "agent_id": 365,
    "created_at": "2019-06-24T18:25:58.000+08:00",
    "agent_name": "bai",
    "customer_name": null,
    "contents": {
      "问题2": "问题2问题2问题2问题2问题2问题2问题2问题2问题2问题2",
      "问题3": "1;2;4",
      "问题1": null,
    }
  }],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_records": 2
  }
}

调查问卷填写数据

属性名 类型 说明
customer_id 整型 调查客户id
agent_id 整型 调查客服id
created_at 时间日期 调查时间
agent_name 字符串 调查客服名称
customer_name 字符串 调查客户名称
contents hash 调查结果 {"问题":"答案"},无答案或答案已删除的value为null。 value为字符串或null

调查问卷模板

属性名 类型 说明
id 整型 调查问卷模板id
name 字符串 调查问卷模板名称
status 布尔 调查问卷模板开启状态
created_at 日期时间 调查问卷模板创建时间

code错误码说明

错误码 message信息 exception_message信息 描述
2005 没有找到该资源 Couldn't find Questionnaire without an ID 参数id错误,未找到数据
13000 不存在的调查问卷 必填参数未添加
13003 外呼任务不存在 参数task_id或task_type错误