Get Communication Custom Order Communication Information List Interface

Retrieve the communication record list of a specified communication customization order, supporting pagination query.

Precautions

  • This interface uses the GET method and does not require the submission of request body data
  • Access requires user login
  • Can only retrieve communication records belonging to the current user's orders
  • Supports pagination queries, can specify the current page number and number of items per page

Request address

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

Description:{域名地址}Need to replace it with your domain address, such ashttps://en.anqicms.com/api/communication/messages

Request syntax

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

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
comm_order_id integer Yes Communication Order ID
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[] Communication record list data

data result item parameter

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/messages?comm_order_id=123 HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

request example (pagination query)

GET /api/communication/messages?comm_order_id=123&current=1&page_size=5 HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

Response Example

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "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": "image",
      "content": "https://en.anqicms.com/uploads/quote_image.jpg"
    },
    {
      "id": 3,
      "comm_order_id": 123,
      "sender_id": 1,
      "sender_type": "admin",
      "sender_name": "admin",
      "message_type": "quote",
      "content": "根据您的需求,定制开发费用为9900元,包含基础功能和后期维护3个月"
    }
  ]
}

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