Linq

Send iMessage, SMS, and RCS messages and manage conversations with Linq

Instructions d'utilisation

Reach people on iMessage, SMS, and RCS through Linq. Start chats, send messages with media, links, effects, and replies, send voice memos, react with tapbacks, manage group participants, check iMessage/RCS capability, configure contact cards, and subscribe to webhook events — all through a single Linq API key.

Outils

`linq_add_participant`

Add a participant to a group chat (3+ existing participants)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the group chat
`handle`	string	Oui	Phone number (E.164 format) or email address of the participant to add

Sortie

Paramètre	Type	Description
`message`	string	Human-readable status message
`status`	string	Queued action status
`traceId`	string	Trace ID for the queued action

`linq_check_imessage`

Check whether an address (phone number or email) supports iMessage

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`address`	string	Oui	Phone number (E.164 format) or email address to check
`from`	string	Non	Sender phone number to check from (defaults to an available number)

Sortie

Paramètre	Type	Description
`address`	string	The address that was checked
`available`	boolean	Whether the address supports iMessage

`linq_check_rcs`

Check whether an address (phone number or email) supports RCS

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`address`	string	Oui	Phone number (E.164 format) or email address to check
`from`	string	Non	Sender phone number to check from (defaults to an available number)

Sortie

Paramètre	Type	Description
`address`	string	The address that was checked
`available`	boolean	Whether the address supports RCS

`linq_create_attachment`

Upload a file to Linq as a reusable attachment (max 100MB) and get an attachment ID to send in messages

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`file`	file	Non	File to upload (a UserFile from a file-upload field or a previous block)
`fileContent`	string	Non	Legacy base64-encoded file content fallback
`filename`	string	Non	Override the file name (defaults to the uploaded file name)
`contentType`	string	Non	Override the MIME type (defaults to the uploaded file type)

Sortie

Paramètre	Type	Description
`attachmentId`	string	Reusable attachment ID to reference when sending messages or voice memos
`downloadUrl`	string	URL the attachment can be downloaded from
`filename`	string	File name
`contentType`	string	MIME type of the file
`sizeBytes`	number	File size in bytes
`status`	string	Upload status

`linq_create_chat`

Start a new iMessage, SMS, or RCS chat and send the first message

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`from`	string	Oui	Sender phone number in E.164 format (e.g. +14155551234)
`to`	array	Oui	Recipient handles (phone numbers in E.164 format or email addresses)
`text`	string	Non	Text content of the first message. Optional, but at least one of text, media, attachment, or link is required
`mediaUrl`	string	Non	Optional publicly accessible HTTPS URL of an image, video, or file to attach
`attachmentId`	string	Non	Optional ID of a pre-uploaded attachment to send instead of a media URL
`preferredService`	string	Non	Preferred delivery service: iMessage, SMS, or RCS
`effectName`	string	Non	Optional iMessage effect name (e.g. confetti, fireworks, lasers)
`effectType`	string	Non	Optional effect type: screen or bubble
`replyToMessageId`	string	Non	Optional message ID to reply to inline
`replyToPartIndex`	number	Non	Optional part index of the message being replied to
`idempotencyKey`	string	Non	Optional idempotency key to safely retry the request

Sortie

Paramètre	Type	Description
`chatId`	string	ID of the created chat
`displayName`	string	Display name of the chat
`isGroup`	boolean	Whether the chat is a group chat
`service`	string	Delivery service used (iMessage, SMS, RCS)
`handles`	json	Participant handles in the chat
`healthStatus`	json	Messaging line health status
`message`	json	The sent message object with parts and delivery info

`linq_create_contact_card`

Set up a contact card (Name and Photo Sharing) for a phone number

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`phoneNumber`	string	Oui	Phone number in E.164 format the card applies to
`firstName`	string	Oui	First name to display
`lastName`	string	Non	Last name to display
`imageUrl`	string	Non	Profile photo URL

Sortie

Paramètre	Type	Description
`phoneNumber`	string	Phone number the card applies to
`firstName`	string	First name
`lastName`	string	Last name
`imageUrl`	string	Profile photo URL
`isActive`	boolean	Whether the card is active

`linq_create_webhook_subscription`

Subscribe an HTTPS endpoint to Linq webhook events

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`targetUrl`	string	Oui	HTTPS endpoint that will receive webhook events
`subscribedEvents`	array	Oui	Event types to subscribe to (e.g. message.sent, message.delivered)
`phoneNumbers`	array	Non	E.164 phone numbers to filter events by (omit for all numbers)

