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.
Fetch a message
Conversation history
Reactions
Mark as read
Check iMessage availability
Parameters
string
required
Recipient phone number in E.164 format.
Response
boolean
Whether the number supports iMessage.
object
Request metadata: id, timestamp, api_version, object.
Typing Indicators
Show typing indicators to create a more interactive messaging experience. Start typing indicator: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.
string[]
Array of attachment URLs to include with the message. Supports images and other media.
boolean
Optional. Bypass recommended rate limiting on leased numbers. Requires Fast Track entitlement.
Response
string
Unique identifier for the sent iMessage, used for tracking delivery status.
object
Request metadata including ID, timestamp, and API version.
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.
imessage.get(id)
string
required
Message ID (same endpoint as text get; conversations).
imessage.history(params)
string
required
Recipient E.164.
string
required
Sender E.164.
number
Optional. Max messages to return.
imessage.react(action, params)
string
required
"add" or "remove".string
required
e.g.
"love", "thumbsup", etc.string
Message ID, or use
to + from + message.imessage.read(params)
string
required
Recipient E.164.
string
required
Sender E.164.
imessage.availability(params)
string
required
Recipient E.164 phone number.
Response (send / get / history / react / availability)
string
Message ID (send/react).
object
Request metadata: id, timestamp, api_version, object.
