API Documentation - Ping! WhatsApp CRM & Chatbot AI

Introduction

Ping! is a smart WhatsApp CRM platform that combines marketing tools, customer communication management, and AI technology—all in one dashboard. Built with a user-friendly SaaS concept, Ping! empowers small businesses and entrepreneurs to manage customer interactions independently, efficiently, and at scale.

More than just a tool, Ping! also opens up new business opportunities for its users and is designed to be expandable through plugins and future feature integrations—similar to modular systems like WordPress and modern CMS platforms.

In the current version, Ping! includes 6 main modules:

WhatsApp Chatbot (Unofficial & Official API) – For broadcasts, auto-replies, notifications, and chat handling
Broadcast Scheduler – Send promotional messages via WhatsApp safely and gradually (anti-ban system)
AI Chatbot (Powered by ChatGPT 4.0) – Auto-replies 24/7 even when your team is offline
Website Live Chat Plugin – Add a chat widget to your site without any coding

Each module will continue to evolve based on user needs, market trends, and feedback from our community—through a voting system on our upcoming official forum.

Upcoming plugins and features:

Advanced WhatsApp CRM - Follow Up and Upselling Schedule
Shipping Cost Calculation - Integrated All Time

We are fully committed to making Ping! the most complete and affordable communication platform for growing businesses across Indonesia and beyond.

Introduction

Ping! is a smart WhatsApp CRM platform that combines marketing tools, customer communication management, and AI technology—all in one dashboard.

Built with a user-friendly SaaS concept, Ping! empowers small businesses and entrepreneurs to manage customer interactions independently, efficiently, and at scale.

In the current version, Ping! includes 6 main modules:

WhatsApp Chatbot (Unofficial & Official API) – For broadcasts, auto-replies, notifications, and chat handling
Broadcast Scheduler – Send promotional messages via WhatsApp safely and gradually (anti-ban system)
AI Chatbot (Powered by ChatGPT 4.0) – Auto-replies 24/7 even when your team is offline
Website Live Chat Plugin – Add a chat widget to your site without any coding

Each module will continue to evolve based on user needs, market trends, and feedback from our community—through a voting system on our upcoming official forum.

Upcoming plugins and features:

Advanced WhatsApp CRM - Follow Up and Upsellin Schedule
Shipping Cost Calculation - Integrated All Time

We are fully committed to making Ping! the most complete and affordable communication platform for growing businesses across Indonesia and beyond.

Non Official Whatsapp

