Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
"""Labels resource — WhatsApp Business chat labels.
Backed by ``src/modules/label/label.controller.ts``
(``@Controller('sessions/:sessionId/labels')``). Labels are a WhatsApp Business
feature; the session must be a business account.
"""
from __future__ import annotations
from typing import List, TYPE_CHECKING
from .._http import quote_segment
from ..types import AddLabelRequest, ChatSummary, LabelRecord, SuccessResult, UpsertLabelRequest
if TYPE_CHECKING:
from .._http import HttpExecutor
class LabelsResource:
def __init__(self, http: "HttpExecutor") -> None:
self._http = http
def list(self, session_id: str) -> List[LabelRecord]:
"""List all labels available in the business account. whatsapp-web.js only; Baileys answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/labels")
def get(self, session_id: str, label_id: str) -> LabelRecord:
"""Get a single label by id. whatsapp-web.js only; Baileys answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/labels/{quote_segment(label_id)}")
def chats(self, session_id: str, label_id: str) -> List[ChatSummary]:
"""Every chat carrying a label.
whatsapp-web.js only -- Baileys has label writes but no label query of any kind, and
answers 501.
"""
return self._http.request(
"GET", f"/api/sessions/{quote_segment(session_id)}/labels/{quote_segment(label_id)}/chats"
)
def upsert(self, session_id: str, label_id: str, body: UpsertLabelRequest) -> SuccessResult:
"""Create or update a label. Baileys only; whatsapp-web.js answers 501.
PUT rather than POST because you choose the id: WhatsApp carries one write keyed on it, so
whether this creates or updates depends purely on whether that id already exists. Pick an
unused id to create -- reusing one rewrites that label rather than failing. The write
replaces the whole label, so an omitted field is not preserved.
"""
return self._http.request(
"PUT", f"/api/sessions/{quote_segment(session_id)}/labels/{quote_segment(label_id)}", body=body
)
def delete(self, session_id: str, label_id: str) -> SuccessResult:
"""Delete a label; it disappears from every chat it was on. Baileys only."""
return self._http.request(
"DELETE", f"/api/sessions/{quote_segment(session_id)}/labels/{quote_segment(label_id)}"
)
def for_chat(self, session_id: str, chat_id: str) -> List[LabelRecord]:
"""Get the labels currently applied to a chat. whatsapp-web.js only; Baileys answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/labels/chat/{quote_segment(chat_id)}")
def add_to_chat(self, session_id: str, chat_id: str, body: AddLabelRequest) -> SuccessResult:
"""Add a label to a chat. Requires an OPERATOR-level key."""
return self._http.request("POST", f"/api/sessions/{quote_segment(session_id)}/labels/chat/{quote_segment(chat_id)}", body=body)
def remove_from_chat(self, session_id: str, chat_id: str, label_id: str) -> SuccessResult:
"""Remove a label from a chat. Requires an OPERATOR-level key."""
return self._http.request(
"DELETE", f"/api/sessions/{quote_segment(session_id)}/labels/chat/{quote_segment(chat_id)}/{quote_segment(label_id)}"
)