Step 1: Register a number


This API allows you to add a number to your account, in order to use "Step 2: Create account" API.

In order to use the number, we must verify the number. you can request verification code by SMS or phone call.


Important Remarks

  • The number you wish to register must not be installed on any WhatsApp phone. it must be a new number.

  • Do not attempt to request a code more than 3 times or Facebook might block the request for 1 hour to avoid abuse. 

  • If you want to use phone call, please make sure you are able to dial the number yourself and the number does not have IVR operator. make sure that a call can go through smoothly and you are able to answer the phone call. the phone call will be received from a strange country code or unknown number make sure those numbers are not blocked on your phone.

  • Registered phone numbers will wait in your account for 90 days. During this time you must create an account with that number. if you did not create an account with that phone number, after 90 days you will have to re-register the number again.

  • You can register and keep up to 500 numbers in your account waiting to be connected.

This process is a two parts process.

Part 1 : you register the number by asking the code for verification. after submitting the registerNumber API, you will get SMS or a phone call with 6 digits verification code.

Part 2: you verify the code you received. now the number is verified and belongs to you.

Part 1

Settings:

URL

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

Method

JSON via POST

Header

Authorization: Bearer {{access_token}}

*The access_token can be received from settings->get access token API.


Body:

Parameter

Description / Example

Maximum length

Remarks

mandatory

whatsapp

The whatsapp number you wish to register


use country code and the following numbers. no +

for example: 972501234567

yes

method

1 for SMS

2 for phone call

1

If both options are available for your number, we recommend using SMS, as its more stable way and not based on answering a phone call

yes

language

language name

code to use

Hebrew

1

English

2

Arabic

3

Russian

4

Spanish

5

Chinese

6

Hindi

7

Thai

8

French

9

1

the language of the SMS / voice call to get the verification code. 


(For SMS, in some cases, it will be sent in English regardless of what was selected in language).

Yes

comment

A free text for you to use along with the number registration

100

numbers and letters only

No


Response:


{
"status": "OK",
"whatsapp": "972501234567",
"reason": 1
}



Response-Explain:

Parameter

Description

status

OK or FAIL

"OK" means the SMS or phone call has been sent.

"Fail" means error.

whatsapp

The whatsapp number

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

4

WhatsApp number is empty or wrong

5

method is empty or wrong.

6

language is empty or wrong.

7

The number you are trying to verify has already been verified by you

8

The number you are trying to verify is not a new WhatsApp number. the number might be used by another WhatsApp API business or WhatsApp App, or the number you provided is not a valid phone number.

9

Error trying to send the verification code, please try again later

15

Unknown error, please contact support

24

you requested the code too many times. please try again in 1 hour

27

The comment length is too long or invalid


Part 2


Settings:

URL

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

Method

JSON via POST

Header

Authorization: Bearer {{access_token}}

*The access_token can be received from settings->get access token API.


Body:

Parameter

Description / Example

Maximum length

Remarks

mandatory

whatsapp

The same WhatsApp number you used for verify the code on registerNumber API


use country code and the following numbers. no +

for example: 972501234567

yes

code

6 digits code

6

6 digits numbers only. remove any hyphens if the code received by SMS contains any

yes


Response:

{
"status": "OK",
"whatsapp": "972501234567",
"expiration": "1737109621",
"reason": 1
}


Response-Explain:

Parameter

Description

status

OK or FAIL

"OK" means verification successful

"Fail" means error.

whatsapp

The whatsapp number

expiration

The expiration timestamp, 90 days from now.

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

4

WhatsApp number is empty or wrong

7

The number you are trying to verify has already been verified by you

10

code is empty or not a 6 digits number

11

The WhatsApp number you try to verify is not a number that is waiting to be verified, please use the registerNumber API on Part 1 first.

12

code is wrong, please try again. you can try up 3 times.

15

Unknown error, please contact support