Sortie

Paramètre	Type	Description
`id`	string	Subscription ID
`targetUrl`	string	Endpoint that receives events
`subscribedEvents`	json	Subscribed event types
`phoneNumbers`	json	Filtered phone numbers (null = all)
`isActive`	boolean	Whether the subscription is active
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 update timestamp
`signingSecret`	string	HMAC-SHA256 signing secret. Store securely — it cannot be retrieved again

`linq_delete_attachment`

Permanently delete an attachment owned by your account

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`attachmentId`	string	Oui	The unique identifier of the attachment to delete

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the attachment was deleted

`linq_delete_message`

Delete a message from the Linq API only (does not unsend it; recipients still see it)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`messageId`	string	Oui	The unique identifier of the message to delete

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the message was deleted

`linq_delete_webhook_subscription`

Delete a webhook subscription from your account

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`subscriptionId`	string	Oui	The unique identifier of the webhook subscription to delete

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the subscription was deleted

`linq_edit_message`

Edit the text of a sent message (up to 5 times, within 15 minutes of sending; iMessage only)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`messageId`	string	Oui	The unique identifier of the message to edit
`text`	string	Oui	New text content for the message part
`partIndex`	number	Non	Index of the message part to edit (defaults to 0)

Sortie

Paramètre	Type	Description
`id`	string	Message ID
`chatId`	string	ID of the chat the message belongs to
`isFromMe`	boolean	Whether the message was sent by you
`isDelivered`	boolean	Whether the message was delivered
`isRead`	boolean	Whether the message was read
`service`	string	Delivery service (iMessage, SMS, RCS)
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 update timestamp
`sentAt`	string	ISO 8601 sent timestamp
`parts`	json	Updated message parts with reactions
`message`	json	The full updated message object

`linq_get_attachment`

Retrieve metadata for an attachment, including its download URL and status

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`attachmentId`	string	Oui	The unique identifier of the attachment

Sortie

Paramètre	Type	Description
`id`	string	Attachment ID
`filename`	string	File name
`contentType`	string	MIME type of the file
`sizeBytes`	number	File size in bytes
`status`	string	Upload status (pending, complete, failed)
`downloadUrl`	string	URL to download the file
`createdAt`	string	ISO 8601 creation timestamp

`linq_get_chat`

Retrieve a chat by ID, including participants and line health

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat

Sortie

Paramètre	Type	Description
`id`	string	Chat ID
`displayName`	string	Display name of the chat
`isGroup`	boolean	Whether the chat is a group chat
`isArchived`	boolean	Whether the chat is archived
`service`	string	Delivery service (iMessage, SMS, RCS)
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 update timestamp
`handles`	json	Participant handles in the chat
`healthStatus`	json	Messaging line health status

`linq_get_contact_card`

Retrieve contact cards, optionally filtered by phone number

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`phoneNumber`	string	Non	E.164 phone number to filter by (omit to return all cards)

Sortie

Paramètre	Type	Description
`contactCards`	array	Contact cards on the account
↳ `phoneNumber`	string	Phone number in E.164 format
↳ `firstName`	string	First name
↳ `lastName`	string	Last name
↳ `imageUrl`	string	Profile photo URL
↳ `isActive`	boolean	Whether the card is active

`linq_get_message`

Retrieve a single message by ID, including parts, reactions, and delivery status

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`messageId`	string	Oui	The unique identifier of the message

Sortie

Paramètre	Type	Description
`id`	string	Message ID
`chatId`	string	ID of the chat the message belongs to
`isFromMe`	boolean	Whether the message was sent by you
`isDelivered`	boolean	Whether the message was delivered
`isRead`	boolean	Whether the message was read
`service`	string	Delivery service (iMessage, SMS, RCS)
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 update timestamp
`sentAt`	string	ISO 8601 sent timestamp
`parts`	json	Message parts (text, media, link) with reactions
`message`	json	The full message object

`linq_get_webhook_subscription`

Retrieve a webhook subscription by ID

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`subscriptionId`	string	Oui	The unique identifier of the webhook subscription

Sortie

Paramètre	Type	Description
`id`	string	Subscription ID
`targetUrl`	string	Endpoint that receives events
`subscribedEvents`	json	Subscribed event types
`phoneNumbers`	json	Filtered phone numbers (null = all)
`isActive`	boolean	Whether the subscription is active
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 update timestamp

