Getting started
This guide shows how to get started 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.
Before you can start sending messages, you need to complete these basic configuration steps. However, you only have to complete these steps once for each app:
- 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 then use for testing - sign up for a free account.
Need help?
Click here to learn how to sign up.
Note
If you already have an account, skip this step.
- Access Conversation API: Log in to the 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.
- Create a Conversation API app: The next step is to create and configure a Conversation API app. Follow the instructions on the customer dashboard.
Need help?
Click here to learn how to create an app.
Note
You can also create an app programmatically using the API. Click here to learn how.
Number needed!
For SMS (and other channels) where a number is necessary, you need a Sinch number. If you don't already have a number, click here to learn how you can get a number from Sinch.
- Configure channels: To send and receive messages, you need at least one channel configured on your app. Learn how to configure a channel.
Note
Some channels require channel-specific configurations. Read about the requirements for all the channels here.
If you are using more than one channel, you can prioritize your channels, and Conversation API will send messages to the channels based on the priority you set.
Get Started with SMS!
If you're planning to add an SMS channel to your app, click here.
- Create your access key: Access keys are used to authenticate calls when using Conversation API. Access keys are generated in the customer dashboard. Click here to learn how to configure an access key.
Note
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.
Next steps
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: