Get communication customization order detail interface

Get communication customization order details interface

Get detailed information of communication customization order, including order status, communication records, etc.

Points to note

The interface uses the GET method and does not require the submission of request body data
Return complete order information and communication records

Request address

{域名地址}/api/communication/order/detail

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

Request Syntax

GET {域名地址}/api/communication/order/detail

Request Headers

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

Request parameters

Field name	Type	Required	Description
id	int	Is	Communication order ID

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	Order details data

Data result parameter

Field name	Type	Description
id	int	Communication order ID
order_id	int	Order ID
user_id	int	User ID
created_time	int	Timestamp of creation
archive_id	int	Document ID
phone	string	Mobile number
Images	string array	Image List
Sketch Images	string array	Draft Image List
Finished Images	string array	Completed Image List
Title	string	Order Title
content	string	Order Content
Event Date	string	Time
status	int	Status, progress: 0=Pending, 1=In communication, 2=Quotation submitted pending customer confirmation, 3=Quotation accepted, -1=Cancelled, 4=Quotation refused
admin_id	int	Admin ID
quote_price	string	Quotation Price
quote_content	string	Quotation Content
order_extra	object	additional_order_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	int	Communication Record ID
comm_order_id	int	Communication order ID
sender_id	int	sender ID
sender type	string	User type, user or admin or system
Sender name	string	Sender's name
Message type	string	Communication record type, text, image, quote, video, file, audio, location, contact, sticker, unknown
content	string	Communication record content

Usage Example

Request example

GET /api/communication/order/detail?id=123 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": "您好，我想定制一个外贸网站主题"
      },
      {
        "id": 2,
        "comm_order_id": 123,
        "sender_id": 1,
        "sender_type": "admin",
        "sender_name": "admin",
        "message_type": "quote",
        "content": "根据您的需求，定制开发费用为9900元，包含基础功能和后期维护3个月"
      }
    ],
    "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	Not authorized
200	API request OK