Get the list information of user communication customization orders, supporting pagination query.
Precautions
- This interface uses the GET method and does not require the submission of request body data
- Access requires user login
- Return all communication customization orders of the current user
- Supports pagination queries, can specify the current page number and number of items per page
Request address
{域名地址}/api/communication/orders
Description:{域名地址}Need to replace it with your domain address, such ashttps://en.anqicms.com/api/communication/orders
Request syntax
GET {域名地址}/api/communication/orders
Request header
This interface also involves common request headers. For more information, please seeCommon Request Headers (Common Request Headers).
Request Parameters
| Field Name |
Type |
Required |
Description |
| Current |
integer |
No |
Current page number, default is 1 |
| page_size |
integer |
No |
Number of items per page, default is 10 |
Response Headers
This interface only involves public response headers. More information, please refer toCommon Request Headers (Common Request Headers).
Return parameters
| Field Name |
Type |
Description |
| code |
integer |
Error code |
| message |
string |
Error Description |
| data |
object[] |
Order List Data |
data result item parameter
| Field Name |
Type |
Description |
| id |
integer |
Communication Order ID |
| order_id |
integer |
Order ID |
| user_id |
integer |
User ID |
| created_time |
integer |
Creation Timestamp |
| archive_id |
integer |
Document ID |
| phone |
string |
Phone Number |
| images |
string array |
Image list |
| Sketch images |
string array |
Draft image list |
| Finished images |
string array |
Complete Image List |
| Title |
string |
Order Title |
| content |
string |
Order Content |
| event_date |
string |
Time |
| status |
integer |
Status, progress: 0=Pending, 1=In communication, 2=Quotation submitted waiting for customer confirmation, 3=Quotation accepted, -1=Cancelled, 4=Quotation rejected |
| admin_id |
integer |
admin ID |
| quote price |
string |
quotation price |
| quote content |
string |
quotation content |
| order_extra |
object |
Order Additional Information |
| order_fields |
object[] |
Order Field Information |
| user |
object |
User Information |
| messages |
object[] |
communication record |
| Thumbnail |
string |
Thumbnail |
messages communication record parameters
| Field Name |
Type |
Description |
| id |
integer |
Communication record ID |
| comm_order_id |
integer |
Communication Order ID |
| sender_id |
integer |
sender_id |
| sender_type |
string |
sender_type, user or admin or system |
| sender_name |
string |
Sender Name |
| Message Type |
string |
Communication record type, text, image, quote, video, file, audio, location, contact, sticker, unknown |
| content |
string |
communication record content |
Example Usage
Request Example
GET /api/communication/orders HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json
request example (pagination query)
GET /api/communication/orders?current=1&page_size=5 HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json
Response Example
{
"code": 0,
"msg": "",
"data": [
{
"id": 123,
"order_id": 456,
"user_id": 1000,
"created_time": 1669212548,
"archive_id": 188,
"phone": "13888888888",
"images": [
"https://en.anqicms.com/uploads/image1.jpg",
"https://en.anqicms.com/uploads/image2.jpg"
],
"sketch_images": [],
"finished_images": [],
"title": "定制网站主题",
"content": "需要定制一个响应式的外贸网站主题,包含多语言功能",
"event_date": "2023-12-31",
"status": 2,
"admin_id": 1,
"quote_price": "9900",
"quote_content": "根据您的需求,定制开发费用为9900元,包含基础功能和后期维护3个月",
"order_extra": {
"delivery_time": "2023-12-31",
"requirement": "需要支持中英文切换"
},
"order_fields": [],
"user": {
"id": 1000,
"username": "testuser"
},
"messages": [
{
"id": 1,
"comm_order_id": 123,
"sender_id": 1000,
"sender_type": "user",
"sender_name": "testuser",
"message_type": "text",
"content": "您好,我想定制一个外贸网站主题"
}
],
"thumb": "https://en.anqicms.com/uploads/thumb.jpg"
}
]
}
Error Code
| Error code |
Description |
| 0 |
OK |
| -1 |
Error, the reason is indicated in msg |
| 1001 |
Not logged in |
| 1002 |
Unauthorized |
| 200 |
API request OK |