Get all messages of a chatroom

GET /chat/chatrooms/{chatroom}/messages

Bearer token

Headers

X-Popsell-Brand integer Required

The id of the target brand

Path parameters

chatroom integer Required

The chatroom id

Query parameters

sort string

Sort messages by one of the following fields

Value is date_insert.
filter[sent_before] string

Retrieve messages sent before a date
filter[active] boolean

Retrieve active messages
filter[type_message] string

Retrieve messages by type

Responses

200 application/json

Returns the messages of a chatroom
Hide response attributes Show response attributes object
- current_page integer(int32)
- data array[object]
  
  Additional properties are allowed.
- first_page_url string
- from integer(int32)
- last_page integer(int32)
- last_page_url string
- links array[object]
  
  Hide links attributes Show links attributes object
  
  url string(nullable)
  
  label string
  
  active boolean
- next_page_url string
- path string
- per_page integer(int32)
- prev_page_url string(nullable)
- to integer(int32)
- total integer(int32)
401 application/json

Unauthorized.
Hide response attribute Show response attribute object
- message string
403

Forbidden - You don't have permission to access this route

GET /chat/chatrooms/{chatroom}/messages

curl \
 --request GET 'https://domain.tld/api/v2/chat/chatrooms/{chatroom}/messages' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-Popsell-Brand: 42"

Response examples (200)

{
  "current_page": 42,
  "data": [
    {}
  ],
  "first_page_url": "string",
  "from": 42,
  "last_page": 42,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 42,
  "prev_page_url": "string",
  "to": 42,
  "total": 42
}

Response examples (401)

{
  "message": "Unauthorized."
}