Get WhatsApp Numbers
Get WhatsApp Numbers allows you to view all the WhatsApp numbers you have added to the system the finished the onboarding process.
Settings:
URL | |
Method | JSON via GET |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body: nothing, leave it empty.
Response:
{
"status": "OK",
"reason": 1,
"totalWhatsApp": 2,
"totalConversationsThisMonth": 10,
"totalMarketingThisMonth": 4,
"totalServiceThisMonth": 5,
"totalIncomingThisMonth": 1,
"list": [
{
"create_time": 1735811185,
"whatsapp": "972501234567",
"apiKey": "the-api-key-for-the-service",
"display_name": "The WhatsApp Display name",
"business_name": "The Business Name",
"isOnline": 1,
"onlineAccount": 1,
"onlineInbox": 2,
"coexistence": 0,
"conversationsThisMonth": 6,
"marketingThisMonth": 3,
"serviceThisMonth": 3,
"incomingThisMonth": 0
},
{
"create_time": 1735811185,
"whatsapp": "972507654321",
"apiKey": "the-api-key-for-the-service",
"display_name": "The WhatsApp Display name",
"business_name": "The Business Name",
"isOnline": 0,
"onlineAccount": 0,
"onlineInbox": 0,
"coexistence": 1,
"conversationsThisMonth": 4,
"marketingThisMonth": 1,
"serviceThisMonth": 2,
"incomingThisMonth": 1
}
]
}
Response-Explain:
Parameter | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request has been sent to Meta. "Fail" means error. | ||||||||||||||||||||||||||||||
totalWhatsApp | The total number of WhatsApp account you manage | ||||||||||||||||||||||||||||||
totalConversationsThisMonth | The total number of conversations that all your WhatsApp numbers generated in this current month | ||||||||||||||||||||||||||||||
totalMarketingThisMonth | The total number of marketing conversations that all your WhatsApp numbers generated in this current month | ||||||||||||||||||||||||||||||
totalServiceThisMonth | The total number of service conversations that all your WhatsApp numbers generated in this current month | ||||||||||||||||||||||||||||||
totalIncomingThisMonth | The total number of incoming conversations that all your WhatsApp numbers generated in this current month | ||||||||||||||||||||||||||||||
list | array of the following table []:
| ||||||||||||||||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|