Learn more about Mintlify
Enter your email to receive updates about new features and product releases.
Send and manage WhatsApp messages
whatsapp resource provides methods for sending WhatsApp messages, managing typing indicators, and reactions.
await contiguity.whatsapp.send(params: WhatsappSendParams): Promise<{ message_id: string }>
Show properties
+1234567890).const result = await contiguity.whatsapp.send({
to: '+1234567890',
from: '+0987654321',
message: 'Hello via WhatsApp!',
attachments: ['https://example.com/document.pdf'],
fallback: {
when: ['whatsapp_unsupported', 'whatsapp_fails'],
from: '+0987654321'
}
});
console.log(result.message_id); // "msg_..."
await contiguity.whatsapp.reply(
event: WebhookEventBase,
params: Omit<WhatsappSendParams, 'to' | 'from'>
): Promise<{ message_id: string }>
to and from fields from the webhook event.
send() but without to and from).app.post('/webhook', async (req, res) => {
const event = contiguity.webhook.parse(req.body);
if (event.type === 'whatsapp.incoming') {
await contiguity.whatsapp.reply(event, {
message: 'Thanks for your WhatsApp message!'
});
}
res.sendStatus(200);
});
await contiguity.whatsapp.typing(params: WhatsappTypingParams): Promise<any>
// Show typing indicator
await contiguity.whatsapp.typing({
to: '+1234567890',
from: '+0987654321',
action: 'start'
});
// Simulate composing message...
await new Promise(resolve => setTimeout(resolve, 2000));
// Stop typing indicator and send message
await contiguity.whatsapp.typing({
to: '+1234567890',
from: '+0987654321',
action: 'stop'
});
await contiguity.whatsapp.send({
to: '+1234567890',
from: '+0987654321',
message: 'Here is my response!'
});
await contiguity.whatsapp.react(
action: 'add' | 'remove',
params: WhatsappReactParams
): Promise<any>
// Add a reaction
await contiguity.whatsapp.react('add', {
to: '+1234567890',
reaction: '👍',
message: 'Thanks for the help!'
});
// Remove a reaction
await contiguity.whatsapp.react('remove', {
to: '+1234567890',
reaction: '👍',
message: 'Thanks for the help!'
});
import { Contiguity } from 'contiguity';
const contiguity = new Contiguity('contiguity_sk_...');
// Send a message with typing indicator
await contiguity.whatsapp.typing({
to: '+1234567890',
from: '+0987654321',
action: 'start'
});
await new Promise(resolve => setTimeout(resolve, 1500));
const { message_id } = await contiguity.whatsapp.send({
to: '+1234567890',
from: '+0987654321',
message: 'Hello! How can I help you today?',
attachments: ['https://example.com/menu.pdf']
});
await contiguity.whatsapp.typing({
to: '+1234567890',
from: '+0987654321',
action: 'stop'
});
console.log('Message sent:', message_id);