开放接口（答题端）

简介

为支持各类业务场景，将问卷答题端相关的接口进行开放。第三方可通过接口的形式查询问卷内容（题目&选项）、提交答题数据等。

1. 问卷内容接口

2. 提交答卷接口

3. 分段提交答卷接口

4. 问卷分发详情接口

5. media资源上传（单文件）

6. media资源上传（多文件）

7. ams领奖接口

8. ams领奖状态查询接口

9. 获取用户答案接口

-----------------------------------------------------------------------------------------------------

1. 问卷内容接口

关联文档：开放接口（管理端）--获取问卷详情

接口地址

正式地址： https://in.weisurvey.com/v2/api/
测试地址： 
Path： /surveys/:sid
Method： GET

接口描述

示例：
{
    "data": {
        "pages": [
            {
                "id": "0uCa",
                "questions": [
                    "11sj"
                ]
            }
        ],
        "questions": {
            "11sj": {
                "type": "radio",
                "title": "<p><strong>【单选题】</strong>您的职业？</p>",
                "desc": "<p>备注：<em><u>此处为</u></em><strong style="color: FFFF0000;"><em><u>备注信息</u></em></strong></p>",
                "required": true,
                "options": [
                    {
                        "text": "学生",
                        "id": "2Lrw"
                    },
                    {
                        "text": "教师",
                        "id": "3jhF"
                    },
                    {
                        "text": "公司职员",
                        "id": "4wP0"
                    },
                    {
                        "text": "其他，请注明",
                        "id": "5ahJ"
                    }
                ],
                "id": "11sj"
            }
        }
    }
}

请求参数

路径参数

参数名称	示例	备注
sid	5cd92958fdce2717546f45e5	问卷ID，24长度字符串

返回数据

名称	类型	是否必须	其他信息
data	object	非必须
├─ _id	string	非必须
├─ status	number	非必须
├─ title	string	非必须
├─ conclusion	string	非必须
├─ introduction	string	非必须
├─ pages	object []	非必须	item 类型: object
├─ id	string	非必须
├─ questions	string []	非必须	item 类型: string
├─		非必须
├─ questions	object	非必须
├─ LKQ1	object	非必须
├─ blank	boolean	非必须
├─ description	null	非必须
├─ id	string	非必须
├─ lastOptionFixed	boolean	非必须
├─ options	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ preLineNum	number	非必须
├─ random	boolean	非必须
├─ randomGroup	boolean	非必须
├─ randomGroupSetting	object	非必须
├─ random	boolean	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ relateFor	string []	非必须	item 类型: string
├─		非必须
├─ required	boolean	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ verticalLineNum	number	非必须
├─ time	number	非必须
├─ displayRules	null	非必须
├─ standardizedModelTagConfigs	object	非必须
├─ playerType	null	非必须
├─ cycleConf	null	非必须
├─ activities	object	非必须
├─ question_id	string	非必须
├─ version	string	非必须
├─ isSubSurveyMode	boolean	非必须
├─ subSurveys	null	非必须
├─ updated_at	string	非必须
meta	object	非必须
├─ configs	object	非必须
├─ accountLimit	boolean	非必须
├─ amsLottery	boolean	非必须
├─ browserLimit	boolean	非必须
├─ callbackUrl	string	非必须
├─ canCheckAnswers	boolean	非必须
├─ canPhaseSubmit	boolean	非必须
├─ collectDeadlineMsg	string	非必须
├─ collectNotify	boolean	非必须
├─ collectProgress	boolean	非必须
├─ domain	string	非必须
├─ forbidUserSelect	boolean	非必须
├─ ipLimit	boolean	非必须
├─ isCanFallback	boolean	非必须
├─ isSaveAnswersHistory	boolean	非必须
├─ language	string	非必须
├─ outVerificationRegions	null	非必须
├─ outVerificationSkipWelcome	boolean	非必须
├─ outVerificationUseDefault	boolean	非必须
├─ phaseSubmitPages	null	非必须
├─ redirect	boolean	非必须
├─ redirectUri	string	非必须
├─ showProgress	boolean	非必须
├─ showSerial	boolean	非必须
├─ showWatermark	boolean	非必须
├─ theme	null	非必须
├─ useNewLogic	boolean	非必须
├─ verification	boolean	非必须
├─ whitelistLimit	boolean	非必须
├─ whitelistType	string	非必须
├─ acceptCheckbox	boolean	非必须
├─ agreement	string	非必须

2. 提交答卷接口

