> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Sinch

The Sinch connector lets your AI agent act in each user's Sinch account. Each user signs in to Sinch once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 50 tools.

**Authentication:** Project Access Key (OAuth 2.0 Client Credentials)
**Categories:** Communication, Marketing
**Tools:** 50: 24 read, 19 write, 7 destructive
**Users sign in with:** Service account
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=SINCH)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Sinch connection

   In **AgentKit > Connections**, create a Sinch connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'sinch_app_get',
  toolInput: {
    app_id: '<app_id>',
    project_id: '<project_id>',
  },
  connector: 'sinch',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="sinch_app_get",
    tool_input={
        "app_id": "<app_id>",
        "project_id": "<project_id>",
    },
    connection_name="sinch",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `sinch_app_get`

Get App · Read-only

Get one Conversation API app.
Returns id, display_name, channel_credentials, conversation_metadata_report_view, processing_mode and retention_policy.
Use sinch_app_get to see which channels an app can send on.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"app_id":"<app_id>","project_id":"<project_id>"}`

### `sinch_apps_list`

List Apps · Read-only

List the Conversation API apps in a Sinch project.
Returns apps with id, display_name, channel_credentials (channels set up) and processing_mode.
Use sinch_apps_list to find the app_id that the send tools need.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"project_id":"<project_id>"}`

### `sinch_consents_list`

List Opt-outs · Read-only

List the channel identities on one of an app's consent (opt-out) lists.
Returns identities with channel and identity, plus next_page_token.
Use sinch_consents_list to check who has opted out before a campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `list_type` (`string`, required): Which list: OPT_OUT_ALL, OPT_OUT_MARKETING or OPT_OUT_NOTIFICATION. Example: OPT_OUT_MARKETING. One of: `OPT_OUT_ALL`, `OPT_OUT_MARKETING`, `OPT_OUT_NOTIFICATION`.
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `page_size` (`integer`, optional): Records per page, up to 50. Defaults to 10. Example: 50
- `page_token` (`string`, optional): Page token from the previous response. Example: CgwI4dCWnAYQ0P3u3QM

Example input: `{"app_id":"<app_id>","list_type":"OPT_OUT_ALL","project_id":"<project_id>"}`

### `sinch_contact_channel_profile_get`

Get Channel Profile · Read-only

Fetch a user's public profile name from Messenger, Instagram, Viber or LINE for a contact or channel identity.
Returns profile_name.
Use sinch_contact_channel_profile_get to personalise replies on social channels.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `profile_channel` (`string`, required): Channel to read the profile from. Example: MESSENGER. One of: `MESSENGER`, `INSTAGRAM`, `VIBER`, `LINE`.
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `channel` (`string`, optional): Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `contact_id` (`string`, optional): ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `identity` (`string`, optional): The recipient's address on that channel: a phone number in E.164 format (with or without +) for SMS, MMS, RCS and WhatsApp, or the channel's user ID for Messenger, Instagram, Viber, LINE and others. Used with channel. Example: +46732001122

Example input: `{"app_id":"<app_id>","profile_channel":"MESSENGER","project_id":"<project_id>"}`

### `sinch_contact_get`

Get Contact · Read-only

Get one Sinch Conversation API contact by ID.
Returns id, display_name, channel_identities, channel_priority, email, external_id, language and metadata.
Use sinch_contact_get for one contact. Use sinch_contacts_list to search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"contact_id":"<contact_id>","project_id":"<project_id>"}`

### `sinch_contacts_list`

List Contacts · Read-only

List the contacts in a Sinch project, or find one by external ID or by channel identity.
Returns contacts with id, display_name, channel_identities, email, external_id and language, plus next_page_token.
Use sinch_contacts_list to search contacts. Use sinch_contact_get when you have the contact ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `channel` (`string`, optional): Channel of identity; set together with identity. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `external_id` (`string`, optional): Only the contact with this ID from your own system. Do not combine with channel and identity. Example: crm-5678
- `identity` (`string`, optional): Only the contact with this address on channel, for example a phone number. Example: 46732001122
- `page_size` (`integer`, optional): Contacts per page, up to 20. Defaults to 10. Example: 20
- `page_token` (`string`, optional): next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM

Example input: `{"project_id":"<project_id>"}`

### `sinch_conversation_get`

Get Conversation · Read-only

Get one Sinch Conversation API conversation by ID.
Returns id, app_id, contact_id, active, active_channel, last_received and metadata_json.
Use sinch_conversation_get for one conversation. Use sinch_messages_list with conversation_id for its messages.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"conversation_id":"<conversation_id>","project_id":"<project_id>"}`

### `sinch_conversations_list`

List Conversations · Read-only

List Sinch Conversation API conversations, filtered by app, contact, channel or active state.
Returns conversations with id, app_id, contact_id, active, active_channel and last_received, plus next_page_token.
Use sinch_conversations_list to find a contact's conversations. Use sinch_conversations_recent_list for an app's most recent conversations with their last message.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `only_active` (`boolean`, required): true for active conversations only, false for inactive only. Example: true
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `active_channel` (`string`, optional): Only conversations whose active channel is this one. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `app_id` (`string`, optional): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `contact_id` (`string`, optional): Only conversations with this contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `page_size` (`integer`, optional): Conversations per page, up to 20. Defaults to 10. Example: 20
- `page_token` (`string`, optional): next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM

