Get communication customization order field interface

Get information about the available custom fields for communication custom orders, which are used to provide form fields when creating communication custom orders.

Points to note

The interface uses the GET method and does not require the submission of request body data
Access without login is possible
Return all available configuration fields for communication custom orders
Include field name, type, and whether it is required information

Request address

{域名地址}/api/communication/fields

Description:{域名地址}Replace it with your domain name, such ashttps://en.anqicms.com/api/communication/fields

Request Syntax

GET {域名地址}/api/communication/fields

Request Headers

This interface also involves common request headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Request parameters

None

Response header

This interface only involves public response headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Return parameters

Field name	Type	Description
code	int	Error code
msg	string	Error description
data	object[]	Field list data

data result item parameter

Field name	Type	Description
name	string	Form Field Display Name
field_name	string	Form Field Invocation Name
type	string	Form type: text (text), number (number), textarea (multi-line text), radio (single choice), checkbox (multiple choice), select (drop-down selection), image (image), file (file)
required	boolean	Is required, true means required, false means optional
content	string	Form default value

Usage Example

Request example

GET /api/communication/fields HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

Response Example

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "name": "交付时间",
      "field_name": "delivery_time",
      "type": "text",
      "required": true,
      "content": ""
    },
    {
      "name": "特殊要求",
      "field_name": "special_requirement",
      "type": "textarea",
      "required": false,
      "content": "请详细描述您的特殊要求"
    },
    {
      "name": "预算范围",
      "field_name": "budget_range",
      "type": "select",
      "required": true,
      "content": "5000-10000,10000-20000,20000-50000"
    },
    {
      "name": "是否需要后期维护",
      "field_name": "maintenance_required",
      "type": "radio",
      "required": false,
      "content": "是,否"
    }
  ]
}

error code

Error code	Description
0	OK
-1	Error, the reason is indicated in msg
1001	Not logged in
1002	Not authorized
200	API request OK