iMessage

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 an iMessage

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

iMessage messages require the recipient to have an Apple device with iMessage enabled. If iMessage is not available, you can configure automatic fallback to SMS.

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

Response

string

Unique identifier for the sent iMessage, used for tracking delivery status.

object

Request metadata including ID, timestamp, and API version.

You can also send a simple iMessage without attachments:

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

Check iMessage availability

const res = await contiguity.imessage.availability({ to: "+1234567890" });

Typing Indicators

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

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

Response

string

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

object

Request metadata including ID, timestamp, and API version.

Stop typing indicator:

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

Parameters

imessage.send(params)

string

required

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

string

required

The message content to send via iMessage.

string

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

object

Fallback configuration for when iMessage is not available.

Show Fallback object properties

string[]

Array of conditions that trigger fallback. Options: "imessage_unsupported", "imessage_fails".

string

Optional sender number to use for fallback SMS delivery.

string[]

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

imessage.availability(params)

string

required

Recipient phone number in E.164 format.

imessage.typing(params)

string

required

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

string

required

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

string

Optional leased phone number to use as the sender.

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 an iMessage

# Python SDK examples coming soon

Typing Indicators

# Python SDK examples coming soon

Parameters

Python SDK documentation coming soon.

Getting Started

SDK Documentation by Product

SDK Documentation by Language

Installing the SDK

Sending an iMessage

Response

Check iMessage availability

Typing Indicators

Response

Parameters

imessage.send(params)

imessage.availability(params)

imessage.typing(params)

Installing the SDK

Sending an iMessage

Typing Indicators

Parameters

​Installing the SDK

​Sending an iMessage

​Response

​Check iMessage availability

​Typing Indicators

​Response

​Parameters

​imessage.send(params)

​imessage.availability(params)

​imessage.typing(params)

​Installing the SDK

​Sending an iMessage

​Typing Indicators

​Parameters

Installing the SDK

Sending an iMessage

Response

Check iMessage availability

Typing Indicators

Response

Parameters

imessage.send(params)

imessage.availability(params)

imessage.typing(params)

Installing the SDK

Sending an iMessage

Typing Indicators

Parameters