Example input: `{"only_active":true,"project_id":"<project_id>"}`

### `sinch_conversations_recent_list`

List Recent Conversations · Read-only

List an app's conversations ordered by their latest message, each with that last message.
Returns conversations, each with its conversation and last_message, plus next_page_token.
Use sinch_conversations_recent_list for an inbox-style view. Use sinch_conversations_list to filter by contact or channel.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `only_active` (`boolean`, optional): true for active conversations only. Example: false
- `order` (`string`, optional): DESC (default) for newest first, ASC for oldest first. Example: DESC. One of: `ASC`, `DESC`.
- `page_size` (`integer`, optional): Conversations per page, up to 50. Defaults to 10. Example: 20
- `page_token` (`string`, optional): next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM

Example input: `{"app_id":"<app_id>","project_id":"<project_id>"}`

### `sinch_message_get`

Get Message · Read-only

Get one Sinch Conversation API message by ID.
Returns the message with direction, channel_identity, app_message or contact_message content, accept_time, conversation_id and metadata.
Use sinch_message_get for one message. Use sinch_messages_list to browse messages of a conversation or contact.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`string`, required): ID of the message. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `messages_source` (`string`, optional): CONVERSATION_SOURCE (default) or DISPATCH_SOURCE for messages sent in dispatch mode. Example: CONVERSATION_SOURCE. One of: `CONVERSATION_SOURCE`, `DISPATCH_SOURCE`.

Example input: `{"message_id":"<message_id>","project_id":"<project_id>"}`

### `sinch_messages_list`

List Messages · Read-only

List Sinch Conversation API messages, filtered by conversation, contact, app, channel, direction or time.
Returns messages (newest first) and next_page_token.
Use sinch_messages_list to read a conversation's history or check replies. Use sinch_message_get for one message.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `app_id` (`string`, optional): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `channel` (`string`, optional): Only messages on this channel. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `channel_identity` (`string`, optional): Only messages to or from this channel identity (for example a phone number). Used in dispatch mode. Example: 46732001122
- `contact_id` (`string`, optional): Only messages with this contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `conversation_id` (`string`, optional): Only messages in this conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `direction` (`string`, optional): TO_APP for inbound, TO_CONTACT for outbound. Defaults to both. Example: TO_APP. One of: `TO_APP`, `TO_CONTACT`.
- `end_time` (`string`, optional): Only messages accepted before this time (RFC 3339). Example: 2026-11-02T00:00:00Z
- `messages_source` (`string`, optional): CONVERSATION_SOURCE (default) or DISPATCH_SOURCE. Example: CONVERSATION_SOURCE. One of: `CONVERSATION_SOURCE`, `DISPATCH_SOURCE`.
- `only_recipient_originated` (`boolean`, optional): true to list only messages sent by contacts. Example: false
- `page_size` (`integer`, optional): Messages per page, up to 1000. Defaults to 10. Example: 50
- `page_token` (`string`, optional): next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM
- `start_time` (`string`, optional): Only messages accepted after this time (RFC 3339). Example: 2026-11-01T00:00:00Z

Example input: `{"project_id":"<project_id>"}`

### `sinch_number_active_get`

Get Active Number · Read-only

Get one phone number your Sinch project rents, with its SMS and voice configuration.
Returns phoneNumber, regionCode, type, capability, displayName, money, smsConfiguration, voiceConfiguration and expireAt.
Use sinch_number_active_get for one number. Use sinch_numbers_active_list to browse.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `phone_number` (`string`, required): Phone number in E.164 format with leading +. Example: +12065550100
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"phone_number":"<phone_number>","project_id":"<project_id>"}`

### `sinch_number_available_get`

Check Available Number · Read-only

Check whether one specific phone number is available to rent from Sinch, and its price.
Returns phoneNumber, regionCode, type, capability, setupPrice, monthlyPrice and paymentIntervalMonths.
Use sinch_number_available_get to confirm a number before ordering it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `phone_number` (`string`, required): Phone number in E.164 format with leading +. Example: +12065550100
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"phone_number":"<phone_number>","project_id":"<project_id>"}`

### `sinch_number_callback_config_get`

Get Numbers Callback Config · Read-only

Get the Numbers API callback settings for a Sinch project.
Returns projectId and hmacSecret used to sign number provisioning callbacks.
Use sinch_number_callback_config_get to read the signing secret for number callbacks.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"project_id":"<project_id>"}`

### `sinch_number_order_get`

Get Number Order · Read-only

Get a Sinch number order and its status.
Returns id, status, regionCode, numberType, the ordered numbers and any registration problems.
Use sinch_number_order_get to track an order after sinch_number_order_submit.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `number_order_id` (`string`, required): ID of the number order. Example: 9b2c7f4e-1a3d-4e5f-8a9b-0c1d2e3f4a5b
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"number_order_id":"<number_order_id>","project_id":"<project_id>"}`

### `sinch_number_regions_list`

List Number Regions · Read-only

List the countries where Sinch offers numbers, optionally only for given number types.
Returns availableRegions with regionCode, regionName and types.
Use sinch_number_regions_list to find where you can rent numbers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `types` (`array`, optional): Only regions offering these number types. Example: ["MOBILE"]

Example input: `{"project_id":"<project_id>"}`

### `sinch_number_requirements_lookup`

Look Up Number Requirements · Read-only

Look up what Sinch needs before you can order a number type in a country: KYC documents, address and business details.
Returns the required fields and documents for that country and number type.
Use sinch_number_requirements_lookup before sinch_number_order_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `number_type` (`string`, required): LOCAL, MOBILE or TOLL_FREE. Example: MOBILE. One of: `LOCAL`, `MOBILE`, `TOLL_FREE`.
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `region_code` (`string`, required): ISO 3166-1 alpha-2 country code. Example: DE

Example input: `{"number_type":"LOCAL","project_id":"<project_id>","region_code":"<region_code>"}`

### `sinch_numbers_active_list`

List Active Numbers · Read-only

List the phone numbers your Sinch project rents.
Returns activeNumbers with phoneNumber, regionCode, type, capability, displayName, smsConfiguration, voiceConfiguration and nextChargeDate, plus nextPageToken.
Use sinch_numbers_active_list to find your sender numbers. Use sinch_number_active_get for one number.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `region_code` (`string`, required): Only numbers in this ISO 3166-1 alpha-2 country. Example: US
- `type` (`string`, required): Only this number type. Example: LOCAL. One of: `LOCAL`, `MOBILE`, `TOLL_FREE`.
- `capability` (`array`, optional): Only numbers with these capabilities. Example: ["SMS"]
- `order_by` (`string`, optional): Sort by phoneNumber or displayName. Example: phoneNumber. One of: `phoneNumber`, `displayName`.
- `page_size` (`integer`, optional): Numbers per page. Example: 50
- `page_token` (`string`, optional): nextPageToken from the previous page. Example: CgwI4dCWnAYQ0P3u3QM
- `pattern` (`string`, optional): Digits the number must contain; use with search_pattern. Example: 206
- `search_pattern` (`string`, optional): Where pattern must appear: START, CONTAINS or END. Example: START. One of: `START`, `CONTAINS`, `END`.

Example input: `{"project_id":"<project_id>","region_code":"<region_code>","type":"LOCAL"}`

### `sinch_numbers_available_list`

Search Available Numbers · Read-only

Search the phone numbers Sinch has available to rent in a country.
Returns availableNumbers with phoneNumber, regionCode, type, capability, setupPrice, monthlyPrice and supportingDocumentationRequired.
Use sinch_numbers_available_list before sinch_number_order_create. Use sinch_numbers_active_list for numbers you already have.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `region_code` (`string`, required): ISO 3166-1 alpha-2 country code, for example US, GB or SE. Example: US
- `type` (`string`, required): Number type: LOCAL, MOBILE or TOLL_FREE. Example: LOCAL. One of: `LOCAL`, `MOBILE`, `TOLL_FREE`.
- `capabilities` (`array`, optional): Required capabilities: SMS and/or VOICE. Example: ["SMS"]
- `pattern` (`string`, optional): Digits the number must contain; use with search_pattern. Example: 206
- `search_pattern` (`string`, optional): Where pattern must appear: START, CONTAINS or END. Example: START. One of: `START`, `CONTAINS`, `END`.
- `size` (`integer`, optional): Maximum numbers to return. Example: 10

Example input: `{"project_id":"<project_id>","region_code":"<region_code>","type":"LOCAL"}`

### `sinch_template_get`

Get Template · Read-only

Get one Sinch omni-channel template with all its translations.
Returns id, description, version, default_translation and translations with their message content and variables.
Use sinch_template_get to see a template's variables before sending it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `template_id` (`string`, required): ID of the template. Example: order-shipped

Example input: `{"project_id":"<project_id>","template_id":"<template_id>"}`

### `sinch_template_translations_list`

List Template Translations · Read-only

List the translations of a Sinch template, optionally for one language or version.
Returns translations with language_code, version, the message content and variables.
Use sinch_template_translations_list to check which languages a template supports.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `template_id` (`string`, required): ID of the template. Example: order-shipped
- `language_code` (`string`, optional): Only this BCP-47 language. Example: en-US
- `translation_version` (`string`, optional): Only this translation version, or latest. Example: latest

Example input: `{"project_id":"<project_id>","template_id":"<template_id>"}`

### `sinch_templates_list`

List Templates · Read-only

List the omni-channel message templates in a Sinch project (Template Management API v2).
Returns templates with id, description, version, default_translation and translations.
Use sinch_templates_list to find a template_id for sinch_message_template_send.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"project_id":"<project_id>"}`

### `sinch_webhook_get`

Get Webhook · Read-only

Get one Conversation API webhook.
Returns id, app_id, target, target_type and triggers.
Use sinch_webhook_get for one webhook. Use sinch_webhooks_list for all webhooks of an app.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `webhook_id` (`string`, required): ID of the webhook. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEG

Example input: `{"project_id":"<project_id>","webhook_id":"<webhook_id>"}`

### `sinch_webhooks_list`

List Webhooks · Read-only

List the webhooks set on a Conversation API app.
Returns webhooks with id, target, triggers and target_type.
Use sinch_webhooks_list to see where an app sends delivery reports and inbound messages.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"app_id":"<app_id>","project_id":"<project_id>"}`

### `sinch_capability_query`

Query Channel Capability · Write

Ask Sinch whether a contact or phone number can be reached on a channel (for example RCS or WhatsApp) and which features it supports.
Returns request_id; the result arrives asynchronously at the app's CAPABILITY webhook.
Use sinch_capability_query before choosing a channel. You need a webhook with the CAPABILITY trigger to read the answer.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `channel` (`string`, optional): Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `contact_id` (`string`, optional): ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `identity` (`string`, optional): The recipient's address on that channel: a phone number in E.164 format (with or without +) for SMS, MMS, RCS and WhatsApp, or the channel's user ID for Messenger, Instagram, Viber, LINE and others. Used with channel. Example: +46732001122
- `request_id` (`string`, optional): Your own ID for this lookup, echoed in the webhook. Generated if omitted. Example: cap-1234

Example input: `{"app_id":"<app_id>","project_id":"<project_id>"}`

### `sinch_contact_create`

Create Contact · Write

Create a Sinch Conversation API contact with one or more channel identities.
Returns the new contact with its id.
Use sinch_contact_create to register someone before messaging them by contact_id. Sending to a channel identity also creates contacts automatically in CONVERSATION mode.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `channel_identities` (`array`, required): The contact's addresses: each has channel and identity (a phone number for SMS/WhatsApp/RCS/MMS, or the channel's user ID), plus app_id for app-scoped channels such as Messenger. Example: [{"channel": "WHATSAPP", "identity": "46732001122"}, {"channel": "SMS", "identity": "46732001122"}]
- `language` (`string`, required): Contact's language, as an uppercase code such as EN_US, EN_GB, DE, SV or ES. Example: EN_US. One of: `AF`, `SQ`, `AR`, `AZ`, `BN`, `BG`, `CA`, `ZH`, `ZH_CN`, `ZH_HK`, `ZH_TW`, `HR`, `CS`, `DA`, `NL`, `EN`, `EN_GB`, `EN_US`, `ET`, `FIL`, `FI`, `FR`, `DE`, `EL`, `GU`, `HA`, `HE`, `HI`, `HU`, `ID`, `GA`, `IT`, `JA`, `KN`, `KK`, `KO`, `LO`, `LV`, `LT`, `MK`, `MS`, `ML`, `MR`, `NB`, `FA`, `PL`, `PT`, `PT_BR`, `PT_PT`, `PA`, `RO`, `RU`, `SR`, `SK`, `SL`, `ES`, `ES_AR`, `ES_ES`, `ES_MX`, `SW`, `SV`, `TA`, `TE`, `TH`, `TR`, `UK`, `UR`, `UZ`, `VI`, `ZU`.
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `channel_priority` (`array`, optional): Channel order to try when messaging this contact. Example: ["WHATSAPP", "SMS"]
- `display_name` (`string`, optional): Display name. Defaults to Unknown. Example: Ana Silva
- `email` (`string`, optional): Email address. Example: ana@example.com
- `external_id` (`string`, optional): The contact's ID in your own system. Example: crm-5678
- `metadata` (`string`, optional): Your own metadata, up to 1024 characters. Example: vip

Example input: `{"channel_identities":[{"channel":"WHATSAPP","identity":"46732001122"},{"channel":"SMS","identity":"46732001122"}],"language":"AF","project_id":"<project_id>"}`

### `sinch_contact_update`

Update Contact · Write

Update a Sinch contact's name, email, language, channel identities, channel priority or metadata.
Returns the updated contact.
Use sinch_contact_update to change contact details. Use sinch_contact_merge to combine duplicates.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `contact_id` (`string`, required): ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `channel_identities` (`array`, optional): Replacement list of channel identities (channel, identity, optional app_id). Example: [{"channel": "SMS", "identity": "46732001122"}]
- `channel_priority` (`array`, optional): Replacement channel priority order. Example: ["SMS"]
- `display_name` (`string`, optional): New display name. Example: Ana Silva
- `email` (`string`, optional): New email address. Example: ana@example.com
- `external_id` (`string`, optional): New external ID. Example: crm-5678
- `language` (`string`, optional): New language code such as EN_US. Example: EN_US
- `metadata` (`string`, optional): New metadata, up to 1024 characters. Example: vip
- `update_mask` (`string`, optional): Comma-separated fields to update, for example display_name and email. Fields not listed are left unchanged; empty updates every field you send. Example: display_name,email

Example input: `{"contact_id":"<contact_id>","project_id":"<project_id>"}`

### `sinch_conversation_create`

Create Conversation · Write

Start a new conversation between a Conversation API app and a contact.
Returns the new conversation.
Use sinch_conversation_create when the app runs in CONVERSATION mode and you want an explicit thread before sending. Sending a message creates one automatically otherwise.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `contact_id` (`string`, required): ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `active` (`boolean`, optional): Whether the conversation starts active. Example: true
- `active_channel` (`string`, optional): Channel the conversation is on. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `correlation_id` (`string`, optional): Your own correlation ID. Example: campaign-42
- `metadata_json` (`object`, optional): Your own JSON metadata for the conversation. Example: {"order_id": "1234"}

Example input: `{"app_id":"<app_id>","contact_id":"<contact_id>","project_id":"<project_id>"}`

### `sinch_conversation_stop`

Stop Conversation · Write

