Sinch Conversation API — VS Code Extension

Build, test, and send messages over SMS and RCS with Sinch Conversation API - right inside VS Code.

Work with and integrate Sinch's Conversation API directly into your IDE. Send SMS and RCS messages, manage webhooks, and access AI-powered code snippets without switching tools. The fastest way to build and test messaging integrations from VS Code.

Our Conversation API is one simple API to reach customers over multiple channels and deliver a mobile-first experience that’s out of this world!

Official API docs: https://developers.sinch.com/docs/conversation/

Conversation API information: https://sinch.com/apis/messaging/conversation-api/

Features

Core Explorer Views

Messages: Send SMS messages and compose rich RCS messages; view recent messages (SMS and RCS) sent within the last ~2 hours
Senders: Browse and add conversation senders
Webhooks: Manage all registered webhooks
Configuration: Enable 'Simulator Mode' to start integrating SMS quickly or inspect currently active Sinch credentials

Messaging & Senders

Quick SMS sending directly from VS Code
Rich RCS messaging with multiple message types (see RCS section below)
Real-time message history and status tracking for both SMS and RCS
View RCS message details from the Messages tree via right-click context menu
Load and manage available senders for your app
Multi-environment SMS and RCS testing support
Send messages quickly from the Messages view (context menu or title actions)

Webhook Lifecycle Management

Create, edit, delete webhooks
Copy webhook ID or fully resolved callback URL
Trigger simulated events and run test payloads using built‑in HTML templates

Credential & Environment Configuration

Guided command to set Key ID, Secret, Project ID, App ID & Region
Fast switching of App ID / Region for multi‑environment testing

AI / MCP Enablement

Optional generation of AI agent configuration files for GitHub Copilot
MCP server integration (see section below)

Code Snippets & IntelliSense

Generate ready-to-use code snippets for common Sinch Conversation API operations
Auto-completion support for Sinch API methods in TypeScript/JavaScript files
Quick access to API examples via Command Palette or tree view

AI Agent Context

Automatic generation of AI agent context files (AGENTS.md) for enhanced assistant capabilities
Provides GitHub Copilot with domain knowledge about Sinch Conversation API
Improves code suggestions and API guidance in VS Code

Developer Experience Extras

Lightweight HTML templates for webhook testing & trigger simulation
Structured command palette integration & contextual menus
Copy-paste ready code examples from the Sinch Conversation API tree view
Get started quickly with 'Simulator Mode', which allows for the integration and testing of messaging and webhook functionality without needing to set up an account
View full RCS message details directly from the Messages tree (right-click → View RCS Message Details)

Installation

Install from the VS Code Marketplace (recommended) or manually via a packaged VSIX file.

Usage

1. Create a Sinch Build Account

You will need a Sinch Build account - you can create an account by following this link: dashboard.sinch.com/signup. Once you have created an account and logged in, select Conversation API from the left menu. Review the terms and conditions, select the I agree to the terms and conditions check box, and click GET ACCESS to proceed.

2. Open the Sinch Conversation API View

Click the activity bar icon ("Sinch Conversation API"). You will see views for Senders, Messages, Webhooks, and Configuration.

3. Configure Credentials (First Run)

Open the Command Palette (⇧⌘P / Ctrl+Shift+P) and run: "Sinch Conversation API: Configure Sinch API". Provide:

Key ID
Key Secret
Project ID
App ID
Region (us | eu)

Once saved, the extension initializes and begins loading senders, webhooks, and recent messages. If credentials are incomplete you will be prompted to configure them.

4. Explore & Act

Configuration view: verify what is currently set.
Senders view: refresh or add a sender via the title menu/context menu.
Messages view: refresh recent messages or send a new SMS directly.
Webhooks view: create, edit, delete, refresh, copy IDs/URLs, and test triggers.

Contextual actions are exposed through:

View title bar buttons (Refresh, Send, etc.)
Right‑click context menus on items (Edit, Delete, Copy ID, Copy URL, Test Trigger)
Command Palette for any action (search "Sinch Conversation API")

5. Switching Apps or Regions

Use the relevant selection commands from the Command Palette to rapidly change App ID or Region. This is useful for staging vs production testing.

6. Webhook Testing

Selecting a webhook test action will open an HTML template in the editor, allowing you to simulate inbound requests or trigger events. Adjust payloads and re‑run as needed.

