Get Chat List

Get Chat List

GET https://api.wapim.io/api/v1/whatsapp/chatllist

Query Parameters

Name	Type	Description
page	String	Page of chat
all	String	true | If ?all=true all chats returned and the page parameter is ignored.

Headers

Name	Type	Description
Token*	String	YOUR_WAPIM_TOKEN

200: OK

{
    "data": [
      {
        "chat_id": "1203630406***",
        "unreadCount": 819,
        "name": "CE Log**",
        "left": false,
        "conversationTimestamp": 1676***,
        "notSpam": true,
        "archived": false,
        "pinned": false,
        "deleted": false,
        "muteEndTime": 0,
        "unreadMentionCount": 0,
        "isGroup": true,
        "message": {
          "event_name": "TextMessage",
          "message_id": "3EB0D67***",
          "text": "***",
          "from_phone_number": "****",
          "to_phone_number": "****",
          "chat_id": "1203630406***",
          "timestamp": 1676***,
          "from_me": false,
          "is_group": true,
          "instance_id": "436e6b56-d25f-****",
          "phone_id": "****"
        }
      },
      {
        "chat_id": "****",
        "unreadCount": 0,
        "conversationTimestamp": 167****,
        "notSpam": true,
        "archived": false,
        "pinned": false,
        "deleted": false,
        "muteEndTime": 0,
        "unreadMentionCount": 0,
        "isGroup": false,
        "message": {
          "event_name": "TextMessage",
          "message_id": "3EB0EEB9****",
          "text": "*** 🙏🏻",
          "from_phone_number": "****",
          "to_phone_number": "****",
          "chat_id": "****",
          "timestamp": 1676***,
          "from_me": true,
          "is_group": false,
          "instance_id": "436e6b56-d2***",
          "phone_id": "***"
        },
        "contact_name": "****"
      },
   },
]

cURL

curl
    -X GET https://api.wapim.io/api/v1/whatsapp/chatlist?all=true
    -H 'Token: YOUR_WAPIM_TOKEN'

NodeJS

const axios = require('axios');

// Get all chat list.
axios
  .get(
    'https://api.wapim.io/api/v1/whatsapp/chatlist?all=true',
    {
     headers: {
      token: 'YOUR_WAPIM_TOKEN',
     }
    }
  )
  .then(response => console.log(response.data))
  .catch(error => console.log(error.response.data))
  
  
  // Get second the page of chat list.
axios
  .get(
    'https://api.wapim.io/api/v1/whatsapp/chatlist?page=2',
    {
     headers: {
      token: 'YOUR_WAPIM_TOKEN',
     }
    }
  )
  .then(response => console.log(response.data))
  .catch(error => console.log(error.response.data))