End an active Sinch conversation; the next message to the contact starts a new one.
Returns an empty object on success.
Use sinch_conversation_stop when a support case or flow is finished.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"conversation_id":"<conversation_id>","project_id":"<project_id>"}`

### `sinch_conversation_update`

Update Conversation · Write

Update a Sinch conversation's active state, active channel or metadata.
Returns the updated conversation.
Use sinch_conversation_update to change metadata or the active channel. Use sinch_conversation_stop to end it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `active` (`boolean`, optional): Whether the conversation is active. Example: true
- `active_channel` (`string`, optional): Channel the conversation is on. Example: SMS. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `metadata_json` (`object`, optional): Your own JSON metadata for the conversation. Example: {"order_id": "1234"}
- `metadata_update_strategy` (`string`, optional): REPLACE (default) overwrites metadata_json; MERGE_PATCH merges into it. Example: MERGE_PATCH. One of: `REPLACE`, `MERGE_PATCH`.
- `update_mask` (`string`, optional): Comma-separated fields to update, for example metadata_json. Fields not listed are left unchanged; empty updates every field you send. Example: metadata_json

Example input: `{"conversation_id":"<conversation_id>","project_id":"<project_id>"}`

### `sinch_event_send`

Send Event · Write

Send a non-message event to a contact, such as a typing indicator, a read receipt or an agent joining or leaving.
Returns event_id and accepted_time.
Use sinch_event_send for typing and read signals. Use the message send tools for content.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `event` (`object`, required): The event object with one key: composing_event, composing_end_event, read_message_event (with message_id), agent_joined_event or agent_left_event (with agent), comment_reply_event or generic_event. Example: {"composing_event": {}}
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `channel` (`string`, optional): Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `contact_id` (`string`, optional): ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `identity` (`string`, optional): The recipient's address on that channel: a phone number in E.164 format (with or without +) for SMS, MMS, RCS and WhatsApp, or the channel's user ID for Messenger, Instagram, Viber, LINE and others. Used with channel. Example: +46732001122

Example input: `{"app_id":"<app_id>","event":{},"project_id":"<project_id>"}`

### `sinch_message_media_send`

Send Media Message · Write

Send an image, video, audio or document by URL through the Sinch Conversation API on any channel that supports media.
Returns message_id and accepted_time; delivery is reported to the app's webhooks.
Use sinch_message_media_send for a file. Use sinch_message_text_send for text only.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `url` (`string`, required): Public URL of the media file. Sinch fetches it and picks the media type from the file. Example: https://example.com/files/receipt.jpg
- `callback_url` (`string`, optional): Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
- `channel` (`string`, optional): Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `channel_priority_order` (`array`, optional): Channels to try, in order, when the recipient is a contact with several channel identities. Every channel listed must be set up on the app. Example: ["WHATSAPP", "SMS"]
- `contact_id` (`string`, optional): ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `correlation_id` (`string`, optional): Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
- `filename_override` (`string`, optional): Optional file name shown to the recipient instead of the one in the URL. Example: receipt-1234.jpg
- `identity` (`string`, optional): The recipient's address on that channel: a phone number in E.164 format (with or without +) for SMS, MMS, RCS and WhatsApp, or the channel's user ID for Messenger, Instagram, Viber, LINE and others. Used with channel. Example: +46732001122
- `message_content_type` (`string`, optional): Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATION. One of: `CONTENT_UNKNOWN`, `CONTENT_MARKETING`, `CONTENT_NOTIFICATION`.
- `message_metadata` (`string`, optional): Your own metadata for the message, returned in delivery receipts. Example: order-1234
- `processing_strategy` (`string`, optional): DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULT. One of: `DEFAULT`, `DISPATCH_ONLY`.
- `queue` (`string`, optional): Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITY. One of: `NORMAL_PRIORITY`, `HIGH_PRIORITY`.
- `reply_to_message_id` (`string`, optional): ID of an inbound message to reply to (quoted on channels that support it). Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `thumbnail_url` (`string`, optional): Optional public URL of a thumbnail image, used by channels that show one. Example: https://example.com/files/receipt-thumb.jpg
- `ttl` (`string`, optional): How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s

Example input: `{"app_id":"<app_id>","project_id":"<project_id>","url":"<url>"}`

### `sinch_message_send`

Send Message · Write

Send any Sinch Conversation API message type by passing the message object: choice (buttons), card, carousel, list, location, contact info, a WhatsApp channel template, or a channel-specific payload.
Returns message_id and accepted_time; delivery is reported to the app's webhooks.
Use sinch_message_send for rich or channel-specific messages. Use sinch_message_text_send, sinch_message_media_send or sinch_message_template_send for the common cases.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `message` (`object`, required): The message object, with exactly one message type key: text_message, media_message, template_message, choice_message, card_message, carousel_message, list_message, location_message or contact_info_message. It can also carry channel_specific_message, explicit_channel_message or reply_to. For a WhatsApp template use template_message.channel_template.WHATSAPP with template_id, language_code and parameters. Example: {"choice_message": {"text_message": {"text": "Confirm your booking?"}, "choices": [{"text_message": {"text": "Yes"}}, {"text_message": {"text": "No"}}]}}
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `callback_url` (`string`, optional): Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
- `channel` (`string`, optional): Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `channel_priority_order` (`array`, optional): Channels to try, in order, when the recipient is a contact with several channel identities. Every channel listed must be set up on the app. Example: ["WHATSAPP", "SMS"]
- `contact_id` (`string`, optional): ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `correlation_id` (`string`, optional): Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
- `identity` (`string`, optional): The recipient's address on that channel: a phone number in E.164 format (with or without +) for SMS, MMS, RCS and WhatsApp, or the channel's user ID for Messenger, Instagram, Viber, LINE and others. Used with channel. Example: +46732001122
- `message_content_type` (`string`, optional): Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATION. One of: `CONTENT_UNKNOWN`, `CONTENT_MARKETING`, `CONTENT_NOTIFICATION`.
- `message_metadata` (`string`, optional): Your own metadata for the message, returned in delivery receipts. Example: order-1234
- `processing_strategy` (`string`, optional): DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULT. One of: `DEFAULT`, `DISPATCH_ONLY`.
- `queue` (`string`, optional): Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITY. One of: `NORMAL_PRIORITY`, `HIGH_PRIORITY`.
- `ttl` (`string`, optional): How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s

Example input: `{"app_id":"<app_id>","message":{},"project_id":"<project_id>"}`

### `sinch_message_template_send`

Send Template Message · Write

Send a message built from a Sinch omni-channel template (created with sinch_template_create), filling its variables.
Returns message_id and accepted_time; delivery is reported to the app's webhooks.
Use sinch_message_template_send for reusable content across channels. WhatsApp business-initiated messages need an approved WhatsApp template, sent with sinch_message_send and a channel_template.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `template_id` (`string`, required): ID of the Sinch template to send. Example: order-shipped
- `version` (`string`, required): Template version to use, or latest. Example: latest
- `callback_url` (`string`, optional): Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
- `channel` (`string`, optional): Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `channel_priority_order` (`array`, optional): Channels to try, in order, when the recipient is a contact with several channel identities. Every channel listed must be set up on the app. Example: ["WHATSAPP", "SMS"]
- `contact_id` (`string`, optional): ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `correlation_id` (`string`, optional): Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
- `identity` (`string`, optional): The recipient's address on that channel: a phone number in E.164 format (with or without +) for SMS, MMS, RCS and WhatsApp, or the channel's user ID for Messenger, Instagram, Viber, LINE and others. Used with channel. Example: +46732001122
- `language_code` (`string`, optional): BCP-47 language of the translation to send. Defaults to the template's default translation. Example: en-US
- `message_content_type` (`string`, optional): Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATION. One of: `CONTENT_UNKNOWN`, `CONTENT_MARKETING`, `CONTENT_NOTIFICATION`.
- `message_metadata` (`string`, optional): Your own metadata for the message, returned in delivery receipts. Example: order-1234
- `parameters` (`object`, optional): Values for the template variables, as a map of variable name to text. Example: {"name": "Ana", "order_id": "1234"}
- `processing_strategy` (`string`, optional): DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULT. One of: `DEFAULT`, `DISPATCH_ONLY`.
- `queue` (`string`, optional): Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITY. One of: `NORMAL_PRIORITY`, `HIGH_PRIORITY`.
- `ttl` (`string`, optional): How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s

Example input: `{"app_id":"<app_id>","project_id":"<project_id>","template_id":"<template_id>","version":"<version>"}`

### `sinch_message_text_send`

Send Text Message · Write

Send a text message to a contact or phone number through the Sinch Conversation API, on SMS, WhatsApp, RCS, Viber, Messenger or any channel set up on the app.
Returns message_id and accepted_time; delivery is reported to the app's webhooks.
Use sinch_message_text_send for plain text. Use sinch_message_media_send for images and files, sinch_message_template_send for templates, and sinch_message_send for choices, cards, carousels, lists and locations.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `text` (`string`, required): Message text. Channels transcode it; SMS splits long texts into parts. Example: Your order 1234 has shipped.
- `callback_url` (`string`, optional): Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
- `channel` (`string`, optional): Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPP. One of: `SMS`, `RCS`, `WHATSAPP`, `MMS`, `KAKAOTALK`, `KAKAOTALKCHAT`, `VIBERBM`, `LINE`, `INSTAGRAM`, `MESSENGER`, `WECHAT`, `TELEGRAM`.
- `channel_priority_order` (`array`, optional): Channels to try, in order, when the recipient is a contact with several channel identities. Every channel listed must be set up on the app. Example: ["WHATSAPP", "SMS"]
- `contact_id` (`string`, optional): ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `correlation_id` (`string`, optional): Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
- `identity` (`string`, optional): The recipient's address on that channel: a phone number in E.164 format (with or without +) for SMS, MMS, RCS and WhatsApp, or the channel's user ID for Messenger, Instagram, Viber, LINE and others. Used with channel. Example: +46732001122
- `message_content_type` (`string`, optional): Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATION. One of: `CONTENT_UNKNOWN`, `CONTENT_MARKETING`, `CONTENT_NOTIFICATION`.
- `message_metadata` (`string`, optional): Your own metadata for the message, returned in delivery receipts. Example: order-1234
- `processing_strategy` (`string`, optional): DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULT. One of: `DEFAULT`, `DISPATCH_ONLY`.
- `queue` (`string`, optional): Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITY. One of: `NORMAL_PRIORITY`, `HIGH_PRIORITY`.
- `reply_to_message_id` (`string`, optional): ID of an inbound message to reply to (quoted on channels that support it). Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `ttl` (`string`, optional): How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s

Example input: `{"app_id":"<app_id>","project_id":"<project_id>","text":"<text>"}`

### `sinch_number_active_update`

Update Active Number · Write

Change a rented Sinch number's display name, SMS service plan or campaign, voice setup or provisioning callback URL.
Returns the updated number.
Use sinch_number_active_update to point a number at an SMS service plan or a voice app.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `phone_number` (`string`, required): Phone number in E.164 format with leading +. Example: +12065550100
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `callback_url` (`string`, optional): URL Sinch calls when provisioning of this number changes. Example: https://example.com/sinch/numbers
- `display_name` (`string`, optional): Your own name for the number. Example: Support line
- `sms_configuration` (`object`, optional): SMS setup: servicePlanId (required) and, for US 10DLC, campaignId. Example: {"servicePlanId": "a1b2c3d4e5f6", "campaignId": "CABCDEF"}
- `voice_configuration` (`object`, optional): Voice setup: type RTC (with appId), EST (with trunkId) or FAX (with serviceId). Example: {"type": "RTC", "appId": "3d2a1b7c-8e9f-4a0b-9c1d-2e3f4a5b6c7d"}

Example input: `{"phone_number":"<phone_number>","project_id":"<project_id>"}`

### `sinch_number_callback_config_update`

Update Numbers Callback Config · Write

Set the HMAC secret Sinch uses to sign Numbers API callbacks for a project.
Returns the updated callback configuration.
Use sinch_number_callback_config_update to rotate the callback signing secret.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `hmac_secret` (`string`, required): New secret, 32 to 64 characters of letters, digits and hyphens. Example: 4f1e6b2a-9c3d-4e5f-8a7b-6c5d4e3f2a1b-sk
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"hmac_secret":"<hmac_secret>","project_id":"<project_id>"}`

