BObookingexperts
Conversation messages

GET messages

Returns messages of the administration

get/v3/administrations/{administration_id}/conversations/{conversation_id}/messages

Request

Path parameters

administration_idstring required

Administration ID

conversation_idstring required

Conversation ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id

fields[conversation]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[rid]string

Filter on rid

filter[is_open]string

Filter on is_open

filter[booking]string

Filter on booking. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

ConversationsMessageCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "conversations_message",
      "relationships": {
        "conversation": {
          "data": {
            "type": "conversation"
          }
        },
        "attachments": {
          "data": [
            {
              "type": "conversations_messages_attachment"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "conversation",
      "relationships": {
        "booking": {
          "data": {
            "type": "booking"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.