Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Sinch

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  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.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • sinch_app_getGet one Conversation API app.Read-only

    Get 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-only

    List 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-only

    List 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-only

    Get 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-only

    Get 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-only

    List 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-only

    Get 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-only

    List 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