### `sinch_number_order_create`

Create Number Order · Write

Start a Sinch number order, either for one specific available number or for a quantity of numbers matching criteria. Add registration details if the country needs them, then submit it with sinch_number_order_submit.
Returns the order with id, status and the numbers reserved for it.
Use sinch_number_order_create to rent numbers; renting starts charges once the order is fulfilled.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `number_type` (`string`, required): LOCAL, MOBILE or TOLL_FREE. Example: LOCAL. One of: `LOCAL`, `MOBILE`, `TOLL_FREE`.
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `region_code` (`string`, required): ISO 3166-1 alpha-2 country code. Example: US
- `callback_url` (`string`, optional): URL Sinch calls as the order progresses. Example: https://example.com/sinch/orders
- `capabilities` (`array`, optional): With quantity: required capabilities. Example: ["SMS"]
- `pattern` (`string`, optional): With quantity: digits the numbers must contain; use with search_pattern. Example: 206
- `phone_number` (`string`, optional): One specific available number to order, in E.164 format with +. Use either phone_number or quantity. Example: +12065550100
- `quantity` (`integer`, optional): How many matching numbers to order, 1 to 100. Use either quantity or phone_number. Example: 2
- `search_pattern` (`string`, optional): With quantity: where pattern must appear: START, CONTAINS or END. Example: START. One of: `START`, `CONTAINS`, `END`.
- `sequential` (`boolean`, optional): With quantity: true to require consecutive numbers. Example: false
- `sms_configuration` (`object`, optional): SMS setup for the numbers: servicePlanId and, for US 10DLC, campaignId. Example: {"servicePlanId": "a1b2c3d4e5f6"}
- `voice_configuration` (`object`, optional): Voice setup: type RTC (with appId), EST (with trunkId) or FAX (with serviceId). Example: {"type": "RTC", "appId": "3d2a1b7c-8e9f-4a0b-9c1d-2e3f4a5b6c7d"}

