Get a chat

GET/v1/chats/{chat}

Reads one chat, including its live customer-window state. A chat id that is not this key’s answers 404 — the same answer an id that does not exist gets, because a response must never confirm one across accounts.

Path ParametersExpand Collapse

chat: string

ReturnsExpand Collapse

Chat object { id, created_at, customer, 4 more }

One customer conversation.

id: string

The chat’s id.

created_at: string

formatdate-time

customer: string

Customer address as an opaque identifier.

customer_window: object { expires_at, state, source }

The customer service window — first-class state on every chat read. Only template parts are sendable while it is closed.

expires_at: string

When the open window expires. null when no window has ever opened.

formatdate-time

state: string

open or closed.

source: optional string

What opened the current window: customer_message, or free_entry_point for ad-sourced windows. Absent when no window has ever opened.

phone_number_id: string

The id of the sending number this chat is pinned to.

updated_at: string

When the chat last changed — a new event moves it.

formatdate-time

from: optional string

The number this conversation sends from, in E.164 (leading +). This is the value to pass back as a send’s from to address this exact conversation. Absent only if the number is no longer one of yours.

Get a chat

curl https://whatsapp.messages.api.linqapp.com/v1/chats/$CHAT \
    -H "Authorization: Bearer $LINQ_WHATSAPP_API_KEY"

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "customer": "customer",
  "customer_window": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "state": "state",
    "source": "source"
  },
  "phone_number_id": "phone_number_id",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "from": "from"
}

Returns Examples

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "customer": "customer",
  "customer_window": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "state": "state",
    "source": "source"
  },
  "phone_number_id": "phone_number_id",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "from": "from"
}