7. Send RCS Messages {#rcs-messaging}

The extension includes a dedicated RCS compose panel for sending rich messages via the Sinch Conversation API:

Media — Send an image, video, or file by URL
Choice — Send a text message with interactive reply/action buttons (text reply, URL, phone call, or map location)
Card — Send a rich card with a title, description, optional media, and interactive choices
Carousel — Send a horizontal scroll of multiple rich cards
Location — Share a map pin with a title, label, and GPS coordinates

Note: RCS requires a configured Sinch App with RCS enabled. Ensure your App ID and credentials are set correctly before sending RCS messages.

8. Generate Code Snippets

Generate ready-to-use code snippets for Sinch Conversation API operations:

Open Command Palette (⇧⌘P / Ctrl+Shift+P)
Run: "Sinch Conversation API: Generate Snippets"
Select the operation you want (e.g., "Send Message", "Create Webhook", "List Apps")
Choose your programming language (TypeScript, JavaScript, Python, cURL, etc.)
The snippet will be inserted at your cursor position or opened in a new file

9. Copy Code from Tree View

Get instant code examples directly from the Sinch Conversation API tree:

Navigate to any view (Senders, Messages, Webhooks)
Right-click on the tree view title bar
Select "Copy Code" or click the copy icon in the title bar
Choose your preferred language and operation
Code is copied to your clipboard - ready to paste!

This is the fastest way to get working code for common operations.

10. AI Agent Context Setup

Enhance your AI assistant's knowledge of Sinch Conversation API:

Automatic Setup:

After configuring credentials, you may be prompted to generate AI agent context
Accept to create AGENTS.md in your workspace with Sinch API knowledge

Manual Setup:

Open Command Palette (⇧⌘P / Ctrl+Shift+P)
Run: "Sinch Conversation API: Generate Agent Context"
The AGENTS.md file will be created in your workspace root

What it does:

Provides GitHub Copilot with domain-specific knowledge about Sinch API
Improves code suggestions for Sinch API operations
Helps AI understand authentication, regional endpoints, and best practices
Enhances chat responses with accurate Sinch API guidance

When to use:

Working on Sinch integrations and want better AI code suggestions
Need AI to understand Sinch-specific concepts (apps, channels, contacts, etc.)
Want AI to provide accurate API examples and error handling

Note: The agent context file works alongside MCP integration. Use MCP for direct API access, and agent context for improved code suggestions and guidance.

For a complete list of contribution points and commands, refer to package.json or the VS Code Command Palette.

Tip: Nearly every action surfaces in three places: tree view item context menus, view title menus, and the Command Palette—use whichever is fastest for your workflow.

MCP (Model Context Protocol) Integration

This extension supports MCP integration for GitHub Copilot in VS Code. The MCP server provides AI assistants with access to Sinch Conversation API functions.

Setup MCP

Configure Sinch credentials first using the Configure Sinch API command
Setup Sinch MCP using the command Sinch Conversation API: Setup Sinch MCP

The extension will automatically create the MCP configuration file at .vscode/mcp.json in your workspace.

Activation

MCP server will be configured automatically
Open Copilot Chat and allow the MCP server when prompted
The MCP integration will start working immediately after allowing

Available MCP Commands

Sinch Conversation API: Setup Sinch MCP - Configures MCP for your workspace
Sinch Conversation API: Uninstall Sinch MCP - Removes MCP configuration

Troubleshooting MCP

MCP server not appearing in settings?

Ensure you've configured Sinch credentials first
Try reloading VS Code after adding MCP config
Check that the MCP config file was created at .vscode/mcp.json

Verify MCP Integration is Working

Once you've set up MCP, you can verify it's working by testing with your AI assistant:

Simple verification:

Ask AI: "What MCP tools are available?" or "List available tools"
The AI should show Sinch Conversation API functions

Test Sinch functionality:

Ask AI: "Can you help me send an SMS using Sinch?"
Ask AI: "Show me all conversation apps"

If the AI responds with Sinch-specific capabilities or mentions Sinch tools, your MCP integration is working correctly. If the AI doesn't recognize Sinch tools, refer to the troubleshooting section above.

Telemetry

Sinch's Conversation API VS Code Extension may collect limited telemetry data to help us understand usage and improve the extension's experience. The extension does not collect any personal data or any message content. Telemetry collection follows the user's global telemetry setting in Visual Studio Code and will be disabled if telemetry is turned off in VS Code settings.

Development

Built with TypeScript and the VS Code Extension API.

Contributing

Contributions welcome. Please read CONTRIBUTING for details.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Changelog

Release notes are maintained in CHANGELOG.

Feedback, Issues and Support

We love hearing feedback, and we are here to help if you run into any issues.

For any Sinch Conversation API related issues, or support you require, head over to the Sinch Help Centre
For any Visual Studio Code Sinch Extension related issues, please contact our support team through the following link https://support.sinch.com/

We will continue to enhance this product, so keep a look out for additional channel support (MMS, WhatsApp and more) in addition to new features in future.

From all of us at Sinch, happy coding!

Sinch Conversation API

Sinch