Example input: `{"number_type":"LOCAL","project_id":"<project_id>","region_code":"<region_code>"}`

### `sinch_number_order_submit`

Submit Number Order · Write

Submit a Sinch number order for fulfilment. Once fulfilled, the numbers are rented and charged.
Returns the order with its new status.
Use sinch_number_order_submit after sinch_number_order_create and any registration details.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `number_order_id` (`string`, required): ID of the number order. Example: 9b2c7f4e-1a3d-4e5f-8a9b-0c1d2e3f4a5b
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"number_order_id":"<number_order_id>","project_id":"<project_id>"}`

### `sinch_template_create`

Create Template · Write

Create a Sinch omni-channel message template with one or more translations.
Returns the new template with its id and version 1.
Use sinch_template_create for reusable messages sent with sinch_message_template_send. WhatsApp templates are created in the Sinch dashboard and approved by Meta, not here.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `default_translation` (`string`, required): BCP-47 language code of the translation used when a send does not name one. It must be one of the translations. Example: en-US
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `translations` (`array`, required): Translations: each has language_code, variables (list of {key, preview_value}) and one message type key such as text_message or media_message, using ${key} placeholders. Example: [{"language_code": "en-US", "text_message": {"text": "Hi ${name}, order ${order_id} has shipped."}, "variables": [{"key": "name", "preview_value": "Ana"}, {"key": "order_id", "preview_value": "1234"}]}]
- `description` (`string`, optional): Description of the template. Example: Order shipped notification
- `id` (`string`, optional): Your own template ID, unique in the project. Generated if omitted. Example: order-shipped

Example input: `{"default_translation":"<default_translation>","project_id":"<project_id>","translations":[]}`

### `sinch_template_update`

Update Template · Write

Replace a Sinch template's description, default translation and translations, creating a new template version.
Returns the updated template with its new version.
Use sinch_template_update with the current version from sinch_template_get; a stale version is rejected.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `default_translation` (`string`, required): BCP-47 language code of the default translation. Example: en-US
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `template_id` (`string`, required): ID of the template. Example: order-shipped
- `translations` (`array`, required): The full list of translations (replaces the existing list), in the same shape as sinch_template_create. Example: [{"language_code": "en-US", "text_message": {"text": "Hi ${name}, your order has shipped."}, "variables": [{"key": "name", "preview_value": "Ana"}]}]
- `version` (`integer`, required): The template's current version, from sinch_template_get. Example: 1
- `description` (`string`, optional): Description of the template. Example: Order shipped notification

Example input: `{"default_translation":"<default_translation>","project_id":"<project_id>","template_id":"<template_id>","translations":[],"version":1}`

### `sinch_webhook_create`

Create Webhook · Write

Create a webhook that sends a Conversation API app's events (inbound messages, delivery reports and more) to your URL.
Returns the new webhook with its id.
Use sinch_webhook_create to receive replies and delivery receipts. An app can have up to 5 webhooks.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `target` (`string`, required): HTTPS URL that receives the events. Example: https://example.com/sinch/events
- `triggers` (`array`, required): Events to send, for example MESSAGE_INBOUND, MESSAGE_DELIVERY, EVENT_INBOUND, CONVERSATION_START or CAPABILITY. Example: ["MESSAGE_INBOUND", "MESSAGE_DELIVERY"]
- `secret` (`string`, optional): Secret Sinch uses to sign each callback so you can verify it. Example: my-signing-secret

Example input: `{"app_id":"<app_id>","project_id":"<project_id>","target":"<target>","triggers":["MESSAGE_INBOUND","MESSAGE_DELIVERY"]}`

### `sinch_webhook_update`

Update Webhook · Write

Change a Conversation API webhook's target URL, triggers or signing secret.
Returns the updated webhook.
Use sinch_webhook_update to move events to a new URL or change which events are sent.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `target` (`string`, required): HTTPS URL that receives the events. Example: https://example.com/sinch/events
- `webhook_id` (`string`, required): ID of the webhook. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEG
- `secret` (`string`, optional): New signing secret. Example: my-signing-secret
- `triggers` (`array`, optional): Events to send. Example: ["MESSAGE_INBOUND"]
- `update_mask` (`string`, optional): Comma-separated fields to update, for example target and triggers. Example: target,triggers

Example input: `{"project_id":"<project_id>","target":"<target>","webhook_id":"<webhook_id>"}`

### `sinch_contact_delete`

Delete Contact · Destructive

Delete a Sinch Conversation API contact and its conversations.
Returns an empty object on success.
Use sinch_contact_delete for data-removal requests.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"contact_id":"<contact_id>","project_id":"<project_id>"}`

