form

Documentation

Overview

Package form 表单组件API

Index

• func Create(clt *core.SDKClient, accessToken string, req *form.CreateRequest) (uint64, error)
• func Delete(clt *core.SDKClient, accessToken string, req *form.DeleteRequest) (bool, error)
• func Detail(clt *core.SDKClient, accessToken string, req *form.DetailRequest) (*form.Form, error)
• func List(clt *core.SDKClient, accessToken string, req *form.ListRequest) (*form.ListResponseData, error)
• func Update(clt *core.SDKClient, accessToken string, req *form.UpdateRequest) (uint64, error)

Functions

func Create

func Create(clt *core.SDKClient, accessToken string, req *form.CreateRequest) (uint64, error)

Create 创建表单 本接口用于创建表单，主要包括以下信息的设置： - 基础信息模块

• 包含表单名称，不会在C端体现出来

- 表单元素配置

• 对应FormElement
• 支持添加多种类型元素：姓名、电话、邮箱、数值、性别、日期、城市、自定义文本、多文本

- 分层表单

• 分层内部的元素同样对应elements
• 结合字段：enable_layer + layer_submit_text

- 验证类型配置

• validate_type字段，主要指C端是否进行短信验证
• 当表单含有电话类型字段才生效

- 高级设置

• 高级设置属于扩展功能，目前主要包含三项内容：
• 计数设置
• 包含递增和递减两种类型
• 基于计数前文案+计数值+计数后文案拼接完整方案
• 展示报名用户：
• 包含滚动墙和滚动条两种类型
• 基于已提交用户信息展示数据
• 提交成功提示语：
• 商家端额外通知用户的信息，如“24h内联系您“

func Delete

func Delete(clt *core.SDKClient, accessToken string, req *form.DeleteRequest) (bool, error)

Delete 删除表单 本接口可进行表单的删除，删除后获取表单列表时默认不获取，但是仍能通过表单实例id获取表单详情，is_del状态变为1。 注：对于当日产生了线索数据的表单不支持删除，会报错：message：has clues today

func Detail

func Detail(clt *core.SDKClient, accessToken string, req *form.DetailRequest) (*form.Form, error)

Detail 获取表单详情 本接口用于获取青鸟线索通表单详情，可基于instance_id查询（instance_id唯一表示一个表单，可通过创建表单返回值中获取，也可从获取表单列表中获得），可获得表单配置的详细信息，不包含线索统计数据。

func List

func List(clt *core.SDKClient, accessToken string, req *form.ListRequest) (*form.ListResponseData, error)

List 获取表单列表 本接口用于获取青鸟线索通表单列表，可根据时间和表单实例id等条件进行过滤，本接口仅获取表单等基本信息，需要详细信息需调用【获取表单详情】接口。

func Update

func Update(clt *core.SDKClient, accessToken string, req *form.UpdateRequest) (uint64, error)

Update 更新表单 本接口用于表单的更新修改，主要可更新如下： - 基础信息模块

• 包含表单名称，不会在C端体现出来

- 分层表单

• 分层内部的元素同样对应elements
• 结合字段：enable_layer + layer_submit_text

- 高级设置

• 高级设置属于扩展功能，目前主要包含三项内容：
• 计数设置
• 包含递增和递减两种类型
• 基于计数前文案+计数值+计数后文案拼接完整方案
• 展示报名用户：
• 包含滚动墙和滚动条两种类型
• 基于已提交用户信息展示数据
• 提交成功提示语：
• 商家端额外通知用户的信息，如“24h内联系您“ 支持增量更新，目前不支持elements模块的修改。