Sign in

v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB
AI Summary

Get AI Summary of a WhatsApp Group

AI summary of a WhatsApp group conversation over an inclusive UTC date range of at most 7 days, plus the members who messaged in that range. Requires the Chat Summary feature to be enabled for the organization, and consumes one AI summarisation credit per generation.

get/channel/wa-group/ai-summary

Query parameters

groupIdstring required
Example:vip-support-42

The group's identifier (the clientCustomGroupId you assigned when creating the group).

startDatestring date required
Example:2026-06-15

Inclusive start of the range (UTC, day granularity).

endDatestring date required
Example:2026-06-21

Inclusive end of the range (UTC). Must be on or after startDate, and at most 7 days from it.

Response

Summary retrieved (freshly generated or served from cache).

startDatestring date-time
endDatestring date-time
chatTypestring
groupNamestring
memberCountinteger

Number of members who sent a message in the range.

chatMessagesCountinteger

Messages included in the summary (calls excluded).

callsCountinteger

Calls included in the summary.

Example response

{
  "startDate": "2026-06-15T00:00:00.000Z",
  "endDate": "2026-06-21T23:59:59.999Z",
  "chatType": "WA_GROUP",
  "groupName": "VIP Support",
  "memberCount": 2,
  "members": [
    {
      "id": "cust_a1b2c3",
      "name": "John Doe",
      "customerNumber": "15551230000"
    }
  ],
  "chatMessagesCount": 61,
  "summaries": [
    {
      "title": "Launch checklist coordinated",
      "description": "Members coordinated the go-live checklist; two blockers were raised and resolved, and the final launch time was confirmed for Friday morning."
    }
  ]
}