### `sinch_contact_merge`

Merge Contacts · Destructive

Merge a duplicate Sinch contact into another: channel identities and conversations move to the destination and the source contact is deleted.
Returns the merged destination contact.
Use sinch_contact_merge to clean up duplicates found with sinch_contacts_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `destination_id` (`string`, required): ID of the contact to keep. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `source_id` (`string`, required): ID of the contact to merge in and delete. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEF

Example input: `{"destination_id":"<destination_id>","project_id":"<project_id>","source_id":"<source_id>"}`

### `sinch_conversation_delete`

Delete Conversation · Destructive

Delete a Sinch conversation and all its messages from the Conversation API store.
Returns an empty object on success.
Use sinch_conversation_delete for data-removal requests. Use sinch_conversation_stop to only end it.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"conversation_id":"<conversation_id>","project_id":"<project_id>"}`

### `sinch_message_delete`

Delete Message · Destructive

Delete a message from the Sinch Conversation API store. It does not unsend a message already delivered.
Returns an empty object on success.
Use sinch_message_delete to remove stored message content, for example for data-protection requests.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`string`, required): ID of the message. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `messages_source` (`string`, optional): CONVERSATION_SOURCE (default) or DISPATCH_SOURCE. Example: CONVERSATION_SOURCE. One of: `CONVERSATION_SOURCE`, `DISPATCH_SOURCE`.

Example input: `{"message_id":"<message_id>","project_id":"<project_id>"}`

### `sinch_number_release`

Release Number · Destructive

Release a rented Sinch phone number at the end of its billing period. The number stops working and returns to the pool.
Returns the number with its expireAt date.
Use sinch_number_release to stop renting a number you no longer need.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `phone_number` (`string`, required): Phone number in E.164 format with leading +. Example: +12065550100
- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8

Example input: `{"phone_number":"<phone_number>","project_id":"<project_id>"}`

### `sinch_template_delete`

Delete Template · Destructive

Delete a Sinch omni-channel template and all its translations.
Returns an empty object on success.
Use sinch_template_delete to remove a template no longer sent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `template_id` (`string`, required): ID of the template. Example: order-shipped

Example input: `{"project_id":"<project_id>","template_id":"<template_id>"}`

### `sinch_webhook_delete`

Delete Webhook · Destructive

Delete a Conversation API webhook so its events are no longer sent.
Returns an empty object on success.
Use sinch_webhook_delete to stop event delivery to a URL.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Your Sinch project ID (a UUID), shown on the Sinch Build dashboard under Settings > Projects and on the Access Keys page. Example: 37b62a7b-0177-429a-bb0b-e10f848de0b8
- `webhook_id` (`string`, required): ID of the webhook. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEG

Example input: `{"project_id":"<project_id>","webhook_id":"<webhook_id>"}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
