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]
  
  Hide data attributes Show data attributes object
  
  id_message integer
  
  date_insert string(date-time)
  
  author object
  
  Additional properties are allowed.
  
  Hide author attributes Show author attributes object
  
  id_ambassador integer(int32)
  
  image string
  
  firstname string
  
  lastname string
  
  username string
  
  email string
  
  email_tmp string
  
  active integer(int32)
  
  status integer(int32)
  
  online boolean
  
  true: when last_action_date is less than 5 minutes ago
  
  last_action_date string(date-time)
  
  customer_id string
  
  anonymized boolean
  
  content string
  
  type_message integer
  
  0: text, 1: picture, 2: rating, 3: product, 4: connection, 5: request, 6: unavailable, 7: video, 8: email, 9: missed
  
  status_moderation integer
- 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 \
 -X GET https://domain.tld/api/v2/chat/chatrooms/{chatroom}/messages \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "X-Popsell-Brand: 42"

Response examples (200)

{
  "current_page": 42,
  "data": [
    {
      "id_message": 16,
      "date_insert": "2023-10-09T12:12:40.220000Z",
      "author": {
        "id_ambassador": 42,
        "image": "string",
        "firstname": "string",
        "lastname": "string",
        "username": "string",
        "email": "string",
        "email_tmp": "string",
        "active": 42,
        "status": 42,
        "online": true,
        "last_action_date": "2024-05-04T09:42:00+00:00",
        "customer_id": "string",
        "anonymized": true
      },
      "content": "super",
      "type_message": 2,
      "status_moderation": 0
    }
  ],
  "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."
}