Conversations

Get contact messages

Contacts may have conversations, which include messages from the contact as well as messages to the contact from chat operators or chatbots. You can list the complete conversation for a particular contact.

get/contacts/{contactId}/messages

Request

  • Base URL
    https://api.tidio.com
  • URL
    https://api.tidio.com/contacts/{contactId}/messages
  • Auth
    API key in header X-Tidio-Openapi-Client-Id and API key in header X-Tidio-Openapi-Client-Secret

Path parameters

contactIdstring uuid required

ID of the contact

Example:a1b4ca4c-1108-4432-b256-1e4cf2bf6f9e

Query parameters

cursorstring
Example:aWRfX2U2YTgyYTc0LTExNzAtNGY1Ny1hMDMxLWIzNmYzZjZiYzA5Mw==

Value from the previous page. Use null to fetch the first one

Response

Paginated list of messages

conversation_urlstring uri nullable

URL to view the conversation in Tidio panel

Example response

{
  "messages": [
    {
      "id": "ad59e7ea-cd20-42b9-8c7b-f44d0ed9241e",
      "author_type": "contact",
      "author_id": "3a7439a0-e939-4d8f-847c-be87197f2330",
      "message": "Hi! I need help with my order.",
      "created_at": "2023-01-01T00:00:00+00:00"
    }
  ],
  "conversation_url": "https://tidio.com/panel/conversations/12345",
  "meta": {
    "cursor": "aWRfX2U2YTgyYTc0LTExNzAtNGY1Ny1hMDMxLWIzNmYzZjZiYzA5Mw==",
    "limit": 1000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.