Get Contacts
Get Contacts allows you to see all contacts that messaged you and you messages them.
Settings:
URL | |
Method | JSON via POST |
Body:
Parameter | Description / Example |
|---|---|
apiKey | Your API key for the service |
from | Your WhatsApp account. international number without +. for example: 972771234567 |
page | Mandatory. integer number. every page shows the last 50 contacts. for example, page '1' will show last known contacts from 1 to 50 page '2 will show last known contacts from contact 51 to 100. |
Response:
[
{
"contact_phone": "972501234567",
"contact_name": "John",
"update_time": 1770196687,
"online_contact_id": 1,
"online_conversation_id": 2,
"contact_profilePic": "https://storage..."
},
{
"contact_phone": "972549876541",
"contact_name": "Smoth",
"update_time": 1770196687,
"online_contact_id": 3,
"online_conversation_id": 4,
"contact_profilePic": "https://storage..."
}
]
Response-Explain:
Parameter | Description |
|---|---|
contact_phone | The end user phone number |
contact_name | The end user contact name |
update_time | The time when this contact was created / updated. this is based on your last interaction with him |
online_contact_id | If you are using 99 digital omni channel, this is the contact ID |
online_conversation_id | If you are using 99 digital omni channel, this is the conversation ID |
contact_profilePic | If the contact ever sent you a message, and the profile picture arrived, you will find the link here. (same as the webhook message when the incoming message arrived), if empty, you will get null. |