提交表单 API

提交数据至表单，使用 POST 发起请求，请求地址为 /api/v1/forms，此接口可以直接访问，无需身份验证。

POST /api/v1/forms

请求 URI

参数名	位置	类型	必填	说明
siteId	query	整数	是	站点 Id
channelId	query	整数	否	栏目 Id
contentId	query	整数	否	内容 Id
formId	query	整数	否	表单 Id
formName	query	字符串	否	表单名称

请求 URI 可以通过传递 formId 表单 Id 确定需要提交的表单，也可以通过传递 formName 表单名称确定需要提交的表单。

channelId 栏目 Id 以及 contentId 内容 Id 为可选项，用于将表单数据与栏目/内容关联。

请求 Body

请求 Body 需要以 JSON 的格式传递表单字段的名称/值，如：

{
  "name": "姓名",
  "mobile": "13888888888",
  "email": "test@sample.com",
  "content": "留言"
}

其中具体字段名称需要与表单的字段名称一致并以采用驼峰拼写（第一个字母必须小写）：

返回

名称	类型	说明
200 OK	FormData	表单数据
400 BadRequest	Error	参数错误

示例

请求示例

POST /api/v1/forms?siteId=1&formName=表单名称
Content-Type: application/json

{
  "name": "姓名",
  "mobile": "13888888888",
  "email": "test@sample.com",
  "content": "留言"
}

返回示例

{
    "name": "姓名",
    "mobile": "13888888888",
    "email": "test@sample.com",
    "content": "留言",
    "siteId": 1,
    "channelId": 0,
    "contentId": 0,
    "formId": 2,
    "isReplied": false,
    "replyDate": null,
    "replyContent": null,
    "id": 3,
    "guid": "50a30a10-dc93-4043-9177-63909d2e6249",
    "createdDate": "2023-11-16 11:01:39",
    "lastModifiedDate": "2023-11-16 11:01:39"
}