获取收集表信息 - 文档 - 企业微信开发者中心

服务商代开发

快速入门服务端API 客户端API 附录更新日志联系我们

服务商代开发

服务端API

文档

管理收集表

获取收集表信息

最后更新：2023/03/15

该接口用于读取收集表的信息

请求方式：POST（HTTPS）
请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/get_form_info?access_token=ACCESS_TOKEN

请求包体

{
    "formid":"FORMID"
}

参数说明

参数	类型	是否必须	说明
formid	string	是	操作的收集表ID

权限说明

自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用（accesstoken如何获取？）
第三方应用需具有“文档”权限
代开发自建应用需具有“文档”权限
只能操作该应用创建的文档

返回示例

{
    "errcode":0,
    "errmsg":"ok",
    "form_info":{
        "formid":"FORMID1",
        "form_title":"api创建的收集表_周期",
        "form_desc":"这是描述",
        "form_header":"URL",
        "form_question":{
            "items":[
                {
                    "question_id":1,
                    "title":"问题1",
                    "pos":1,
                    "status":1,
                    "reply_type":1,
                    "must_reply":true,
                    "note":"问题备注1",
                    "placeholder":"提示1"
                },
                {
                    "question_id":2,
                    "title":"问题2",
                    "pos":2,
                    "status":1,
                    "reply_type":2,
                    "must_reply":false,
                    "note":"问题备注2",
                    "option_item":[
                        {
                            "key":1,
                            "value":"A",
                            "status":1
                        },
                        {
                            "key":2,
                            "value":"B",
                            "status":1
                        },
                        {
                            "key":3,
                            "value":"C",
                            "status":1
                        }
                    ],
                    "placeholder":"提示2"
                }
            ]
        },
        "form_setting":{
            "fill_out_auth":1,
            "fill_in_range":{
                "departmentids":[
                    1
                ],
                "userids": [
                    "USERID1",
                    "USERID2"
            },
            "setting_manager_range":{
                "userids":[
                    "USERID1",
                    "USERID2"
                ]
            },
            "timed_repeat_info":{
                "enable":true,
                "remind_time":1668389400,
                "rule_ctime":1668418140,
                "rule_mtime":1668418140,
                "repeat_type":1,
                "skip_holiday":false
            },
            "allow_multi_fill":false,
            "timed_finish":0,
            "can_anonymous":false,
            "can_notify_submit":true
        },
        "repeated_id":[
            "REPEAT_ID1"
        ]
    }
}

参数说明

参数	类型	说明
errcode	int32	错误码
errmsg	string	错误码说明
form_info	object	收集表信息
formid	string	收集表id
form_title	string	收集表标题
form_desc	string	收集表描述
form_header	string	收集表表头背景图链接
form_question	object	收集表的问题列表
form_setting	object	收集表的设置
repeated_id	string[]	收集表的周期id，用于获取答案列表和具体的回答