`linq_leave_chat`

Leave an iMessage group chat (4+ active participants; not supported for direct chats)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the group chat

Sortie

Paramètre	Type	Description
`message`	string	Human-readable status message
`status`	string	Queued action status (e.g. accepted)
`traceId`	string	Trace ID for the queued action

`linq_list_chats`

List chats, optionally filtered by sender or participant handle

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`from`	string	Non	Filter by sender phone number in E.164 format
`to`	string	Non	Filter by participant handle (phone number or email)
`limit`	number	Non	Results per page (default 20, max 100)
`cursor`	string	Non	Pagination cursor from a previous response

Sortie

Paramètre	Type	Description
`chats`	json	Array of chat objects
`nextCursor`	string	Cursor for the next page, or null if there are no more results

`linq_list_messages`

List messages in a chat with pagination

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat
`limit`	number	Non	Maximum number of messages to return
`cursor`	string	Non	Pagination cursor from a previous response

Sortie

Paramètre	Type	Description
`messages`	json	Array of message objects with parts and reactions
`nextCursor`	string	Cursor for the next page, or null if there are no more results

`linq_list_phone_numbers`

List all phone numbers assigned to your partner account, with line health

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key

Sortie

Paramètre	Type	Description
`phoneNumbers`	array	Phone numbers assigned to the account
↳ `id`	string	Phone number ID
↳ `phoneNumber`	string	Phone number in E.164 format
↳ `healthStatus`	json	Line health status (status, doc_url)

`linq_list_thread`

List all messages in the thread that contains a given message

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`messageId`	string	Oui	The ID of any message in the thread
`order`	string	Non	Sort order: asc (oldest first) or desc (newest first)
`limit`	number	Non	Maximum number of messages to return
`cursor`	string	Non	Pagination cursor from a previous response

Sortie

Paramètre	Type	Description
`messages`	json	Array of message objects in the thread
`nextCursor`	string	Cursor for the next page, or null if there are no more results

`linq_list_webhook_events`

List all webhook event types available to subscribe to

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key

Sortie

Paramètre	Type	Description
`events`	json	Available webhook event type names
`docUrl`	string	Documentation URL for webhook events

`linq_list_webhook_subscriptions`

List all webhook subscriptions on your account

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key

Sortie

Paramètre	Type	Description
`subscriptions`	array	Webhook subscriptions
↳ `id`	string	Subscription ID
↳ `targetUrl`	string	Endpoint that receives events
↳ `subscribedEvents`	json	Subscribed event types
↳ `phoneNumbers`	json	Filtered phone numbers (null = all)
↳ `isActive`	boolean	Whether the subscription is active
↳ `createdAt`	string	ISO 8601 creation timestamp
↳ `updatedAt`	string	ISO 8601 update timestamp

`linq_mark_chat_read`

Mark all messages in a chat as read

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the chat was marked as read

`linq_react_to_message`

Add or remove a tapback reaction on a message

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`messageId`	string	Oui	The unique identifier of the message to react to
`operation`	string	Oui	Whether to add or remove the reaction: add or remove
`type`	string	Oui	Reaction type: love, like, dislike, laugh, emphasize, question, custom, or sticker
`customEmoji`	string	Non	Emoji to use when type is custom
`partIndex`	number	Non	Index of the message part to react to (defaults to the entire message)

Sortie

Paramètre	Type	Description
`message`	string	Human-readable status message
`status`	string	Queued action status
`traceId`	string	Trace ID for the queued action

`linq_remove_participant`

Remove a participant from a group chat (minimum 3 participants must remain)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the group chat
`handle`	string	Oui	Phone number (E.164 format) or email address of the participant to remove

Sortie

Paramètre	Type	Description
`message`	string	Human-readable status message
`status`	string	Queued action status
`traceId`	string	Trace ID for the queued action

`linq_send_message`

Send a message to an existing chat, with optional media, link, effect, or reply

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat
`text`	string	Non	Text content of the message. Optional, but at least one of text, media, attachment, or link is required
`mediaUrl`	string	Non	Optional publicly accessible HTTPS URL of an image, video, or file to attach
`attachmentId`	string	Non	Optional ID of a pre-uploaded attachment to send instead of a media URL
`linkUrl`	string	Non	Optional URL to send as a rich link preview. Linq requires a link to be its own message, so when set, text and media are ignored
`preferredService`	string	Non	Preferred delivery service: iMessage, SMS, or RCS
`effectName`	string	Non	Optional iMessage effect name (e.g. confetti, fireworks, lasers)
`effectType`	string	Non	Optional effect type: screen or bubble
`replyToMessageId`	string	Non	Optional message ID to reply to inline
`replyToPartIndex`	number	Non	Optional part index of the message being replied to
`idempotencyKey`	string	Non	Optional idempotency key to safely retry the request

Sortie

Paramètre	Type	Description
`chatId`	string	ID of the chat the message was sent to
`messageId`	string	ID of the sent message
`deliveryStatus`	string	Delivery status (pending, queued, sent, delivered, failed)
`sentAt`	string	ISO 8601 timestamp the message was sent
`service`	string	Delivery service (iMessage, SMS, RCS)
`message`	json	The full sent message object with parts

`linq_send_voice_memo`

Send a voice memo to a chat from a URL or a pre-uploaded attachment

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat
`voiceMemoUrl`	string	Non	Publicly accessible HTTPS URL of the audio file (MP3, M4A, AAC, CAF, WAV, AIFF, AMR)
`attachmentId`	string	Non	ID of a pre-uploaded audio attachment (use instead of voiceMemoUrl)

Sortie

Paramètre	Type	Description
`id`	string	ID of the sent voice memo message
`status`	string	Delivery status
`from`	string	Sender handle
`to`	json	Recipient handles
`service`	string	Delivery service (iMessage, SMS, RCS)
`voiceMemo`	json	Audio file metadata (id, filename, mime_type, size_bytes, url, duration_ms)

`linq_share_contact_card`

Share your configured contact card (Name and Photo Sharing) with a chat

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the contact card was shared

`linq_start_typing`

Show a typing indicator in a one-on-one chat (iMessage only, not group chats)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the typing indicator was sent

`linq_stop_typing`

Stop the typing indicator in a one-on-one chat (iMessage only, not group chats)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the typing indicator was stopped

`linq_update_chat`

Update chat properties such as group display name and icon

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`chatId`	string	Oui	The unique identifier of the chat
`displayName`	string	Non	New display name for the group chat
`groupChatIcon`	string	Non	New group chat icon (publicly accessible image URL)

Sortie

Paramètre	Type	Description
`chatId`	string	ID of the updated chat
`status`	string	Status of the queued update

`linq_update_contact_card`

Partially update an existing active contact card for a phone number

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`phoneNumber`	string	Oui	Phone number in E.164 format identifying the card to update
`firstName`	string	Non	New first name
`lastName`	string	Non	New last name
`imageUrl`	string	Non	New profile photo URL

Sortie

Paramètre	Type	Description
`phoneNumber`	string	Phone number the card applies to
`firstName`	string	First name
`lastName`	string	Last name
`imageUrl`	string	Profile photo URL
`isActive`	boolean	Whether the card is active

`linq_update_webhook_subscription`

Update a webhook subscription (target URL, events, phone filter, or active state)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	Linq API key
`subscriptionId`	string	Oui	The unique identifier of the webhook subscription
`targetUrl`	string	Non	New HTTPS endpoint that will receive events
`subscribedEvents`	array	Non	New set of event types to subscribe to
`phoneNumbers`	array	Non	New set of E.164 phone numbers to filter by
`isActive`	boolean	Non	Whether the subscription should be active

Sortie

Paramètre	Type	Description
`id`	string	Subscription ID
`targetUrl`	string	Endpoint that receives events
`subscribedEvents`	json	Subscribed event types
`phoneNumbers`	json	Filtered phone numbers (null = all)
`isActive`	boolean	Whether the subscription is active
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 update timestamp

On this page

Instructions d'utilisation

linq_add_participant

linq_check_imessage

linq_check_rcs

linq_create_attachment

linq_create_chat

linq_create_contact_card

linq_create_webhook_subscription

linq_delete_attachment

linq_delete_message

linq_delete_webhook_subscription

linq_edit_message

linq_get_attachment

linq_get_chat

linq_get_contact_card

linq_get_message

linq_get_webhook_subscription

linq_leave_chat

linq_list_chats

linq_list_messages

linq_list_phone_numbers

linq_list_thread

linq_list_webhook_events

linq_list_webhook_subscriptions

linq_mark_chat_read

linq_react_to_message

linq_remove_participant

linq_send_message

linq_send_voice_memo

linq_share_contact_card

linq_start_typing

linq_stop_typing

linq_update_chat

linq_update_contact_card

linq_update_webhook_subscription