Request

GET /chat/v1/er8989f-2-31-d-12232-1sddss HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/chat/v1/{chatId}

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Keep-Alive: timeout=60
Connection: keep-alive

{
  "id": "5a0da3c3-4882-3352-8db9-8fc47e14111f",
  "beaconId": "ed8e9fe0-acf4-4b44-b1fc-a5bff956e7a8",
  "mailboxId": 2599,
  "createdAt": "2020-07-03T07:03:29.982028Z",
  "assignee": {
    "id": 4440,
    "type": "agent",
    "first": "Imperial",
    "last": "Guard",
    "email": "guard@imperial.com"
  },
  "customer": {
    "id": 498746,
    "type": "customer",
    "first": "Obi-wan",
    "last": "Kenobi",
    "email": "ken@obiwan.com"
  },
  "preview": "Whoa there!",
  "customFields": [
    {
      "id": 123,
      "value": "Magic"
    }
  ],
  "tags": [
    {
      "id": 3606,
      "slug": "lunatic",
      "color": "blue"
    }
  ],
  "timeline": [
    {
      "type": "page-viewed",
      "timestamp": "2020-07-03T07:08:16.982028Z",
      "url": "http://okuneva.info/et-molestiae-in-exercitationem-nihil",
      "title": "Open-architected cohesive portal"
    }
  ],
  "_embedded": {
    "events": [
      {
        "id": "80af4089-7157-3df3-b4a0-3453ad6bb244",
        "chatId": "5a0da3c3-4882-3352-8db9-8fc47e14111f",
        "type": "message",
        "action": "message-added",
        "author": {
          "id": 498746,
          "type": "customer",
          "first": "Obi-wan",
          "last": "Kenobi",
          "email": "ken@obiwan.com"
        },
        "createdAt": "2020-07-03T07:03:29.982028Z",
        "body": "Whoa there!",
        "_links": {
          "author": {
            "href": "..."
          }
        }
      },
      {
        "id": "2427d95b-7a4e-3be4-b8a6-a6ce89b5a7e2",
        "chatId": "5a0da3c3-4882-3352-8db9-8fc47e14111f",
        "type": "line_item",
        "action": "chat-accepted",
        "author": {
          "id": 4440,
          "type": "user",
          "first": "Imperial",
          "last": "Guard",
          "email": "guard@imperial.com"
        },
        "createdAt": "2020-07-03T07:03:59.982028Z",
        "_links": {
          "author": {
            "href": "..."
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "..."
    },
    "customer": {
      "href": "..."
    },
    "assignee": {
      "href": "..."
    }
  }
}

Response fields

Path Type Description
id String Unique identifier
beaconId String The ID of the Beacon the chat was initiated from
mailboxId Number The ID of the mailbox the chat was created in
createdAt String The ISO8601 timestamp when the chat was created
assignee Object The user assigned to the chat
customer Object The customer which initiated the chat
preview String A preview of the first chat message
customFields Array Custom field values
tags Array Tag values
timeline Array Timeline values
_embedded.events Array Event values

Event object

Path Type Description
id String Unique identifier
type String The type of the event
action String The action type
author Object The author of the event, either a user, customer or system
createdAt String The ISO8601 timestamp of when the event was created
body String The event body

Custom field object

Path Type Description
id Number Custom field’s unique ID
value String Custom field’s value. The value type depends on custom field type. It contains an option ID for the dropdown custom field type for example.

Tag object

Path Type Description
id Number Tag’s unique ID
color String The tag color
slug String The tag slug

Timeline object

Path Type Description
type String The timeline event type
timestamp String The ISO8601 timestamp for the event
url String The URL of the page the Beacon was on
title String The title of the page the Beacon was on
Relation Description
assignee The user the chat is assigned to
customer The customer of the chat
↑Back to top
© Help Scout 2024