Getting started

This guide shows how to start sending messages using the Conversation API.

Heads up!

You can use this guide to configure any available channel for your Conversation API app! If you don't have a channel in mind, you can follow these callouts for help on configuring an SMS channel.

To start sending messages, complete these basic configuration steps:

1. Sign up

Sign up for an account on the Sinch Customer Dashboard: Before you can use the Conversation API, you need to sign up for a free Sinch account. This is a quick process where you submit some basic details, including a mobile number you can use for testing.

Need help?
Click here to learn how to sign up.

2. Get access

Get access and create your access key: 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. Then, you must create your access key. Access keys are used to authenticate calls when using Conversation API. Access keys are generated in the customer dashboard.

Need help?
Click here to learn how to configure an access key.

Projects

When you sign up for a Sinch account, a default project is created for you. Conversation API uses this project to group contacts and apps together. Contacts are shared across apps within the same project. Depending on your needs, you may need to create additional projects to keep contact lists separate. To create additional projects, reach out to your account manager for assistance.

3. Create an app

Create a Conversation API app: The next step is to create and configure a Conversation API app. Follow the instructions on the customer dashboard. Alternatively, you can use API calls to create an app.

Need help?
Click here to learn how to create an app on the Sinch Customer Dashboard.

4. Configure channels

Configure channels: To send and receive messages, you need to configure at least one channel for your app. Some channels require channel-specific configurations. Learn about each channel's requirements here. If you are using more than one channel, you can prioritize your channels, and the Conversation API will send messages to the channels based on the priority you set.

Need help?
Click here to learn how to configure Conversation API channels using the Sinch Customer Dashboard. Alternatively, you can configure your app using the API.

Get Started with SMS!
If you're planning to add the SMS channel to your app, you'll need a Sinch number. If you don't already have a number, click here to learn how you can get a number from Sinch. Once you have a Sinch number, see our SMS channel guide.

5. Select a language

Now you're ready to get started sending messages with Conversation API.

Important property!

If you are planning to send an SMS message using a free test number, make sure you understand the SMS_SENDER property. You'll need to add it to your code and set it to your free test number.

These guides will walk you through setting up a simple application in the following languages: