Skip to content

sinch conversation

Interact with the Sinch Conversation API: send messages, manage contacts, list conversations, configure apps, webhooks, and templates. See Sinch Conversation API on developers.sinch.com for product documentation.

SMS is sent via sinch conversation send --channel SMS.

sinch conversation send

Send a message via the Conversation API. Supports 8 message types: text, media, template, card, carousel, choice, location, and list. Run without arguments for an interactive wizard that guides you through message type selection and type-specific fields.

Syntax

sinch conversation send [recipient] [message] [options]

Options

OptionDescription
[recipient]Recipient phone number in E.164 format
[message]Message text (for text messages)
-c, --channel <channel>Channel: SMS, WHATSAPP, MESSENGER, INSTAGRAM, VIBER, TELEGRAM, RCS, LINE
-a, --app <app-id>Conversation App ID (uses default if configured)
-t, --type <type>Message type: text, media, template, card, carousel, choice, location, list
-m, --media <url>Media URL for media messages
--caption <text>Caption for media messages
--template <name>Template ID for template messages
-p, --params <json>Template parameters as JSON
--locationSend a location message
--lat <latitude>Latitude (required with --location)
--lng <longitude>Longitude (required with --location)
-n, --name <name>Location name
--json-message <json>Raw message body as JSON (escape hatch for any message structure)
--jsonOutput result as JSON

Channel selection. The CLI looks up which channels the target app actually has configured. In the interactive picker, only those channels are offered (it falls back to the full list if the lookup fails). If you pass -c, --channel explicitly for a channel the app doesn't have configured, the command fails fast with guidance instead of letting the send fail at the API — add the channel's credentials at dashboard.sinch.com/convapi/apps.

Examples

# Interactive wizard — message type is the first question
sinch conversation send

# Direct text message
sinch conversation send +15551234567 "Hello from Sinch" --channel SMS

# Media message
sinch conversation send +15551234567 --channel WHATSAPP --media https://example.com/image.jpg --caption "Check this out"

# Raw JSON escape hatch
sinch conversation send +15551234567 -c WHATSAPP --json-message '{"text_message":{"text":"hi"}}'

sinch conversation messages

Manage conversation messages: list, get, delete, and update metadata.

SubcommandDescription
sinch conversation messages listList messages
sinch conversation messages get <id>Get a specific message by ID
sinch conversation messages delete <id>Delete a message
sinch conversation messages update <id> --metadata <json>Update message metadata
OptionDescription
-c, --channel <channel>Filter by channel
-l, --limit <number>Maximum messages to return
--jsonOutput as JSON

sinch conversation contacts

List and manage contacts in the Conversation API.

sinch conversation contacts [options]
OptionDescription
-a, --app <app-id>Conversation App ID
-l, --limit <number>Maximum contacts to return
--jsonOutput as JSON

sinch conversation conversations

List conversations in a Conversation API app.

sinch conversation conversations [options]
OptionDescription
-a, --app <app-id>Conversation App ID
-s, --state <state>Filter by state: ACTIVE, INACTIVE, CLOSED
-l, --limit <number>Maximum conversations to return
--jsonOutput as JSON

sinch conversation apps

Manage Conversation API apps.

SubcommandDescription
sinch conversation apps listList Conversation apps
sinch conversation apps get <id>Get a Conversation app by ID
sinch conversation apps create [name]Create a new Conversation app
sinch conversation apps delete <id>Delete a Conversation app
OptionDescription
-l, --limit <number>Maximum apps to return
--jsonOutput as JSON

sinch conversation webhooks

Manage webhooks for Conversation apps.

SubcommandDescription
sinch conversation webhooks listList webhooks for an app
sinch conversation webhooks createCreate a new webhook (interactive)
sinch conversation webhooks update <id>Update a webhook
sinch conversation webhooks delete <id>Delete a webhook
OptionDescription
-a, --app <app-id>Conversation App ID
--jsonOutput as JSON

sinch conversation templates

Manage Conversation message templates via the templatesV2 API.

SubcommandDescription
sinch conversation templates listList all message templates
sinch conversation templates get <id>Get a template by ID (with translations)
sinch conversation templates createCreate a new message template (interactive)
sinch conversation templates delete <id>Delete a message template
OptionDescription
--jsonOutput as JSON
We'd love to hear from you!
Rate this content: