Skip to content
JawibDocumentationWHATSAPP API · v2
Documentation/Groups and receipts

Groups and receipts

Retrieve the internal group ID from GET groups. The ID used in API paths is a Jawib identifier, rather than a WhatsApp group JID. Enable group_inbox_enabled before reading group content, media, or participant receipts.

Replies and mentions

Set reply_to to a retained WhatsApp message_id from the same chat. For mentions, provide member JIDs in mentions, using a phone-based JID or LID returned by WhatsApp. Jawib validates group membership where available.

{
  "type": "text",
  "text": "Confirmed. Thank you!",
  "reply_to": "WHATSAPP_MESSAGE_ID",
  "mentions": ["249900000000@s.whatsapp.net"]
}

Reactions

Send a reaction through the same group-message endpoint. Use an empty string or null for emoji to remove your number's reaction:

{
  "type": "reaction",
  "reaction_to": "WHATSAPP_MESSAGE_ID",
  "emoji": "👍"
}

Replies and reactions require the relevant content-read scope and enabled capture. The original message must be retained and unexpired in the same chat.

Participant receipts

The receipt endpoint reports observed delivery, read, and playback events per participant, according to the message type and events received from WhatsApp. meta.complete is always false: results are observations, not a complete membership-wide delivery guarantee.

An absent read receipt does not prove that a participant has not read the message. Jawib cannot force WhatsApp to provide an unavailable receipt. A successful send does not mean that every group member received it.

Use signed group.message.receipt webhooks for updates to existing participant rows. Maintain separate cursors for each group's message history.

Group media downloads

GET /api/v2/groups/{group}/messages/{groupMessage}/media
Authorization: Bearer JAWIB_API_KEY

Requires groups:media:read and returns a file. Download it through your backend. Group sending supports text, image, audio, video, document, and reaction messages; OTP is not supported.

List groups

GET/api/v2/groups
Key owner: Customer or direct companyRequired scope: groups:read
curl --request GET "https://playjawib.com/api/v2/groups" \
  --header "Authorization: Bearer $JAWIB_API_KEY" \
  --header 'Accept: application/json'
Response example 200
{
    "data": [],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "total": 0
    }
}

Illustrative values. Use the actual identifiers and credentials returned by your request.

Send a group message

POST/api/v2/groups/{group}/messages
Key owner: Customer or direct companyRequired scope: messages:write + groups:write

Replace {group} with the actual IDs returned by the API.

curl --request POST "https://playjawib.com/api/v2/groups/{group}/messages" \
  --header "Authorization: Bearer $JAWIB_API_KEY" \
  --header 'Accept: application/json' \
  --header 'Idempotency-Key: unique-operation-123' \
  --header 'Content-Type: application/json' \
  --data '{
    "connection_id": "CONNECTION_UUID",
    "type": "text",
    "text": "Hello, everyone"
}'
Request body fields
FieldTypeDescription
typerequiredstringtext / image / audio / video / document / reaction
textstring—
captionstring—
media_urlstring—
mediastring—
filenamestring—
voice_notebooleanOnly for audio. true sends PTT and requires a valid mono OGG/Opus stream. No transcoding. Incoming content resources/webhooks also expose voice_note.
Response example 202
{
    "data": {
        "id": "019c0000-0000-7000-8000-000000000003",
        "destination_type": "group",
        "group_id": "123",
        "receipt_scope": "observed_participants",
        "type": "text",
        "voice_note": false,
        "status": "sent",
        "failure_code": null,
        "sent_at": "2026-10-29T09:00:00+00:00",
        "delivered_at": null,
        "read_at": null,
        "failed_at": null,
        "expires_at": "2026-11-28T09:00:00+00:00"
    }
}

Illustrative values. Use the actual identifiers and credentials returned by your request.

List group messages

GET/api/v2/groups/{group}/messages
Key owner: Customer or direct companyRequired scope: groups:messages:read

Replace {group} with the actual IDs returned by the API.

curl --request GET "https://playjawib.com/api/v2/groups/{group}/messages" \
  --header "Authorization: Bearer $JAWIB_API_KEY" \
  --header 'Accept: application/json'
Response example 200
{
    "data": [],
    "next_after_id": null
}

Illustrative values. Use the actual identifiers and credentials returned by your request.

List participant receipts

GET/api/v2/groups/{group}/sent-messages/{message}/receipts
Key owner: Customer or direct companyRequired scope: groups:receipts:read

Replace {group}, {message} with the actual IDs returned by the API.

curl --request GET "https://playjawib.com/api/v2/groups/{group}/sent-messages/{message}/receipts" \
  --header "Authorization: Bearer $JAWIB_API_KEY" \
  --header 'Accept: application/json'
Response example 200
{
    "data": [],
    "meta": {
        "message_id": "019c0000-0000-7000-8000-000000000003",
        "scope": "observed_participants",
        "complete": false,
        "observed_participants": 0,
        "delivery_confirmed": 0,
        "read_confirmed": 0,
        "played": 0
    },
    "next_after_id": null
}

Illustrative values. Use the actual identifiers and credentials returned by your request.

Jawib API documentationAPI v2 · HTTPS / JSON
Search guides and API endpoints · Press Esc to close