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.

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

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"}}'

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

messages delete <id> accepts -f, --force, --non-interactive and --json. With --json it never prompts, needs -f/--force and prints { "messageId": "<id>", "deleted": true }.

List and manage contacts in the Conversation API.

sinch conversation contacts list [options]

contacts delete options:

With --json, contacts delete never prompts, needs -f/--force and prints { "contactId": "<id>", "deleted": true }.

List conversations in a Conversation API app.

sinch conversation conversations list [options]
sinch conversation conversations get <conversation-id> [--json]

conversations list options:

conversations stop <id> accepts -f, --force, --non-interactive and --json. With --json it never prompts, needs -f/--force and prints { "conversationId": "<id>", "stopped": true }.

Manage Conversation API apps.

apps create also accepts (every field of the Conversation API app create request):

With a name (sinch conversation apps create "My App") the command never prompts and sends only the flags you pass. Without a name it prompts for the name and then for each setting above; flags given alongside pre-fill the prompt defaults. Accepting every default sends the display name, processing mode CONVERSATION, metadata report view NONE and retention type MESSAGE_EXPIRE_POLICY; empty answers are omitted. The dispatch retention prompts appear only when the processing mode is DISPATCH.

apps update <id> accepts the same flags as apps create, plus --display-name <name>, and never prompts when a field flag is given. --smart-conversation and --fallback also have off forms, --no-smart-conversation and --no-fallback. The command sends an update_mask listing only the top-level fields you passed, so everything else (channel credentials included) stays as it is. With no field flags in a terminal it fetches the app and prompts for the display name and each setting above with the current value as the default, then sends only the fields whose value changed; if nothing changed it prints No changes and does not call the API. Without a terminal and without field flags it fails without calling the API.

apps delete also accepts:

With --json, apps delete never prompts, needs -f/--force and prints { "appId": "<id>", "deleted": true }.

Manage webhooks for Conversation apps.

webhooks create always creates the webhook with target_type: HTTP. It also accepts these, and asks for any of app, URL and triggers that you leave out:

webhooks update also accepts:

webhooks delete also accepts:

With --json, webhooks delete never prompts, needs -f/--force and prints { "webhookId": "<id>", "deleted": true }.

Manage Conversation message templates via the templatesV2 API.

templates delete also accepts:

With --json, templates delete never prompts, needs -f/--force and prints { "templateId": "<id>", "deleted": true }.