WhatsApp messaging

Retrieve a chat

Retrieves the chat with the given ID.

get/admin/messengers/whatsapp-chats/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/messengers/whatsapp-chats/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the chat.

Response

idnumber required

Chat ID

customer_idnumber

Customer ID

assign_idnumber

Admin ID

phonestring required

Phone number

profile_namestring

Profile name

activeboolean required

Active status

is_blockedboolean

Whether the chat is blocked

is_marketing_blockedboolean

Whether marketing messages are blocked for this chat

created_atstring required

Datetime

blocked_atstring

Datetime when chat was blocked

new_messagesnumber

Number of unread messages

Example response

{
  "id": 1,
  "customer_id": 1,
  "assign_id": 1,
  "phone": "420123456879",
  "profile_name": "John Doe",
  "active": false,
  "is_blocked": false,
  "is_marketing_blocked": false,
  "created_at": "2023-12-04 05:45:02",
  "blocked_at": "",
  "new_messages": 0
}

Changes

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