In developing Non-Official WhatsApp Tools, we use the Baileys library (https://github.com/WhiskeySockets/Baileys).

However, the published API is not directly directed to the Node server, but is repackaged by Laravel. So, the first request is sent to the API provided by Laravel.

Chats

This API focuses on getting a list of contacts stored in your WhatsApp, as well as message history based on contacts or groups. There are several endpoints currently available:

Get Contacts

GET

{domain}/api-app/whatsapp/chats/contacts/{deviceid}

This endpoint is to get the list of contacts stored on your WhatsApp / cellphone.

Parameters

Parameter	Value	Description
api_key	2cc1a317-9016-4582-bcc6-a6f57914be5b	Api key which you can find in general settings

Example Request

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/chats/contacts/03359ec3-2052-43ff-9495-6155b8cab4cc?api_key=2cc1a317-9016-4582-bcc6-a6f57914be5b'

Example Response

{
  "message": "Berhasil Mengambil data kontak",
  "list": [
    {
      "id": "[email protected]",
      "photo": "http://127.0.0.1:8000/assets/img/icons/user.png",
      "phone": "62817467477",
      "name": "No Bot",
      "getpict": false
    }
  ],
  "total_chat": 1,
  "status": true
}

Get Chat List (Group and Non Group)

GET

{domain}/api-app/whatsapp/chats/{deviceID}

This endpoint is to get message history, both on personal WhatsApp numbers and WhatsApp groups.

Parameters

Parameter	Value	Description
api_key	2cc1a317-9016-4582-bcc6-a6f57914be5b	Api key which you can find in general settings
last_chat	1730640827	Optional parameter to get message data based on after a certain date. Date type is unix timestamp
is_group	false	The default value is false, you can change it to true if you want to retrieve group message history

Example Request

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/chats/03359ec3-2052-43ff-9495-6155b8cab4cc?api_key=2cc1a317-9016-4582-bcc6-a6f57914be5b&last_chat=1730640827'

Example Response

{
  "message": "Berhasil Mengambil data kontak pesan",
  "list": [
    {
      "id": "6282138711691-s-whatsapp-net",
      "type": null,
      "sender": true,
      "uid": "[email protected]",
      "message": "",
      "phone": "6282138711691",
      "photo": "http://127.0.0.1:8000/assets/img/icons/user.png",
      "name": "Shobrun",
      "unread": 0,
      "time": "3 Jam lalu",
      "timedate": "2024-11-03 20:33:48",
      "timestamp": 1730640828
    }
  ],
  "total_chat": 1,
  "last_chat": 1730640828,
  "status": true
}

Get Detail Chat

GET

{domain}/api-app/whatsapp/chats/detail/{deviceID}/{group_or_phone_number_id}

This endpoint is to get detailed message history on a contact or group.

To get personal or group contact message details, there is no second step you need to do. Because the system will automatically identify from group_or_phone_number_id whether it is a personal contact number or group id.

ID Format Examples

Type	Example
Phone Number ID	6282138711691-s-whatsapp-net
Group ID	120363303315871698-g-us

Parameters

Parameter	Value	Description
api_key	2cc1a317-9016-4582-bcc6-a6f57914be5b	Api key which you can find in general settings
last_chat	1730640827	Optional parameter to get message data based on after a certain date. Date type is unix timestamp

Example Request

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/chats/detail/03359ec3-2052-43ff-9495-6155b8cab4cc/6282138711691-s-whatsapp-net?api_key=2cc1a317-9016-4582-bcc6-a6f57914be5b&last_chat=1730640827'

Example Response

{
  "message": "Berhasil mengambil data pesan",
  "autoread": false,
  "chatid": "[email protected]",
  "list": {
    "1": {
      "id": "3A55A8FFB9E69158FA61",
      "message": {
        "type": "text",
        "url": null,
        "mime": "",
        "detail": {
          "asset": false,
          "text": "siapakah presiden indonesia sekarang?"
        }
      },
      "time": "13:08",
      "timestamp": "1730034487",
      "sender": false,
      "details": {
        "key": {
          "remoteJid": "[email protected]",
          "fromMe": false,
          "id": "3A55A8FFB9E69158FA61"
        },
        "message": {
          "conversation": "siapakah presiden indonesia sekarang?"
        },
        "messageTimestamp": "1730034487",
        "reportingTokenInfo": {
          "reportingTag": "AY8n56xApadnDcR9hFT78w=="
        }
      },
      "for_read": {
        "remoteJid": "[email protected]"
      },
      "status": "UNREAD"
    },
    "2": {
      "id": "3EB0CD902866F5161A0752",
      "message": {
        "type": "text",
        "url": null,
        "mime": "",
        "detail": {
          "asset": false,
          "text": "Presiden Indonesia sekarang adalah Ir. H. Joko Widodo."
        }
      },
      "time": "13:08",
      "timestamp": "1730034493",
      "sender": true,
      "details": {
        "key": {
          "remoteJid": "[email protected]",
          "fromMe": true,
          "id": "3EB0CD902866F5161A0752"
        },
        "message": {
          "conversation": "Presiden Indonesia sekarang adalah Ir. H. Joko Widodo."
        },
        "messageTimestamp": "1730034493",
        "status": "READ",
        "userReceipt": [
          {
            "userJid": "[email protected]",
            "receiptTimestamp": "1730034494",
            "readTimestamp": "1730034494",
            "playedTimestamp": "0"
          }
        ]
      },
      "for_read": {
        "remoteJid": "[email protected]"
      },
      "status": "READ"
    }
  }
}

Send Message

POST

http://127.0.0.1:8000/api-app/whatsapp/send-message

This endpoint is for sending single messages to both personal and group numbers.

Body Parameters

Parameter	Description	Example	Requirement
phone	Fill in the number or group ID	6281290641111	Required
device_key	Fill in the Device ID, for personal delivery and flexible API settings, the device ID may not need to be filled in and the system will automatically perform a random search for available devices.	bc8bae5a-0997-40a2-a827-b95adc714dd3	Required if it is made mandatory in the settings or will be sent to a group
method	Message method, available for text and also templates	text / template	Required
text	Message content if using the text method	-	Required if you select method as text
is_group	Identify whether you will send to a personal number or to a group	boolean	Required

Request Example

{
    "phone": "RECEIVER_NUMBER_OR_GROUP_ID",
    "device_key": "YOUR_DEVICE_ID",
    "api_key": "YOUR_API_KEY",
    "method": "text",
    "text": "Hallo guys!",
    "is_group": true
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/send-message' \
--data '{
    "phone": "RECEIVER_NUMBER_OR_GROUP_ID",
    "device_key": "YOUR_DEVICE_ID",
    "api_key": "YOUR_API_KEY",
    "method": "text",
    "text": "Hallo guys!"
}'

Response Example

{
  "status": true,
  "message": "Berhasil mengirimkan pesan"
}

Send Message With Template

POST

http://127.0.0.1:8000/api-app/whatsapp/send-message

The endpoint here is the same as the previous Send Message endpoint, the only difference is in the body, if in the example above we use the text method, to send a message without a template, in this endpoint we use the template method, to send a message using the template we created in WhatsMail

Body Parameters

Parameter	Description	Example	Requirement
template	Whatsapp message template ID to be used	510b32e9-d6d9-4c75-83ae-f95cdfcc96e3	Required
variables	Fill with the variables provided in the message template	-	Required

Request Example

{
    "phone": "RECEIVER_NUMBER_OR_GROUP_ID",
    "device_key": "YOUR_DEVICE_ID",
    "api_key": "YOUR_API_KEY",
    "method": "template",
    "template": "YOUR_TEMPLATE_ID",
    "is_group": true,
    "variables": {
        "{business_name}": "BUSINESS_NAME",
        "{name}": "YOUR_NAME"
    }
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/send-message' \
--data '{
    "phone": "RECEIVER_NUMBER_OR_GROUP_ID",
    "device_key": "YOUR_DEVICE_ID",
    "api_key": "YOUR_API_KEY",
    "method": "template",
    "template": "YOUR_TEMPLATE_ID",
    "is_group": true,
    "variables": {
        "{business_name}": "BUSINESS_NAME",
        "{name}": "YOUR_NAME"
    }
}'

Response Example

{
  "status": true,
  "message": "Berhasil mengirimkan pesan"
}

Message Callback

POST

http://127.0.0.1:8000/api-app/whatsapp/callback/device_03359ec3-2052-43ff-9495-6155b8cab4cc

This endpoint is actually created to open communication from the WhatsApp server when a WhatsApp message comes into the connected device.

But sometimes this callback will be useful when we want to do auto reply testing without having to test sending messages on WhatsApp

Body Parameters

Parameter	Description
from	personal number / group id, along with without @s.whatsapp.net for personal numbers, and @g.us for groups
message_id	ID Message whatsapp
message	Message Content
from_name	Sender Name
type	single

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/callback/device_03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "from": "62812906*****@s.whatsapp.net",
    "message_id": "18DD98462C8AA16C5A598C3DEBA0879B",
    "message": "Halo",
    "from_name": "Bhisma Kalijaga",
    "type": "single"
}'

Response Example

{
  "message": {
    "text": "API Doc Ping Example"
  },
  "receiver": "6281290*****@s.whatsapp.net",
  "session_id": "device_03359ec3-2052-43ff-9495-6155b8cab4cc",
  "autoread": false,
  "reply": true
}

Webhook Sample

POST

https://yourdomain.com

The webhook endpoint will be automatically sent when the connected WhatsApp device receives a message.

Whether or not the webhook is sent depends on you filling in the endpoint url on the device.

Request Example

{
    "device_key": "DEVICEID",
    "name": "FROM NAME",
    "message": "MESSAGE DETAIL ( TEXT )",
    "type": "single"
}

cURL Example

curl --location 'https://yourdomain.com' \
--data '{
    "device_key": "DEVICEID",
    "name": "FROM NAME",
    "message": "MESSAGE DETAIL ( TEXT )",
    "type": "single"
}'

Misc

This API provides various utility functions for managing WhatsApp messages, chats, and profile features:

Read Message

POST

http://127.0.0.1:8000/api-app/whatsapp/misc/read-messages/{deviceID}

This endpoint is used to mark messages as read.

Body Parameters

Parameter	Description
api_key	API key from general settings
chatid	Chat ID in format [email protected]
messages	Array of message objects containing id and remoteJid

Request Example

{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "messages": [
        {
            "id": "3A55A8FFB9E69158FA61",
            "remoteJid": "[email protected]"
        }
    ]
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/misc/read-messages/03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "messages": [
        {
            "id": "3A55A8FFB9E69158FA61",
            "remoteJid": "[email protected]"
        }
    ]
}'

Response Example

{
  "status": true,
  "message": "Berhasil menandai status"
}

Delete For Me

POST

http://127.0.0.1:8000/api-app/whatsapp/misc/delete-message/{deviceID}

This endpoint is used to delete messages for the current user only.

Body Parameters

Parameter	Description
api_key	API key from general settings
chatid	Chat ID in format [email protected]
message	Message object containing key, deleteMedia, and timestamp

Request Example

{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "message": {
        "key": {
            "remoteJid": "[email protected]",
            "fromMe": false,
            "id": "3EB024F1DAF187923D00F9"
        },
        "deleteMedia": true,
        "timestamp": "1730660176"
    }
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/misc/delete-message/03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "message": {
        "key": {
            "id": "3EB02744312E25C4C11201",
            "remoteJid": "[email protected]",
            "fromMe": true
        },
        "deleteMedia": false,
        "timestamp": 1730660179
    }
}'

Response Example

{
  "status": true,
  "message": "Berhasil menghapus pesan"
}

Delete For Everyone

POST

http://127.0.0.1:8000/api-app/whatsapp/misc/delete-everyone/{deviceID}

This endpoint is used to delete messages for all chat participants.

Body Parameters

Parameter	Description
api_key	API key from general settings
chatid	Chat ID in format [email protected]
message	Message object containing remoteJid, fromMe, and id

Request Example

{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "message": {
        "remoteJid": "[email protected]",
        "fromMe": true,
        "id": "3EB02744312E25C4C11201"
    }
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/misc/delete-everyone/03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "message": {
        "remoteJid": "[email protected]",
        "fromMe": true,
        "id": "3EB02744312E25C4C11201"
    }
}'

Response Example

{
  "status": true,
  "message": "Berhasil menghapus pesan"
}

Download Media

POST

http://127.0.0.1:8000/api-app/whatsapp/misc/download-media/{deviceID}

This endpoint is used to download media from WhatsApp messages.

Body Parameters

Parameter	Description
api_key	API key from general settings
chatid	Chat ID in format [email protected]
type	Media type (e.g. jpeg)
medianame	Media name/ID
message	Message object containing media details

Request Example

{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "type": "jpeg",
    "medianame": "3EB0C60B34C7F2F7A7B274",
    "message": {
        "key": {
            "remoteJid": "[email protected]",
            "fromMe": false,
            "id": "3EB0C60B34C7F2F7A7B274"
        },
        "messageTimestamp": 1730662917,
        "pushName": "Dede hidayat",
        "broadcast": false,
        "message": {
            "imageMessage": {
                "url": "https://mmg.whatsapp.net/o1/v/t62.7118-24/f1/m232/up-oil-image-6b10ddc5-4850-4419-b5dc-53d2cb058a76?ccb=9-4&oh=01_Q5AaIB4RrBGcE0y6N_KLYocRDC4DVgFbY2aU6idJ-1B5OlQQ&oe=674F51AB&_nc_sid=e6ed6c&mms3=true",
                "mimetype": "image/jpeg",
                "fileSha256": "3D3947hYWot9hbMwKIKZs3jXip4bo+WTj4nJry3poi0=",
                "fileLength": "75487",
                "height": 1257,
                "width": 1600,
                "mediaKey": "Vs+nxRPy9eh48M38ozLr4aWiKmnkcO+C7c/T5YZd6wk=",
                "fileEncSha256": "NQUcEAxZvhNIpoO8Wd2qBetd9JF2bNJz1UzxI49YX24=",
                "directPath": "/o1/v/t62.7118-24/f1/m232/up-oil-image-6b10ddc5-4850-4419-b5dc-53d2cb058a76?ccb=9-4&oh=01_Q5AaIB4RrBGcE0y6N_KLYocRDC4DVgFbY2aU6idJ-1B5OlQQ&oe=674F51AB&_nc_sid=e6ed6c",
                "mediaKeyTimestamp": "1730662913",
                "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/2wBDAQMDAwQDBAgEBAgQCwkLEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBD/wAARCABOAGQDASIAAhEBAxEB/8QAGgABAQADAQEAAAAAAAAAAAAAAAgGBwkEBf/EAD4QAAEDBAIBAwIDAgkNAAAAAAECAwQABQYRBxIhCBMxIkEUIzKB1BUYKDM3UWGGkThEcXJzdXeWsrO1w9H/xAAaAQACAwEBAAAAAAAAAAAAAAAAAwQFBgIH/8QAMhEAAgEDAwIEBAQHAQAAAAAAAQIDAAQRBSExEkEGUWFxExSB8CKRscEyM1JTcqGy0f/aAAwDAQACEQMRAD8A6e0pSiilK+FneaWXjrDrxnGQqdFvssRcp5LQBcc6jwhAJAK1K0lIJA2obI+anT08+uBHNHJKOO73gzdkduSJDtsfYnKkbLTYc9lxJbT56IeV7mwPpSnps7qTFaTTRtKi5VeagXOp2tpPHbTPh34G/t9MnYZqqKUrF75yhx3jjchd3zK1NLiOe08w3IS8+hYV1KS03tewfkdfGjvWjS4oZJ26YlLH0Gf0pt1e21inxLqRUXzYhRtzucVlFK17b/UDw7c5rdvj5xFbdd31VJYejtjQJO3HUJQnwPuRs6A8kCs4td2td7gt3Oy3KLPhvb9uRFeS60vRIOlJJB0QQfPyDXc9pcW38+Nl9wR+tJstWsNTz8lOkmP6GVv0J8x+deqlYBz5y/beBOIck5autnk3ViwMNKTCjuJbU+868hhpBWrwhJcdR2VpRSnsQlZASdDejT17I9U2ZXvj678dKx27W23u3mM/Gn/iY70VMlLZbWFJQpDiA/HGx2S4Q6r8rSUHhYXZDIBsKltMiuIydzVcUpSlU2lKUoopSlKKK8N+sdryax3HG75F/E267RHoMxnupHusOoKFp7JIUnaVEbBBG/BFSHx3xXhHp4z/AC7MLZbYLqok6Q3apl0kKdFrtwaSHNbCAhzv76VOFSj7IQNp273sqo256yOyIs87JX3kvWly4rmjskAPI/Mda0levqKg2Ug6Pbr8HVAe5d47OFyiysqk+WT9+9VeqtaWdvLqcsQkkgR3VdsnpGcD6437Eg84r6We894VmbSG7xzJYLZBDZZXGhX6Owy92OyXAVkrJ0Bokga8AbJOunL3wAv9XMeOD+8ML/7Uo5ZkOU8nXxb7VvlSQwlRjworanRHa2ATpI2ST17LI8nXwAkDArgy9GdcjyGltOtKKFoWkpUlQOiCD5BB+1a5NHv7Jfh2164T/ECvK21XRtel+Z1XTI2nIGcuzEeQ4H+gB5VcDs707ub78z48P7xwa9mNZLwti95au+J+oK3W+4J0AuJk8EFxIUF9Fp+FoJQklCgUnXkGue0w+DXzJFqur8B26sWyU5CYV0dkoZUWkK8eFLA0D9Q+T9x/XS3tNVcFGvXI7jAq1tIvDkLLJFp0aMDsQxBB7YO29ddbtyzg3NmIzuLL9c8Qze3zoSEXGIialx6Q22pB95YjOpKFBwIV2QEBKuvXr4r1eif0v8bcD43eL/YYapmS3i4TY0i5ynQ/IZtyZKlRIiV+22Ej2BHce6JAW8VbJShpKIJ9JfI8/JM5tWP3iSpy4wF92n9q7vsFJSrufgqTtIJJ2oKGwSFE9JOCJPbN8vie/v2rVZnPa7fp7PXAdtfbfTW/v1/srNX9rJpV0lukxkSRercYwckYwCfL72reaJqJ1iCSW4gEUkT9Aw3UCOkEEEgHfP2cit1UpSlVb0pSlFFKUpRRWM8mXk4/gF+uiHX2nEQnG2XGFdXG3XB7aFA7GtKWk7B2NbHmob9SRI4PjAE+X4QP9v0mrP5y/orv3+ox/wB9uow9SX9B8X/bwv8ApNTwgEVo/czgfkF/9NYjUJ3bWL6An8K2WR7s7g/8ip44nz6yYS9dG70mSETw0UONICgkthw6UN789gBoHz86HmsD5DyJnLMruF/jR1sMylIDaFkFXVCEoBOvAJCd6863rZ+a8r58Gqg9KXLnp/xjAbniHJnEuOZPlRuhkWx66WqEpL8ZxLSPY/EOoUvslYcUE9Vb7gDwCU+gT3EzRLBGvVvsNhz6navJ7DTLC2vZNUnfoJX8THJAAxwqgnJwPPiowmH5rY2OcxYtj+CM2KbaJD0uK040Y6G0+y+VKWfKlKOgdjtsfKjpJHgWk3zj6dMPju3Hln00cafwfs9HLPjMMP76nSEMupIdUpXUfrQEjZOwK5xch363ZRmd/wAms+PxrDAu9zlTotqjdfZgMuuqWiOjqlKeraVBA0lI0kaA+KjLNd6bMwZOk48wefvvV7Fb6T4pskeOQugbjDKQQO+RvsexPvnNZD6YHnGfULhS2ldVG4KQTrfhTSwR/gTXUvhC83Bj1PZDjzboEGbgcGa8jqNqdYuElDZ38jSZDvj4Oxv4FcsPTKf5QeEf7y/9a66g8Lf5XN2/4cM/+TXWHvgG1QA/22/evVbIlNOyux+Kg+mQP3qraUpUGr2lKUoopSlKKKxflCxSckwC+WiH3MhyKXGkIR3U4tshxKANjyooCf2/f4qSczwiNyvxq3jLV1MFweypL3thwIda1tKk7BII39wfIPn4NvVhWTcNcdZZLVPutjfZkuK7OPW25Srct1RKiSsxXGyskqJJVvfje9DTnlL2yxKxVkcOpwDvjByD7A/TjeqGfSWbVfn1AZJIjDIpJBK5LKVIzuCWBGBkNnqHTg82n/Rvn60n28lx8q0dBS3wCf8AT7dYDePThndvlOwpU+zIdZUUqBee/wAR+V8H5B/qrqc3wFgdqYlPY8zeGp7rCm2VzchuE1tKtgj8uQ84geUgFQT2AJ0fNTpyZiEyQs3OFDfVMaUGJMdLX1+CR2I/V2B0kjyda+Opq40TXXOoLa6qwKOMKwHThvI+h498etY7xp4XmstHbUPD6kSxHLJu/UncjbOV59geTipUkehvll3fXIcS/bLk/u9fMkegjmF39OSYd+2ZK/d63fbLHk+U3cMQsjywB54GQ61fJwbYSoklRAeCUgAK0nxvWhVBY3ikzJ7zaMAtrk9UFtpDl4nF9anWIDfjqt4LS6l6QUltLgV3/nnEnbRqHrcuq6PcJayTI7t2UcDzOeM9qt/B1xo/im1e8traWONcAFyMMe4XBOcdz6+9R9wZ6KM5wDlC0ZzmWUWJUKyqXJaYtjjzrr73UpSlRcbQEJ+rsSOxPXroduya59PUeXkXqTy3M7TEcfsVlxhrF5NwBT7JuYlfiFsIO/rUhCwF6/QoFKtEje1/4svEh/zfLP8Ane9/vdZ5iWIYvgePQ8Uw2xQ7RaICPbjxIrYQhI+ST91KJ2VKO1KJJJJJNVqPK05uZ26m6ekbYAB5PP3n0xWua2QRLbxL0oGDHfJJHA44zz7Y75H16UpRUqlKUoopSlKKKUpSiila55C4yud9mu3/ABeXETNcaCXIU1Sm2HnApIDnvIStTekd9josKIRrp9SlbGpS5YUmXpkGRXaO0Z6lNTw3xzyrcZb8KFi8K2IaKkCbdbg37a/Okrabj+6tY+VFKy0daGwSeu3OPOO7Vx/bXW2XROu1wKHLpdFtJbcmOpT1T9I8IbSNhDYJCQSSVKUtasrpSoLSK23jG9dSTvL/ABGlKUqTSqUpSiilKUoor//Z",
                "contextInfo": {
                    "disappearingMode": {
                        "initiator": "CHANGED_IN_CHAT"
                    }
                },
                "viewOnce": false
            },
            "messageContextInfo": {
                "deviceListMetadata": {
                    "senderKeyHash": "AweRGGeN/E8oPw==",
                    "senderTimestamp": "1730346321",
                    "senderAccountType": "E2EE",
                    "receiverAccountType": "E2EE",
                    "recipientKeyHash": "+L2RYaRxTS4nQQ==",
                    "recipientTimestamp": "1730654863"
                },
                "deviceListMetadataVersion": 2,
                "messageSecret": "8/i+Np2DVnMdcjnGTMnqamugemV5X9RrOQbWm4vJ8zU="
            }
        }
    }
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/misc/download-media/03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "type": "jpeg",
    "medianame": "3EB0C60B34C7F2F7A7B274",
    "message": {
        "key": {
            "remoteJid": "[email protected]",
            "fromMe": false,
            "id": "3EB0C60B34C7F2F7A7B274"
        },
        "messageTimestamp": 1730662917,
        "pushName": "Bhisma Kalijaga",
        "broadcast": false,
        "message": {
            "imageMessage": {
                "url": "https://mmg.whatsapp.net/o1/v/t62.7118-24/f1/m232/up-oil-image-6b10ddc5-4850-4419-b5dc-53d2cb058a76?ccb=9-4&oh=01_Q5AaIB4RrBGcE0y6N_KLYocRDC4DVgFbY2aU6idJ-1B5OlQQ&oe=674F51AB&_nc_sid=e6ed6c&mms3=true",
                "mimetype": "image/jpeg",
                "fileSha256": "3D3947hYWot9hbMwKIKZs3jXip4bo+WTj4nJry3poi0=",
                "fileLength": "75487",
                "height": 1257,
                "width": 1600,
                "mediaKey": "Vs+nxRPy9eh48M38ozLr4aWiKmnkcO+C7c/T5YZd6wk=",
                "fileEncSha256": "NQUcEAxZvhNIpoO8Wd2qBetd9JF2bNJz1UzxI49YX24=",
                "directPath": "/o1/v/t62.7118-24/f1/m232/up-oil-image-6b10ddc5-4850-4419-b5dc-53d2cb058a76?ccb=9-4&oh=01_Q5AaIB4RrBGcE0y6N_KLYocRDC4DVgFbY2aU6idJ-1B5OlQQ&oe=674F51AB&_nc_sid=e6ed6c",
                "mediaKeyTimestamp": "1730662913",
                "jpegThumbnail": "/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/2wBDAQMDAwQDBAgEBAgQCwkLEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBD/wAARCABOAGQDASIAAhEBAxEB/8QAGgABAQADAQEAAAAAAAAAAAAAAAgGBwkEBf/EAD4QAAEDBAIBAwIDAgkNAAAAAAECAwQABQYRBxIhCBMxIkEUIzKB1BUYKDM3UWGGkThEcXJzdXeWsrO1w9H/xAAaAQACAwEBAAAAAAAAAAAAAAAAAwQFBgIH/8QAMhEAAgEDAwIEBAQHAQAAAAAAAQIDAAQRBSExEkEGUWFxExSB8CKRscEyM1JTcqGy0f/aAAwDAQACEQMRAD8A6e0pSiilK+FneaWXjrDrxnGQqdFvssRcp5LQBcc6jwhAJAK1K0lIJA2obI+anT08+uBHNHJKOO73gzdkduSJDtsfYnKkbLTYc9lxJbT56IeV7mwPpSnps7qTFaTTRtKi5VeagXOp2tpPHbTPh34G/t9MnYZqqKUrF75yhx3jjchd3zK1NLiOe08w3IS8+hYV1KS03tewfkdfGjvWjS4oZJ26YlLH0Gf0pt1e21inxLqRUXzYhRtzucVlFK17b/UDw7c5rdvj5xFbdd31VJYejtjQJO3HUJQnwPuRs6A8kCs4td2td7gt3Oy3KLPhvb9uRFeS60vRIOlJJB0QQfPyDXc9pcW38+Nl9wR+tJstWsNTz8lOkmP6GVv0J8x+deqlYBz5y/beBOIck5autnk3ViwMNKTCjuJbU+868hhpBWrwhJcdR2VpRSnsQlZASdDejT17I9U2ZXvj678dKx27W23u3mM/Gn/iY70VMlLZbWFJQpDiA/HGx2S4Q6r8rSUHhYXZDIBsKltMiuIydzVcUpSlU2lKUoopSlKKK8N+sdryax3HG75F/E267RHoMxnupHusOoKFp7JIUnaVEbBBG/BFSHx3xXhHp4z/AC7MLZbYLqok6Q3apl0kKdFrtwaSHNbCAhzv76VOFSj7IQNp273sqo256yOyIs87JX3kvWly4rmjskAPI/Mda0levqKg2Ug6Pbr8HVAe5d47OFyiysqk+WT9+9VeqtaWdvLqcsQkkgR3VdsnpGcD6437Eg84r6We894VmbSG7xzJYLZBDZZXGhX6Owy92OyXAVkrJ0Bokga8AbJOunL3wAv9XMeOD+8ML/7Uo5ZkOU8nXxb7VvlSQwlRjworanRHa2ATpI2ST17LI8nXwAkDArgy9GdcjyGltOtKKFoWkpUlQOiCD5BB+1a5NHv7Jfh2164T/ECvK21XRtel+Z1XTI2nIGcuzEeQ4H+gB5VcDs707ub78z48P7xwa9mNZLwti95au+J+oK3W+4J0AuJk8EFxIUF9Fp+FoJQklCgUnXkGue0w+DXzJFqur8B26sWyU5CYV0dkoZUWkK8eFLA0D9Q+T9x/XS3tNVcFGvXI7jAq1tIvDkLLJFp0aMDsQxBB7YO29ddbtyzg3NmIzuLL9c8Qze3zoSEXGIialx6Q22pB95YjOpKFBwIV2QEBKuvXr4r1eif0v8bcD43eL/YYapmS3i4TY0i5ynQ/IZtyZKlRIiV+22Ej2BHce6JAW8VbJShpKIJ9JfI8/JM5tWP3iSpy4wF92n9q7vsFJSrufgqTtIJJ2oKGwSFE9JOCJPbN8vie/v2rVZnPa7fp7PXAdtfbfTW/v1/srNX9rJpV0lukxkSRercYwckYwCfL72reaJqJ1iCSW4gEUkT9Aw3UCOkEEEgHfP2cit1UpSlVb0pSlFFKUpRRWM8mXk4/gF+uiHX2nEQnG2XGFdXG3XB7aFA7GtKWk7B2NbHmob9SRI4PjAE+X4QP9v0mrP5y/orv3+ox/wB9uow9SX9B8X/bwv8ApNTwgEVo/czgfkF/9NYjUJ3bWL6An8K2WR7s7g/8ip44nz6yYS9dG70mSETw0UONICgkthw6UN789gBoHz86HmsD5DyJnLMruF/jR1sMylIDaFkFXVCEoBOvAJCd6863rZ+a8r58Gqg9KXLnp/xjAbniHJnEuOZPlRuhkWx66WqEpL8ZxLSPY/EOoUvslYcUE9Vb7gDwCU+gT3EzRLBGvVvsNhz6navJ7DTLC2vZNUnfoJX8THJAAxwqgnJwPPiowmH5rY2OcxYtj+CM2KbaJD0uK040Y6G0+y+VKWfKlKOgdjtsfKjpJHgWk3zj6dMPju3Hln00cafwfs9HLPjMMP76nSEMupIdUpXUfrQEjZOwK5xch363ZRmd/wAms+PxrDAu9zlTotqjdfZgMuuqWiOjqlKeraVBA0lI0kaA+KjLNd6bMwZOk48wefvvV7Fb6T4pskeOQugbjDKQQO+RvsexPvnNZD6YHnGfULhS2ldVG4KQTrfhTSwR/gTXUvhC83Bj1PZDjzboEGbgcGa8jqNqdYuElDZ38jSZDvj4Oxv4FcsPTKf5QeEf7y/9a66g8Lf5XN2/4cM/+TXWHvgG1QA/22/evVbIlNOyux+Kg+mQP3qraUpUGr2lKUoopSlKKKxflCxSckwC+WiH3MhyKXGkIR3U4tshxKANjyooCf2/f4qSczwiNyvxq3jLV1MFweypL3thwIda1tKk7BII39wfIPn4NvVhWTcNcdZZLVPutjfZkuK7OPW25Srct1RKiSsxXGyskqJJVvfje9DTnlL2yxKxVkcOpwDvjByD7A/TjeqGfSWbVfn1AZJIjDIpJBK5LKVIzuCWBGBkNnqHTg82n/Rvn60n28lx8q0dBS3wCf8AT7dYDePThndvlOwpU+zIdZUUqBee/wAR+V8H5B/qrqc3wFgdqYlPY8zeGp7rCm2VzchuE1tKtgj8uQ84geUgFQT2AJ0fNTpyZiEyQs3OFDfVMaUGJMdLX1+CR2I/V2B0kjyda+Opq40TXXOoLa6qwKOMKwHThvI+h498etY7xp4XmstHbUPD6kSxHLJu/UncjbOV59geTipUkehvll3fXIcS/bLk/u9fMkegjmF39OSYd+2ZK/d63fbLHk+U3cMQsjywB54GQ61fJwbYSoklRAeCUgAK0nxvWhVBY3ikzJ7zaMAtrk9UFtpDl4nF9anWIDfjqt4LS6l6QUltLgV3/nnEnbRqHrcuq6PcJayTI7t2UcDzOeM9qt/B1xo/im1e8traWONcAFyMMe4XBOcdz6+9R9wZ6KM5wDlC0ZzmWUWJUKyqXJaYtjjzrr73UpSlRcbQEJ+rsSOxPXroduya59PUeXkXqTy3M7TEcfsVlxhrF5NwBT7JuYlfiFsIO/rUhCwF6/QoFKtEje1/4svEh/zfLP8Ane9/vdZ5iWIYvgePQ8Uw2xQ7RaICPbjxIrYQhI+ST91KJ2VKO1KJJJJJNVqPK05uZ26m6ekbYAB5PP3n0xWua2QRLbxL0oGDHfJJHA44zz7Y75H16UpRUqlKUoopSlKKKUpSiila55C4yud9mu3/ABeXETNcaCXIU1Sm2HnApIDnvIStTekd9josKIRrp9SlbGpS5YUmXpkGRXaO0Z6lNTw3xzyrcZb8KFi8K2IaKkCbdbg37a/Okrabj+6tY+VFKy0daGwSeu3OPOO7Vx/bXW2XROu1wKHLpdFtJbcmOpT1T9I8IbSNhDYJCQSSVKUtasrpSoLSK23jG9dSTvL/ABGlKUqTSqUpSiilKUoor//Z",
                "contextInfo": {
                    "disappearingMode": {
                        "initiator": "CHANGED_IN_CHAT"
                    }
                },
                "viewOnce": false
            },
            "messageContextInfo": {
                "deviceListMetadata": {
                    "senderKeyHash": "AweRGGeN/E8oPw==",
                    "senderTimestamp": "1730346321",
                    "senderAccountType": "E2EE",
                    "receiverAccountType": "E2EE",
                    "recipientKeyHash": "+L2RYaRxTS4nQQ==",
                    "recipientTimestamp": "1730654863"
                },
                "deviceListMetadataVersion": 2,
                "messageSecret": "8/i+Np2DVnMdcjnGTMnqamugemV5X9RrOQbWm4vJ8zU="
            }
        }
    }
}'

Response Example

{
  "success": true,
  "message": "Berhasil mengunduh media",
  "data": {
    "downloadPath": "http://127.0.0.1:8000/uploads/wamedia/3EB0C60B34C7F2F7A7B274.jpeg"
  }
}

Get Photo Profile

POST

http://127.0.0.1:8000/api-app/whatsapp/misc/get-profile/{deviceID}

This endpoint is used to get the profile photo of a WhatsApp contact.

Body Parameters

Parameter	Description
api_key	API key from general settings
phone	Phone number in format [email protected]

Request Example

{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "phone": "[email protected]"
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/misc/get-profile/03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "phone": "[email protected]"
}'

Response Example

{
  "success": true,
  "message": "Berhasil mengambil photo profile",
  "data": {
    "url": "https://pps.whatsapp.net/v/t61.24694-24/436858941_996850321937151_8699542876893233263_n.jpg?ccb=11-4&oh=01_Q5AaID5alSZxaPGXfuj96nA7HPvf8iuz_3W7vO4IXBSVUuqG&oe=6734D164&_nc_sid=5e03e0&_nc_cat=105",
    "phone": "[email protected]"
  }
}

Mark Chat to Read or Not

POST

http://127.0.0.1:8000/api-app/whatsapp/misc/mark-message/{deviceID}

This endpoint is used to mark chat messages as read or unread.

Body Parameters

Parameter	Description
api_key	API key from general settings
chatid	Chat ID in format [email protected]
status	true to mark as read, false to mark as unread

Request Example

{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "status": true
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/misc/mark-message/03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]",
    "status": true
}'

Response Example

{
  "success": true,
  "message": "Pesan berhasil di baca",
  "data": {}
}

Delete Chat

POST

http://127.0.0.1:8000/api-app/whatsapp/misc/delete-chat/{deviceID}

This endpoint is used to delete an entire chat conversation.

Body Parameters

Parameter	Description
api_key	API key from general settings
chatid	Chat ID in format [email protected]

Request Example

{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]"
}

cURL Example

curl --location 'http://127.0.0.1:8000/api-app/whatsapp/misc/delete-chat/03359ec3-2052-43ff-9495-6155b8cab4cc' \
--data-raw '{
    "api_key": "2cc1a317-9016-4582-bcc6-a6f57914be5b",
    "chatid": "[email protected]"
}'

Response Example

{
  "success": true,
  "message": "Chat berhasil di hapus",
  "data": {}
}

Every use of API requires a Device ID. You can copy the Device ID in the device menu in the Action section. Example of Device ID as follows:

03359ec3-2052-43ff-9495-6155b8cab4cc