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.
- Tools
- 50
- What they doRead · write · destructive
- 24 · 19 · 724 read19 write7 destructive
- Users sign in with
- Service account
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Sinch connection
In AgentKit > Connections, create a Sinch connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolsinch_app_getGet one Conversation API app.Read-onlyGet App
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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
sinch_apps_listList the Conversation API apps in a Sinch project.Read-onlyList Apps
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.
Inputs
project_idstringrequired- 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
sinch_consents_listList the channel identities on one of an app's consent (opt-out) lists.Read-onlyList Opt-outs
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
list_typestringrequired- Which list: OPT_OUT_ALL, OPT_OUT_MARKETING or OPT_OUT_NOTIFICATION. Example: OPT_OUT_MARKETINGone of
OPT_OUT_ALLOPT_OUT_MARKETINGOPT_OUT_NOTIFICATION project_idstringrequired- 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_sizeinteger- Records per page, up to 50. Defaults to 10. Example: 50
page_tokenstring- Page token from the previous response. Example: CgwI4dCWnAYQ0P3u3QM
sinch_contact_channel_profile_getFetch a user's public profile name from Messenger, Instagram, Viber or LINE for a contact or channel identity.Read-onlyGet Channel Profile
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
profile_channelstringrequired- Channel to read the profile from. Example: MESSENGERone of
MESSENGERINSTAGRAMVIBERLINE project_idstringrequired- 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
channelstring- Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM contact_idstring- ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
identitystring- 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
sinch_contact_getGet one Sinch Conversation API contact by ID.Read-onlyGet Contact
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.
Inputs
contact_idstringrequired- ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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
sinch_contacts_listList the contacts in a Sinch project, or find one by external ID or by channel identity.Read-onlyList Contacts
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.
Inputs
project_idstringrequired- 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
channelstring- Channel of identity; set together with identity. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM external_idstring- Only the contact with this ID from your own system. Do not combine with channel and identity. Example: crm-5678
identitystring- Only the contact with this address on channel, for example a phone number. Example: 46732001122
page_sizeinteger- Contacts per page, up to 20. Defaults to 10. Example: 20
page_tokenstring- next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM
sinch_conversation_getGet one Sinch Conversation API conversation by ID.Read-onlyGet Conversation
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.
Inputs
conversation_idstringrequired- ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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
sinch_conversations_listList Sinch Conversation API conversations, filtered by app, contact, channel or active state.Read-onlyList Conversations
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.
Inputs
only_activebooleanrequired- true for active conversations only, false for inactive only. Example: true
project_idstringrequired- 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_channelstring- Only conversations whose active channel is this one. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM app_idstring- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
contact_idstring- Only conversations with this contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
page_sizeinteger- Conversations per page, up to 20. Defaults to 10. Example: 20
page_tokenstring- next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM
sinch_conversations_recent_listList an app's conversations ordered by their latest message, each with that last message.Read-onlyList Recent Conversations
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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_activeboolean- true for active conversations only. Example: false
orderstring- DESC (default) for newest first, ASC for oldest first. Example: DESCone of
ASCDESC page_sizeinteger- Conversations per page, up to 50. Defaults to 10. Example: 20
page_tokenstring- next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM
sinch_message_getGet one Sinch Conversation API message by ID.Read-onlyGet Message
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.
Inputs
message_idstringrequired- ID of the message. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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_sourcestring- CONVERSATION_SOURCE (default) or DISPATCH_SOURCE for messages sent in dispatch mode. Example: CONVERSATION_SOURCEone of
CONVERSATION_SOURCEDISPATCH_SOURCE
sinch_messages_listList Sinch Conversation API messages, filtered by conversation, contact, app, channel, direction or time.Read-onlyList Messages
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.
Inputs
project_idstringrequired- 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_idstring- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
channelstring- Only messages on this channel. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM channel_identitystring- Only messages to or from this channel identity (for example a phone number). Used in dispatch mode. Example: 46732001122
contact_idstring- Only messages with this contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
conversation_idstring- Only messages in this conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
directionstring- TO_APP for inbound, TO_CONTACT for outbound. Defaults to both. Example: TO_APPone of
TO_APPTO_CONTACT end_timestring- Only messages accepted before this time (RFC 3339). Example: 2026-11-02T00:00:00Z
messages_sourcestring- CONVERSATION_SOURCE (default) or DISPATCH_SOURCE. Example: CONVERSATION_SOURCEone of
CONVERSATION_SOURCEDISPATCH_SOURCE only_recipient_originatedboolean- true to list only messages sent by contacts. Example: false
page_sizeinteger- Messages per page, up to 1000. Defaults to 10. Example: 50
page_tokenstring- next_page_token from the previous page. Example: CgwI4dCWnAYQ0P3u3QM
start_timestring- Only messages accepted after this time (RFC 3339). Example: 2026-11-01T00:00:00Z
sinch_number_active_getGet one phone number your Sinch project rents, with its SMS and voice configuration.Read-onlyGet Active Number
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.
Inputs
phone_numberstringrequired- Phone number in E.164 format with leading +. Example: +12065550100
project_idstringrequired- 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
sinch_number_available_getCheck whether one specific phone number is available to rent from Sinch, and its price.Read-onlyCheck Available Number
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.
Inputs
phone_numberstringrequired- Phone number in E.164 format with leading +. Example: +12065550100
project_idstringrequired- 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
sinch_number_callback_config_getGet the Numbers API callback settings for a Sinch project.Read-onlyGet Numbers Callback Config
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.
Inputs
project_idstringrequired- 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
sinch_number_order_getGet a Sinch number order and its status.Read-onlyGet Number Order
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.
Inputs
number_order_idstringrequired- ID of the number order. Example: 9b2c7f4e-1a3d-4e5f-8a9b-0c1d2e3f4a5b
project_idstringrequired- 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
sinch_number_regions_listList the countries where Sinch offers numbers, optionally only for given number types.Read-onlyList Number Regions
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.
Inputs
project_idstringrequired- 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
typesarray- Only regions offering these number types. Example: ["MOBILE"]
sinch_number_requirements_lookupLook up what Sinch needs before you can order a number type in a country: KYC documents, address and business details.Read-onlyLook Up Number Requirements
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.
Inputs
number_typestringrequired- LOCAL, MOBILE or TOLL_FREE. Example: MOBILEone of
LOCALMOBILETOLL_FREE project_idstringrequired- 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_codestringrequired- ISO 3166-1 alpha-2 country code. Example: DE
sinch_numbers_active_listList the phone numbers your Sinch project rents.Read-onlyList Active Numbers
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.
Inputs
project_idstringrequired- 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_codestringrequired- Only numbers in this ISO 3166-1 alpha-2 country. Example: US
typestringrequired- Only this number type. Example: LOCALone of
LOCALMOBILETOLL_FREE capabilityarray- Only numbers with these capabilities. Example: ["SMS"]
order_bystring- Sort by phoneNumber or displayName. Example: phoneNumberone of
phoneNumberdisplayName page_sizeinteger- Numbers per page. Example: 50
page_tokenstring- nextPageToken from the previous page. Example: CgwI4dCWnAYQ0P3u3QM
patternstring- Digits the number must contain; use with search_pattern. Example: 206
search_patternstring- Where pattern must appear: START, CONTAINS or END. Example: STARTone of
STARTCONTAINSEND
sinch_numbers_available_listSearch the phone numbers Sinch has available to rent in a country.Read-onlySearch Available Numbers
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.
Inputs
project_idstringrequired- 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_codestringrequired- ISO 3166-1 alpha-2 country code, for example US, GB or SE. Example: US
typestringrequired- Number type: LOCAL, MOBILE or TOLL_FREE. Example: LOCALone of
LOCALMOBILETOLL_FREE capabilitiesarray- Required capabilities: SMS and/or VOICE. Example: ["SMS"]
patternstring- Digits the number must contain; use with search_pattern. Example: 206
search_patternstring- Where pattern must appear: START, CONTAINS or END. Example: STARTone of
STARTCONTAINSEND sizeinteger- Maximum numbers to return. Example: 10
sinch_template_getGet one Sinch omni-channel template with all its translations.Read-onlyGet Template
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.
Inputs
project_idstringrequired- 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_idstringrequired- ID of the template. Example: order-shipped
sinch_template_translations_listList the translations of a Sinch template, optionally for one language or version.Read-onlyList Template Translations
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.
Inputs
project_idstringrequired- 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_idstringrequired- ID of the template. Example: order-shipped
language_codestring- Only this BCP-47 language. Example: en-US
translation_versionstring- Only this translation version, or latest. Example: latest
sinch_templates_listList the omni-channel message templates in a Sinch project (Template Management API v2).Read-onlyList Templates
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.
Inputs
project_idstringrequired- 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
sinch_webhook_getGet one Conversation API webhook.Read-onlyGet Webhook
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.
Inputs
project_idstringrequired- 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_idstringrequired- ID of the webhook. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEG
sinch_webhooks_listList the webhooks set on a Conversation API app.Read-onlyList Webhooks
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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
sinch_capability_queryAsk Sinch whether a contact or phone number can be reached on a channel (for example RCS or WhatsApp) and which features it supports.WriteQuery Channel Capability
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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
channelstring- Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM contact_idstring- ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
identitystring- 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_idstring- Your own ID for this lookup, echoed in the webhook. Generated if omitted. Example: cap-1234
sinch_contact_createCreate a Sinch Conversation API contact with one or more channel identities.WriteCreate Contact
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.
Inputs
channel_identitiesarrayrequired- 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"}]
languagestringrequired- Contact's language, as an uppercase code such as EN_US, EN_GB, DE, SV or ES. Example: EN_USone of
AFSQARAZBNBGCAZHZH_CNZH_HKZH_TWHRCSDANLENEN_GBEN_USETFILFIFRDEELGUHAHEHIHUIDGAITJAKNKKKOLOLVLTMKMSMLMRNBFAPLPTPT_BRPT_PTPARORUSRSKSLESES_ARES_ESES_MXSWSVTATETHTRUKURUZVIZU project_idstringrequired- 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_priorityarray- Channel order to try when messaging this contact. Example: ["WHATSAPP", "SMS"]
display_namestring- Display name. Defaults to Unknown. Example: Ana Silva
emailstring- Email address. Example: ana@example.com
external_idstring- The contact's ID in your own system. Example: crm-5678
metadatastring- Your own metadata, up to 1024 characters. Example: vip
sinch_contact_updateUpdate a Sinch contact's name, email, language, channel identities, channel priority or metadata.WriteUpdate Contact
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.
Inputs
contact_idstringrequired- ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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_identitiesarray- Replacement list of channel identities (channel, identity, optional app_id). Example: [{"channel": "SMS", "identity": "46732001122"}]
channel_priorityarray- Replacement channel priority order. Example: ["SMS"]
display_namestring- New display name. Example: Ana Silva
emailstring- New email address. Example: ana@example.com
external_idstring- New external ID. Example: crm-5678
languagestring- New language code such as EN_US. Example: EN_US
metadatastring- New metadata, up to 1024 characters. Example: vip
update_maskstring- 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
sinch_conversation_createStart a new conversation between a Conversation API app and a contact.WriteCreate Conversation
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
contact_idstringrequired- ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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
activeboolean- Whether the conversation starts active. Example: true
active_channelstring- Channel the conversation is on. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM correlation_idstring- Your own correlation ID. Example: campaign-42
metadata_jsonobject- Your own JSON metadata for the conversation. Example: {"order_id": "1234"}
sinch_conversation_stopEnd an active Sinch conversation; the next message to the contact starts a new one.WriteStop Conversation
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.
- Idempotent
Inputs
conversation_idstringrequired- ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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
sinch_conversation_updateUpdate a Sinch conversation's active state, active channel or metadata.WriteUpdate Conversation
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.
Inputs
conversation_idstringrequired- ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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
activeboolean- Whether the conversation is active. Example: true
active_channelstring- Channel the conversation is on. Example: SMSone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM metadata_jsonobject- Your own JSON metadata for the conversation. Example: {"order_id": "1234"}
metadata_update_strategystring- REPLACE (default) overwrites metadata_json; MERGE_PATCH merges into it. Example: MERGE_PATCHone of
REPLACEMERGE_PATCH update_maskstring- Comma-separated fields to update, for example metadata_json. Fields not listed are left unchanged; empty updates every field you send. Example: metadata_json
sinch_event_sendSend a non-message event to a contact, such as a typing indicator, a read receipt or an agent joining or leaving.WriteSend Event
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
eventobjectrequired- 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_idstringrequired- 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
channelstring- Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM contact_idstring- ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
identitystring- 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
sinch_message_media_sendSend an image, video, audio or document by URL through the Sinch Conversation API on any channel that supports media.WriteSend Media Message
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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
urlstringrequired- 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_urlstring- Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
channelstring- Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM channel_priority_orderarray- 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_idstring- ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
correlation_idstring- Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
filename_overridestring- Optional file name shown to the recipient instead of the one in the URL. Example: receipt-1234.jpg
identitystring- 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_typestring- Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATIONone of
CONTENT_UNKNOWNCONTENT_MARKETINGCONTENT_NOTIFICATION message_metadatastring- Your own metadata for the message, returned in delivery receipts. Example: order-1234
processing_strategystring- DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULTone of
DEFAULTDISPATCH_ONLY queuestring- Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITYone of
NORMAL_PRIORITYHIGH_PRIORITY reply_to_message_idstring- ID of an inbound message to reply to (quoted on channels that support it). Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
thumbnail_urlstring- Optional public URL of a thumbnail image, used by channels that show one. Example: https://example.com/files/receipt-thumb.jpg
ttlstring- How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s
sinch_message_sendSend 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.WriteSend Message
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
messageobjectrequired- 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_idstringrequired- 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_urlstring- Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
channelstring- Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM channel_priority_orderarray- 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_idstring- ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
correlation_idstring- Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
identitystring- 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_typestring- Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATIONone of
CONTENT_UNKNOWNCONTENT_MARKETINGCONTENT_NOTIFICATION message_metadatastring- Your own metadata for the message, returned in delivery receipts. Example: order-1234
processing_strategystring- DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULTone of
DEFAULTDISPATCH_ONLY queuestring- Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITYone of
NORMAL_PRIORITYHIGH_PRIORITY ttlstring- How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s
sinch_message_template_sendSend a message built from a Sinch omni-channel template (created with sinch_template_create), filling its variables.WriteSend Template Message
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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_idstringrequired- ID of the Sinch template to send. Example: order-shipped
versionstringrequired- Template version to use, or latest. Example: latest
callback_urlstring- Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
channelstring- Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM channel_priority_orderarray- 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_idstring- ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
correlation_idstring- Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
identitystring- 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_codestring- BCP-47 language of the translation to send. Defaults to the template's default translation. Example: en-US
message_content_typestring- Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATIONone of
CONTENT_UNKNOWNCONTENT_MARKETINGCONTENT_NOTIFICATION message_metadatastring- Your own metadata for the message, returned in delivery receipts. Example: order-1234
parametersobject- Values for the template variables, as a map of variable name to text. Example: {"name": "Ana", "order_id": "1234"}
processing_strategystring- DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULTone of
DEFAULTDISPATCH_ONLY queuestring- Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITYone of
NORMAL_PRIORITYHIGH_PRIORITY ttlstring- How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s
sinch_message_text_sendSend 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.WriteSend Text Message
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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
textstringrequired- Message text. Channels transcode it; SMS splits long texts into parts. Example: Your order 1234 has shipped.
callback_urlstring- Delivery-receipt webhook URL for this message only, overriding the app's webhooks. Example: https://example.com/sinch/callbacks
channelstring- Channel of the recipient identity, used with identity when you do not have a contact_id. Example: WHATSAPPone of
SMSRCSWHATSAPPMMSKAKAOTALKKAKAOTALKCHATVIBERBMLINEINSTAGRAMMESSENGERWECHATTELEGRAM channel_priority_orderarray- 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_idstring- ID of an existing Conversation API contact to send to. Use either contact_id, or channel and identity. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
correlation_idstring- Your own identifier, passed to every callback for this message and to replies from the recipient. Example: campaign-42
identitystring- 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_typestring- Content class for Sinch consent management: CONTENT_MARKETING messages are blocked for contacts on the marketing opt-out list. Example: CONTENT_NOTIFICATIONone of
CONTENT_UNKNOWNCONTENT_MARKETINGCONTENT_NOTIFICATION message_metadatastring- Your own metadata for the message, returned in delivery receipts. Example: order-1234
processing_strategystring- DISPATCH_ONLY sends without creating a contact or conversation, overriding the app's processing mode. Example: DEFAULTone of
DEFAULTDISPATCH_ONLY queuestring- Send queue. HIGH_PRIORITY is for time-sensitive messages such as one-time codes. Example: NORMAL_PRIORITYone of
NORMAL_PRIORITYHIGH_PRIORITY reply_to_message_idstring- ID of an inbound message to reply to (quoted on channels that support it). Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
ttlstring- How long to keep trying to deliver, in seconds with an s suffix, for example 3600s. Example: 3600s
sinch_number_active_updateChange a rented Sinch number's display name, SMS service plan or campaign, voice setup or provisioning callback URL.WriteUpdate Active Number
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.
Inputs
phone_numberstringrequired- Phone number in E.164 format with leading +. Example: +12065550100
project_idstringrequired- 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_urlstring- URL Sinch calls when provisioning of this number changes. Example: https://example.com/sinch/numbers
display_namestring- Your own name for the number. Example: Support line
sms_configurationobject- SMS setup: servicePlanId (required) and, for US 10DLC, campaignId. Example: {"servicePlanId": "a1b2c3d4e5f6", "campaignId": "CABCDEF"}
voice_configurationobject- Voice setup: type RTC (with appId), EST (with trunkId) or FAX (with serviceId). Example: {"type": "RTC", "appId": "3d2a1b7c-8e9f-4a0b-9c1d-2e3f4a5b6c7d"}
sinch_number_callback_config_updateSet the HMAC secret Sinch uses to sign Numbers API callbacks for a project.WriteUpdate Numbers Callback Config
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.
Inputs
hmac_secretstringrequired- New secret, 32 to 64 characters of letters, digits and hyphens. Example: 4f1e6b2a-9c3d-4e5f-8a7b-6c5d4e3f2a1b-sk
project_idstringrequired- 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
sinch_number_order_createStart a Sinch number order, either for one specific available number or for a quantity of numbers matching criteria.WriteCreate Number Order
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.
Inputs
number_typestringrequired- LOCAL, MOBILE or TOLL_FREE. Example: LOCALone of
LOCALMOBILETOLL_FREE project_idstringrequired- 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_codestringrequired- ISO 3166-1 alpha-2 country code. Example: US
callback_urlstring- URL Sinch calls as the order progresses. Example: https://example.com/sinch/orders
capabilitiesarray- With quantity: required capabilities. Example: ["SMS"]
patternstring- With quantity: digits the numbers must contain; use with search_pattern. Example: 206
phone_numberstring- One specific available number to order, in E.164 format with +. Use either phone_number or quantity. Example: +12065550100
quantityinteger- How many matching numbers to order, 1 to 100. Use either quantity or phone_number. Example: 2
search_patternstring- With quantity: where pattern must appear: START, CONTAINS or END. Example: STARTone of
STARTCONTAINSEND sequentialboolean- With quantity: true to require consecutive numbers. Example: false
sms_configurationobject- SMS setup for the numbers: servicePlanId and, for US 10DLC, campaignId. Example: {"servicePlanId": "a1b2c3d4e5f6"}
voice_configurationobject- Voice setup: type RTC (with appId), EST (with trunkId) or FAX (with serviceId). Example: {"type": "RTC", "appId": "3d2a1b7c-8e9f-4a0b-9c1d-2e3f4a5b6c7d"}
sinch_number_order_submitSubmit a Sinch number order for fulfilment.WriteSubmit Number Order
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.
Inputs
number_order_idstringrequired- ID of the number order. Example: 9b2c7f4e-1a3d-4e5f-8a9b-0c1d2e3f4a5b
project_idstringrequired- 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
sinch_template_createCreate a Sinch omni-channel message template with one or more translations.WriteCreate Template
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.
Inputs
default_translationstringrequired- 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_idstringrequired- 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
translationsarrayrequired- 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"}]}]
descriptionstring- Description of the template. Example: Order shipped notification
idstring- Your own template ID, unique in the project. Generated if omitted. Example: order-shipped
sinch_template_updateReplace a Sinch template's description, default translation and translations, creating a new template version.WriteUpdate Template
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.
- Idempotent
Inputs
default_translationstringrequired- BCP-47 language code of the default translation. Example: en-US
project_idstringrequired- 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_idstringrequired- ID of the template. Example: order-shipped
translationsarrayrequired- 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"}]}]
versionintegerrequired- The template's current version, from sinch_template_get. Example: 1
descriptionstring- Description of the template. Example: Order shipped notification
sinch_webhook_createCreate a webhook that sends a Conversation API app's events (inbound messages, delivery reports and more) to your URL.WriteCreate Webhook
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.
Inputs
app_idstringrequired- ID of the Conversation API app, from the Sinch dashboard (Conversation API > Apps) or sinch_apps_list. Example: 01EB37HMH1M6SV18ASNS3G135H
project_idstringrequired- 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
targetstringrequired- HTTPS URL that receives the events. Example: https://example.com/sinch/events
triggersarrayrequired- Events to send, for example MESSAGE_INBOUND, MESSAGE_DELIVERY, EVENT_INBOUND, CONVERSATION_START or CAPABILITY. Example: ["MESSAGE_INBOUND", "MESSAGE_DELIVERY"]
secretstring- Secret Sinch uses to sign each callback so you can verify it. Example: my-signing-secret
sinch_webhook_updateChange a Conversation API webhook's target URL, triggers or signing secret.WriteUpdate Webhook
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.
Inputs
project_idstringrequired- 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
targetstringrequired- HTTPS URL that receives the events. Example: https://example.com/sinch/events
webhook_idstringrequired- ID of the webhook. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEG
secretstring- New signing secret. Example: my-signing-secret
triggersarray- Events to send. Example: ["MESSAGE_INBOUND"]
update_maskstring- Comma-separated fields to update, for example target and triggers. Example: target,triggers
sinch_contact_deleteDelete a Sinch Conversation API contact and its conversations.DestructiveDelete Contact
Delete a Sinch Conversation API contact and its conversations. Returns an empty object on success. Use sinch_contact_delete for data-removal requests.
- Idempotent
Inputs
contact_idstringrequired- ID of the contact. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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
sinch_contact_mergeMerge a duplicate Sinch contact into another: channel identities and conversations move to the destination and the source contact is deleted.DestructiveMerge Contacts
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.
Inputs
destination_idstringrequired- ID of the contact to keep. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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_idstringrequired- ID of the contact to merge in and delete. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEF
sinch_conversation_deleteDelete a Sinch conversation and all its messages from the Conversation API store.DestructiveDelete Conversation
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.
- Idempotent
Inputs
conversation_idstringrequired- ID of the conversation. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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
sinch_message_deleteDelete a message from the Sinch Conversation API store.DestructiveDelete Message
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.
- Idempotent
Inputs
message_idstringrequired- ID of the message. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEE
project_idstringrequired- 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_sourcestring- CONVERSATION_SOURCE (default) or DISPATCH_SOURCE. Example: CONVERSATION_SOURCEone of
CONVERSATION_SOURCEDISPATCH_SOURCE
sinch_number_releaseRelease a rented Sinch phone number at the end of its billing period.DestructiveRelease Number
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.
- Idempotent
Inputs
phone_numberstringrequired- Phone number in E.164 format with leading +. Example: +12065550100
project_idstringrequired- 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
sinch_template_deleteDelete a Sinch omni-channel template and all its translations.DestructiveDelete Template
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.
- Idempotent
Inputs
project_idstringrequired- 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_idstringrequired- ID of the template. Example: order-shipped
sinch_webhook_deleteDelete a Conversation API webhook so its events are no longer sent.DestructiveDelete Webhook
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.
- Idempotent
Inputs
project_idstringrequired- 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_idstringrequired- ID of the webhook. Example: 01FHPK9N8Y8PF1YJJ8J3XHFBEG
No tools match.