Sending Contacts

Before testing this API, make sure you have an active WhatsApp session. To get started, send your join code to the sandbox number Learn more

WhatsApp offers an API to send contacts.

POST

https://gateway.lipachat.com/api/v1/whatsapp/contact

Headers

Name	Value
Content-Type	application/json
apiKey	Get apiKey from App portal settings tabhttps://app.lipachat.com/app/settings

Body

Name	Type	Description
messageId	string	A unique identifier for the message. This will be used to track the message status and for deduplication purposes.
from	string	Sandbox number [phone] or your own WABA phone number.
to	string	Receiver phone number. It should start with a country code.
name.formattedName	string	Contact's formatted name. This will appear in the message alongside the profile arrow button.
phones[0].phone[0].phone	string	User phone number.
phones[0].phone[0].type	string	Type of phone number. For example, cell, mobile, main, iPhone, home, work, etc.
phones[0].phone[0].waId	string	WhatsApp user ID. If omitted, the message will display an Invite to WhatsApp button instead of the standard buttons.

Curl

curl --location 'https://gateway.lipachat.com/api/v1/whatsapp/contact' \
--header 'apiKey: API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "messageId": "ca739107-4b0d-4581-acb1-4c4af70555de",
    "to": "2547XXXX",
    "from": "254110090747",
    "name": {
        "formattedName": "Test User"
    },
    "phones": [
        {
            "phone": "254712345678",
            "type": "Cell",
            "waId": "254712345678"
        }
    ]
}'

Java

// Create an instance of OkHttpClient
OkHttpClient client = new OkHttpClient().newBuilder()
    .build();

// Define the media type for the request
MediaType mediaType = MediaType.parse("application/json");

// Create the request body with the necessary JSON payload using a text block
RequestBody body = RequestBody.create(mediaType, """
{
    "messageId": "ca739107-4b0d-4581-acb1-4c4af70555de",
    "to": "2547XXXX",
    "from": "254110090747",
    "name": {
        "formattedName": "Test User"
    },
    "phones": [
        {
            "phone": "254712345678",
            "type": "Cell",
            "waId": "254712345678"
        }
    ]
}
""");

// Build the request with the required headers
Request request = new Request.Builder()
    .url("https://gateway.lipachat.com/api/v1/whatsapp/contact")
    .method("POST", body)
    .addHeader("apiKey", "YOUR_API_KEY")
    .addHeader("Content-Type", "application/json")
    .build();

// Execute the request and get the response
Response response = client.newCall(request).execute();

Javascript

const axios = require('axios');
let data = JSON.stringify({
    "messageId": "ca739107-4b0d-4581-acb1-4c4af70555de",
    "to": "2547XXXX",
    "from": "254110090747",
    "name": {
        "formattedName": "Test User"
    },
    "phones": [
        {
            "phone": "254712345678",
            "type": "Cell",
            "waId": "254712345678"
        }
    ]
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://gateway.lipachat.com/api/v1/whatsapp/contact',
  headers: { 
    'apiKey': 'YOUR_API_KEY', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

200

{
      "timestamp": "2023-08-06T01:27:56.825898971",
      "data": {
            "messageId": "7addc006-07db-4fae-aac5-b285903b41d4",
            "waId": "wamid.HBgMMjU0NzE3NzQ2NTY1FQIAEnRgSRjJGRkMzNkQ0QUVENTIxQ0NBAA==",
            "status": "SENT",
            "statusDesc": "Message sent successfully"
      },
      "status": "success",
      "message": "",
      "errors": null
}

400

{
      "timestamp": "2023-08-06T17:50:35.701+00:00",
      "status": 400,
      "error": "Bad Request",
      "path": "/api/v1/whatsapp/contact"
}

401

{
      "timestamp": "2023-08-06T20:49:48.455464058",
      "data": null,
      "status": "success",
      "message": "Invalid credentials",
      "errors": null
}