WhatsApp Number (DRAFT)

This documentation explains how to manage your WhatsApp Numbers.

This is an API Draft. You can use it as a preview.

There might be changes, which will add additional fields to steer submission process.

Introduction

Use this endpoint to add a WhatsApp Number and start the submission process. You need the following information present to add a WhatsApp Number:

Example Company

Query Parameters
{
"fb_business_id": "12345678",
"phone_number": "+4930609859530",
"phone_name": "My whatsapp Business Name",
"client_name": "Example Client name",
"was_in_use": true,
"ivr": true,
"default_language": "de",
"verification_method": "sms",
"webhook": "https://any.local",
"license_model": "cloud",
"api_user": "test@any.com"
}

Further Information regarding the required data can be found here: Required Submission Data.

After you created an account, we review your submission as usual. You will get notified via email once your submission is reviewed.

API Reference

Authorization information can be found in Authorization

Your partner_id will be provide by Customer Success. If you need it please contact support@360dialog.com

Add WhatsApp Number

Request Schema

Method, Endpoint & Header
Body
Method, Endpoint & Header
POST v1/partners/{{partner_Id}}/wa-numbers
Authorization: Bearer YOURTOKEN
Content-Type: application/json
Body
{
"fb_business_id": string,
"phone_number": string,
"phone_name": string,
"client_name": string,
"was_in_use": true | false,
"ivr": true | false,
"default_language": iso language,
"verification_method": sms or voice,
"webhook": URL,
"license_model": cloud | on-premise,
"api_user": email address
}

Response Codes

20x
40X
500
20x
{
"meta": {
"success": true,
"http_code": 20X
}
}
40X
{
"meta": {
"success": false,
"http_code": 40X,
"developer_message": string
}
}
500
{
"meta": {
"success": false,
"http_code": 500,
"developer_message": string
}
}

Common Error Cases

  • used Phone Number, which is already in system

  • incorrect Facebook Business ID

Example

Request
Response
Request
POST v1/partners/{{partner_Id}}/wa-numbers
Authorization: Bearer YOURTOKEN
Content-Type: application/json
{
"fb_business_id": "123456789101112",
"phone_number": "+4917512345678",
"phone_name": "my Display Name",
"client_name": "Client XYZ",
"was_in_use": false,
"ivr": false,
"default_language": "en",
"verification_method": "sms",
"webhook": "https://example.io",
"api_user": "name@example.io",
"license_model": "cloud"
}
Response
{
"meta": {
"success": true,
"http_code": 201
}
}