WhatsApp Chat

WhatsApp Chat

Get WhatsApp chat list

get

Fetches a list of WhatsApp consumer phone numbers and their latest messages, along with unread message counts.

Responses

200

Chat List Fetched Successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Chat List Fetched Successfully

get

/api/whatsapp/chat-list

HTTPcURLJavaScriptPython

GET /api/whatsapp/chat-list HTTP/1.1
Accept: */*

200

Chat List Fetched Successfully

{
  "success": true,
  "message": "Chat List Fetched Successfully",
  "data": [
    {
      "phone_number_id": 1,
      "phone_number": "[phone]",
      "unread_notifications_count": 3,
      "last_message": "Hello there!",
      "last_message_type": "text",
      "timestamp": 1727274362
    }
  ]
}

Get all WhatsApp chat messages

get

Fetches all chat messages for a specified phone number.

Path parameters

phone_number_idintegerRequired

The ID of the phone number for which to fetch messages

Responses

200

Chat Messages Fetched Successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Chat Messages Fetched Successfully

get

/api/whatsapp/chat-messages/{phone_number_id}

HTTPcURLJavaScriptPython

GET /api/whatsapp/chat-messages/{phone_number_id} HTTP/1.1
Accept: */*

200

Chat Messages Fetched Successfully

{
  "success": true,
  "message": "Chat Messages Fetched Successfully",
  "data": [
    {
      "id": "wamid.HBgMMjAxMTI2MjIwODA2FQIAERgSQ0U3MzEyQTQyMUY0OTRGMjVEAA==",
      "whatsapp_phone_number_id": 108427225641466,
      "sender_type": "App\\\\Models\\\\WhatsappPhoneNumber",
      "sender_id": 108427225641466,
      "recipient_type": "App\\\\Models\\\\WhatsappConsumerPhoneNumber",
      "recipient_id": 1,
      "sender_role": "BUSINESS",
      "type": "text",
      "direction": "SENT",
      "status": "initiated",
      "created_at": "2024-09-25T14:26:02.000000Z",
      "updated_at": "2024-09-25T14:26:02.000000Z"
    }
  ]
}

Soft Delete a WhatsApp message

delete

Soft deletes a specific WhatsApp message using the provided message ID.

Path parameters

whatsappMessageIDstringRequired

The ID of the WhatsApp message to be deleted

Responses

200

Message soft deleted successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Message soft deleted successfully

404

Message not found

application/json

delete

/api/whatsapp/delete-message/{whatsappMessage}

HTTPcURLJavaScriptPython

DELETE /api/whatsapp/delete-message/{whatsappMessage} HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Message soft deleted successfully"
}