Getting started

Step 1

Get access

Step 2

Create an app

Step 3

Configure your channel

Step 4

Select a language

This guide describes how to start sending SMS messages using the Conversation API. You can use this guide to test and explore the functionality of the SMS channel of the Conversation API. We recommend you use a test/demo Service Plan ID when following the steps described below.

To start sending messages, complete these basic configuration steps:

1. Get access

Get access and create your access key: Log in to the Sinch Customer Dashboard and 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 the 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.

2. Create an app

Create a Conversation API app: The next step is to create and configure a Conversation API app on the customer dashboard. Once you have done so, click GO TO APP. Alternatively, you can use API calls to create an app.

3. Configure your SMS channel

Configure your SMS channel: To send and receive messages on the SMS channel, configure the SMS channel on the app you created in the previous step must be configured.

We recommend that you work with your Sinch account manager to provide you with test/demo Service Plan IDs to be used with your Conversation API app. These will allow you to test your Conversation API integration before routing real traffic through the app.

Prior to reaching out to your Sinch account manager, ensure that you have the ID of the app you created in the last step readily available. If you aren't already on your newly created app's page, navigate to the Configure apps and set up channels section of the Sinch Customer Dashboard and select the app you created in the previous step. Your app's ID is displayed under the Configuration section.

4. Select a language

After the SMS channel has been configured for your app, you're ready to get started sending messages with Conversation API.

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

Alternatively, you can use this guide to learn how to convert a standalone SMS API batch request into a Conversation API send message request.