WhatsApp

JavaScript
Python

Installing the SDK

Install the SDK

Bun
pnpm
npm
Yarn

bun add contiguity

pnpm add contiguity

npm install contiguity

yarn add contiguity

Initialize the Client

With API key
From env

import { Contiguity } from "contiguity";
const contiguity = new Contiguity("contiguity_sk_...your_key...");

import { Contiguity } from "contiguity";
// Reads CONTIGUITY_API_KEY or CONTIGUITY_TOKEN
const contiguity = new Contiguity();

Sending a WhatsApp Message

Send rich WhatsApp content to your users with automatic fallback to SMS when WhatsApp is not available.

WhatsApp messages require the recipient to have WhatsApp installed and active. If WhatsApp is not available, you can configure automatic fallback to SMS.

const res = await contiguity.whatsapp.send({
  to: "+1234567890",
  message: "Hello via WhatsApp!",
  // from: "+15555555555",
  fallback: { 
    when: ["whatsapp_unsupported", "whatsapp_fails"], 
    from: "+15555555555" 
  },
  attachments: ["https://example.com/image.png"]
});

Response

message_id

string

Unique identifier for the sent WhatsApp message, used for tracking delivery status.

metadata

object

Request metadata including ID, timestamp, and API version.

You can also send a simple WhatsApp message without attachments:

const res = await contiguity.whatsapp.send({
  to: "+1234567890",
  message: "Hello from your app!"
});

Typing Indicators

Show typing indicators to create a more interactive messaging experience.Start typing indicator:

const res = await contiguity.whatsapp.typing({
  to: "+1234567890", 
  action: "start"
});

Response

status

string

Current status of the typing indicator action (e.g., “started”, “stopped”).

metadata

object

Request metadata including ID, timestamp, and API version.

Stop typing indicator:

const res = await contiguity.whatsapp.typing({
  to: "+1234567890", 
  action: "stop"
});

Installing the SDK

Install the SDK

pip install contiguity

Initialize the Client

import contiguity
client = contiguity.login("your_token_here")

You can also initialize it with the optional ‘debug’ flag:

client = contiguity.login("your_token_here", True)

Sending a WhatsApp Message

# Python SDK examples coming soon

Typing Indicators

# Python SDK examples coming soon

Parameters

whatsapp.send(params)

string

required

The recipient’s phone number in E.164 format (e.g., “+1234567890”).

message

string

required

The message content to send via WhatsApp.

from

string

Optional leased phone number to use as the sender. Must be a number you have leased from Contiguity.

fallback

object

Fallback configuration for when WhatsApp is not available.

Show Fallback object properties

fallback.when

string[]

Array of conditions that trigger fallback. Options: "whatsapp_unsupported", "whatsapp_fails".

fallback.from

string

Optional sender number to use for fallback SMS delivery.

attachments

string[]

Array of attachment URLs to include with the message. Supports images and other media.

whatsapp.typing(params)

string

required

The recipient’s phone number in E.164 format (e.g., “+1234567890”).

action

string

required

The typing indicator action. Options: "start" to show typing, "stop" to hide typing.

from

string

Optional leased phone number to use as the sender.

Getting Started

SDK Documentation by Product

SDK Documentation by Language

Installing the SDK

Sending a WhatsApp Message

Response

Typing Indicators

Response

Installing the SDK

Sending a WhatsApp Message

Typing Indicators

Parameters

whatsapp.send(params)

whatsapp.typing(params)

​Installing the SDK

​Sending a WhatsApp Message

​Response

​Typing Indicators

​Response

​Installing the SDK

​Sending a WhatsApp Message

​Typing Indicators

​Parameters

​whatsapp.send(params)

​whatsapp.typing(params)

Installing the SDK

Sending a WhatsApp Message

Response

Typing Indicators

Response

Installing the SDK

Sending a WhatsApp Message

Typing Indicators

Parameters

whatsapp.send(params)

whatsapp.typing(params)