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

https://partners.99digital.co.il/api/whatsapp/getWhatsApp

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 []:

name

explanation

create_time

The UNIX time that this account was created

whatsapp

The WhatsApp number

apiKey

The API key for the service to use on WhatsApp V2 endpoints

display_name

The display name for the WhatsApp number

business_name

The business name that owns the WhatsApp number

isOnline

if the WhatsApp number is connected to the our online omni channel platform, this will be 1, otherwise, it will be 0.

onlineAccount

if the isOnline is 1, here you will see the account number that the WhatsApp is connected to

onlineInbox

if the isOnline is 1, here you will see the inbox number that the WhatsApp is connected to

onlineServer

if the isOnline is 1, here you will see the server subdomain where this WhatsApp inbox is located

coexistence

If this account connected as coexistence feature , it will show 1

for regular account - it will show 0

conversationsThisMonth

The total number of conversations that this WhatsApp number generated in this current month

marketingThisMonth

The total number of marketing conversations that this WhatsApp number generated in this current month

serviceThisMonth

The total number of service conversations that this WhatsApp number generated in this current month

incomingThisMonth

The total number of incoming conversations that this WhatsApp number generated in this current month

reason

'reason' is the status explanation in case of FAIL

1

not FAIL. the status is OK

2

Wrong credentials

3

Access token does not exist or expired, please generate another one from Settings - Get access token API

13

you need to use GET method.