接口地址

正式地址： https://in.weisurvey.com/v2/api/
测试地址： 
Path： /surveys/:sid
Method： POST

接口描述

{
"fingerprint":"717185371687d903d6c7e25710963045",
"answers":[{"id":"VOJ1","type":"radio","options":[{"id":"YJM2","text":"选项1"}]}],
"time":1577093714,
"continent": "Asia",
"region": "China",
"age": "14 or lower"
}

answers示例：
{
  "i7zq": {
    "id": "i7zq",
    "type": "radio",
    "options": [
      {
        "id": "jpZ5",
        "text": "选项1",
        "checked": true
      },
      {
        "id": "kn74",
        "text": "选项2",
        "checked": false
      }
    ]
  },
  "edw6": {
    "id": "edw6",
    "type": "radio",
    "options": [
      {
        "id": "cHbM",
        "text": "<p><strong>选项1</strong></p>",
        "checked": true
      },
      {
        "id": "dxKd",
        "text": "选项2",
        "checked": false
      }
    ]
  }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
sid	5cd92958fdce2717546f45e5	问卷ID，24长度字符串

Body

名称	类型	是否必须	备注	其他信息
fingerprint	string	必须	用户指纹
answers	object	必须	答案是动态根据问卷配置来的
├─ 1vSZ	object	必须
├─ id	string	必须
├─ type	string	必须
├─ options	object []	必须		item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ checked	boolean	必须
├─ 9jXS	object	必须
├─ id	string	必须
├─ type	string	必须
├─ options	object []	必须		item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ checked	boolean	必须
├─ 43Yw	object	必须
├─ id	string	必须
├─ type	string	必须
├─ options	object []	必须		item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ checked	boolean	必须
time	number	必须	时间戳
continent	string	非必须	大洲
region	string	非必须	国家或地区
age	string	非必须	年龄
callback_params	string	非必须	第三方回调自定义参数
channel	string	非必须	渠道

返回数据

名称	类型	是否必须	备注	其他信息
data	object	非必须
├─ id	string	非必须	用户答题ID

3. 分段提交答卷接口

接口地址

正式地址： https://in.weisurvey.com/v2/api/
测试地址： 
Path： /phase-answer/{surveyId}
Method： POST

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
surveyId		问卷id

Body

名称	类型	是否必须	备注	其他信息
client_id	string	非必须
query_string	string	非必须
time	number	非必须
answer_id	string	必须	答卷id
answer_finished	boolean	必须	问卷是否已完成
answers	object []	非必须		item 类型: object
├─ id	string	必须
├─ type	string	必须
├─ options	object []	必须		item 类型: object
├─ id	string	必须
├─ text	string	必须

4. 问卷分发详情接口

接口地址

正式地址： https://in.weisurvey.com/v2/api/
测试地址：
Path： /survey_distributes/{id}
Method： GET

请求参数

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	备注	其他信息
data	object	非必须
├─ _id	string	非必须
├─ tips	string	非必须	提示语
├─ random	boolean	非必须	随机排序
├─ surveys	object []	非必须	问卷列表	item 类型: object
├─ button	string	必须	按钮文本
├─ remark	string	必须
├─ surveyId	string	必须	问卷id
├─ relationships	object	非必须

5. media资源上传（单文件）

接口地址

正式地址： https://in.weisurvey.com/v2/api/
测试地址： https://undefined
Path： /media
Method： POST

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
attachment	file	是

返回数据

名称	类型	是否必须	备注	其他信息
data	object	非必须
├─ file_name	string	非必须
├─ file_cdn_url	string	非必须
├─ file_origin_url	string	非必须
├─ is_success	boolean	非必须

6. media资源上传（多文件）

接口地址

正式地址： https://in.weisurvey.com/v2/api/
测试地址： https://undefined
Path： /media_multi
Method： POST

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
attachments	file	是		附件多选

返回数据

名称	类型	是否必须	备注	其他信息
data	object []	非必须		item 类型: object
├─ file_name	string	必须	文件名
├─ file_cdn_url	string	必须	cdn链接，用于答题端展示
├─ file_origin_url	string	必须	真实url，用于提交数据
├─ is_success	boolean	必须	该图片是否上传成功

7. ams领奖接口

接口地址

正式地址：https://in.weisurvey.com/v2/api/
测试地址：
Path： /survey/lottery/{id}
Method： POST

接口描述

可能的错误码

'role_parse_failed' => [
    'code'   => 10012,
    'detail' => '角色信息解析失败',
],
'has_not_answered' => [

'code'   => 10013,

'detail' => '还未提交答卷',

],


'survey_configure_error' => [

'code'   => 10014,

'detail' => 'ams配置错误',

],


'ams_lottery_not_configure' => [

'code'   => 10015,

'detail' => '该问卷未配置发奖',

],


'ams_lottery_draw_error' => [

'code'   => 10016,

'detail' => '奖品领取失败',

],


'ams_already_drew' => [

'code'   => 10017,

'detail' => '已经领取过奖品了',

]

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
Referer		是	https://test.a.imur.tencent.com/answer?sid=5f16524076051f1332527962&ADTAG=sid.5f16524076051f1332527962&lang=zh-CHT&sPlatId=0&sArea=1&sPartition=10019&sRoleId=7qb-hpfqo-2	游戏角色参数

路径参数

参数名称	示例	备注
id	5f16527a8787be002e44aef2	问卷id

返回数据

名称	类型	是否必须	备注	其他信息
data	object	必须
├─ package_id	number	必须	礼包id
├─ package_name	string	必须	礼包名称
├─ package_num	number	必须	礼包数量

8. ams领奖状态查询接口

接口地址

正式地址：https://in.weisurvey.com/v2/api/
测试地址：
Path： /survey/lottery/{id}
Method： GET

请求参数

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	备注	其他信息
data	object	必须
├─ _id	string	必须
├─ package_group_id	string	必须	礼包组id
├─ package_id	null	必须
├─ package_name	string	必须
├─ package_num	null	必须
├─ ret_code	number	必须	ams状态码
├─ status	boolean	必须	true：领取成功 false：领取失败

9. 获取用户答案接口

接口地址

正式地址： https://in.weisurvey.com/v2/api/
测试地址： https://survey.imur.oa.com
Path： /answers/{sid}
Method： GET

请求参数

路径参数

参数名称	示例	备注
sid

返回数据

名称	类型	是否必须	其他信息
data	object	非必须
├─ _id	string	非必须
├─ answers	object []	非必须	item 类型: object
├─ id	string	必须
├─ type	string	必须
├─ options	object []	必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ name	string	必须
├─ text	string	非必须
├─ value	number	非必须
├─ groups	object	必须
├─ GDTe	object []	非必须	item 类型: object
├─ id	string	非必须
├─ text	string	非必须
├─ TCPd	object []	非必须	item 类型: object
├─ id	string	非必须
├─ text	string	非必须
├─ XIIj	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ ZALi	object []	非必须	item 类型: object
├─ id	string	非必须
├─ text	string	非必须
├─ MHVo	number	非必须
├─ YGWn	number	非必须
├─ IIPs	number	非必须
├─ WTLr	number	非必须
├─ subTitles	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ survey	object	非必须
├─ pages	object []	非必须	item 类型: object
├─ id	string	必须
├─ questions	string []	必须	item 类型: string
├─		非必须
├─ questions	object	非必须
├─ ATVb	object	非必须
├─ abnormalOptionText	null	非必须
├─ description	null	非必须
├─ fractionReverse	boolean	非必须
├─ hasAbnormalOption	boolean	非必须
├─ id	string	非必须
├─ maxValue	number	非必须
├─ minValue	number	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ relateFor	string []	非必须	item 类型: string
├─		非必须
├─ required	boolean	非必须
├─ tipsText	string []	非必须	item 类型: string
├─		非必须
├─ title	string	非必须
├─ type	string	非必须
├─ DBI1	object	非必须
├─ blank	boolean	非必须
├─ description	null	非必须
├─ id	string	非必须
├─ lastOptionFixed	boolean	非必须
├─ options	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ preLineNum	number	非必须
├─ random	boolean	非必须
├─ randomGroup	boolean	非必须
├─ randomGroupSetting	object	非必须
├─ random	boolean	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ relateFor	string []	非必须	item 类型: string
├─		非必须
├─ required	boolean	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ verticalLineNum	number	非必须
├─ JVJ4	object	非必须
├─ blank	boolean	非必须
├─ description	null	非必须
├─ exclusive	boolean	非必须
├─ id	string	非必须
├─ lastOptionFixed	boolean	非必须
├─ optionalMax	number	非必须
├─ optionalMin	number	非必须
├─ options	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ preLineNum	number	非必须
├─ random	boolean	非必须
├─ randomGroup	boolean	非必须
├─ randomGroupSetting	object	非必须
├─ random	boolean	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ relateFor	string []	非必须	item 类型: string
├─		非必须
├─ required	boolean	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ verticalLineNum	number	非必须
├─ MDNz	object	非必须
├─ id	string	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ NBDc	object	非必须
├─ blank	boolean	非必须
├─ description	null	非必须
├─ horizontalDisplay	boolean	非必须
├─ horizontalLineNum	number	非必须
├─ id	string	非必须
├─ lastOptionFixed	boolean	非必须
├─ options	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ questionLastOptionFixed	boolean	非必须
├─ questionRandom	boolean	非必须
├─ questionRandomReverse	boolean	非必须
├─ questionRelateBy	null	非必须
├─ questionRelateCondition	string	非必须
├─ random	boolean	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ required	boolean	非必须
├─ subTitles	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ title	string	非必须
├─ type	string	非必须
├─ verticalDisplay	boolean	非必须
├─ verticalLineNum	number	非必须
├─ NDXa	object	非必须
├─ description	null	非必须
├─ id	string	非必须
├─ inputMax	number	非必须
├─ inputMin	number	非必须
├─ inputRule	string	非必须
├─ inputSize	string	非必须
├─ required	boolean	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ PHZp	object	非必须
├─ description	null	非必须
├─ id	string	非必须
├─ required	boolean	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ uploadMax	number	非必须
├─ QHRu	object	非必须
├─ description	null	非必须
├─ id	string	非必须
├─ options	object []	非必须	item 类型: object
├─ children	object []	非必须	item 类型: object
├─ id	string	非必须
├─ name	string	非必须
├─ id	string	非必须
├─ name	string	非必须
├─ required	boolean	非必须
├─ subTitles	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ title	string	非必须
├─ type	string	非必须
├─ QYOm	object	非必须
├─ abnormalOptionText	null	非必须
├─ description	null	非必须
├─ fractionReverse	boolean	非必须
├─ hasAbnormalOption	boolean	非必须
├─ horizontalDisplay	boolean	非必须
├─ id	string	非必须
├─ maxValue	number	非必须
├─ minValue	number	非必须
├─ questionLastOptionFixed	boolean	非必须
├─ questionRandom	boolean	非必须
├─ questionRandomReverse	boolean	非必须
├─ questionRelateBy	null	非必须
├─ questionRelateCondition	string	非必须
├─ randomReverse	boolean	非必须
├─ required	boolean	非必须
├─ subTitles	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ tipsText	string []	非必须	item 类型: string
├─		非必须
├─ title	string	非必须
├─ type	string	非必须
├─ verticalDisplay	boolean	非必须
├─ TCGq	object	非必须
├─ description	null	非必须
├─ id	string	非必须
├─ lastOptionFixed	boolean	非必须
├─ limitNum	number	非必须
├─ options	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ random	boolean	非必须
├─ randomGroup	boolean	非必须
├─ randomGroupSetting	object	非必须
├─ random	boolean	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ required	boolean	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ XYW7	object	非必须
├─ description	null	非必须
├─ id	string	非必须
├─ lastOptionFixed	boolean	非必须
├─ options	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ preLineNum	number	非必须
├─ random	boolean	非必须
├─ randomGroup	boolean	非必须
├─ randomGroupSetting	object	非必须
├─ random	boolean	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ relateFor	string []	非必须	item 类型: string
├─		非必须
├─ required	boolean	非必须
├─ title	string	非必须
├─ type	string	非必须
├─ YBAh	object	非必须
├─ blank	boolean	非必须
├─ description	null	非必须
├─ exclusive	boolean	非必须
├─ horizontalDisplay	boolean	非必须
├─ horizontalLineNum	number	非必须
├─ id	string	非必须
├─ lastOptionFixed	boolean	非必须
├─ optionalMax	number	非必须
├─ optionalMin	number	非必须
├─ options	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ questionLastOptionFixed	boolean	非必须
├─ questionRandom	boolean	非必须
├─ questionRandomReverse	boolean	非必须
├─ questionRelateBy	null	非必须
├─ questionRelateCondition	string	非必须
├─ random	boolean	非必须
├─ randomReverse	boolean	非必须
├─ relateBy	null	非必须
├─ relateCondition	string	非必须
├─ required	boolean	非必须
├─ subTitles	object []	非必须	item 类型: object
├─ id	string	必须
├─ text	string	必须
├─ title	string	非必须
├─ type	string	非必须
├─ verticalDisplay	boolean	非必须
├─ verticalLineNum	number	非必须