From f1cb3723390dd46ba8545e3bd58f0d707803b748 Mon Sep 17 00:00:00 2001 From: allburov Date: Mon, 9 Jan 2023 09:21:07 +0700 Subject: [PATCH] [core][docs] Add contacts page --- .../content/en/docs/how-to/contacts/index.md | 101 ++++++++++++++++++ .../en/docs/how-to/send-messages/index.md | 2 +- .../content/en/docs/how-to/sessions/index.md | 2 +- 3 files changed, 103 insertions(+), 2 deletions(-) create mode 100644 docs/site/content/en/docs/how-to/contacts/index.md diff --git a/docs/site/content/en/docs/how-to/contacts/index.md b/docs/site/content/en/docs/how-to/contacts/index.md new file mode 100644 index 00000000..835ed9c8 --- /dev/null +++ b/docs/site/content/en/docs/how-to/contacts/index.md @@ -0,0 +1,101 @@ +--- +title : "Contacts" +description: "Contacts" +lead: "" +date: 2020-10-06T08:48:45+00:00 +lastmod: 2020-10-06T08:48:45+00:00 +draft: false +images: [] +weight: 130 +--- + +Methods for contacts. + +{{< alert icon="👉" text="WhatsApp Web does not support adding contacts, so the API doesn't support it too." />}} + +## Get all contacts + +Get your contacts - `GET /api/contacts/all` + +```json +[ + { + "id": "11231231231@c.us", + "number": "11231231231", + "name": "Contact Name", + "pushname": "Pushname", + "shortName": "Shortname", + "isMe": true, + "isGroup": false, + "isWAContact": true, + "isMyContact": true, + "isBlocked": false + } +] +``` + +## Get contact + +Get contact + +- `GET /api/contacts?contactId=11231231231&session=default` +- `GET /api/contacts?contactId=11231231231@c.us&session=default` + +```json +{ + "id": "11231231231@c.us", + "number": "11231231231", + "name": "Contact Name", + "pushname": "Pushname", + "shortName": "Shortname", + "isMe": true, + "isGroup": false, + "isWAContact": true, + "isMyContact": true, + "isBlocked": false +} +``` + +## Check phone number exists + +If you want to check if phone number is registered in WhatsApp (even if the number is not in your contact list) - use +this endpoint for that. +- `GET /api/contacts/check-exists?phone=11231231231&session=default` + +```json +{ + "numberExists": true +} +``` + +## Get "about" contact + +- `GET /api/contacts/about?contactId=11231231231&session=default` + +```json +{ + "about": "Hi, I use WhatsApp!" +} +``` + +## Get contact profile picture + +- `GET /api/contacts/profile-picture?contactId=11231231231&session=default` + +```json +{ + "profilePictureURL": "https://example.com/profile.jpg" +} +``` + +## Block (unblock) contact +- To block contact - `POST /api/contacts/block` +- To unblock contact - `POST /api/contacts/unblock` + +Request: +```json +{ + "contactId": "11231231231", + "session": "default" +} +``` diff --git a/docs/site/content/en/docs/how-to/send-messages/index.md b/docs/site/content/en/docs/how-to/send-messages/index.md index 260e992a..c4c202a0 100644 --- a/docs/site/content/en/docs/how-to/send-messages/index.md +++ b/docs/site/content/en/docs/how-to/send-messages/index.md @@ -55,7 +55,7 @@ WAHA does not support reply with files (images, voice, etc). If you're intereste ## Add a reaction ![](/images/versions/core.png) ![](/images/versions/plus.png) Use `PUT /api/reaction` method to set reaction to a message. -{{< alert icon="👉" text="Reactoin API uses PUT, not POST request! Please make sure you send right request." />}} +{{< alert icon="👉" text="Reaction API uses PUT, not POST request! Please make sure you send right request." />}} ```json { diff --git a/docs/site/content/en/docs/how-to/sessions/index.md b/docs/site/content/en/docs/how-to/sessions/index.md index 3c0e8288..34aa3b17 100644 --- a/docs/site/content/en/docs/how-to/sessions/index.md +++ b/docs/site/content/en/docs/how-to/sessions/index.md @@ -6,7 +6,7 @@ date: 2020-10-06T08:48:45+00:00 lastmod: 2020-10-06T08:48:45+00:00 draft: false images: [] -weight: 130 +weight: 200 --- ## Saving session ![](/images/versions/plus.png)