Getting started
This guide describes how to start sending WhatsApp messages using the Conversation API. You can use this guide to test and explore the functionality of the WhatsApp channel of the Conversation API.
Note:
Your account manager's assistance is required in this process. Specifically, they must assist you in acquiring test Sender Identities and/or migrating existing Sender Identities from your existing solution to the Conversation API.
We recommend you use a test/demo WhatsApp Sender Identity when following the steps described below. After testing, you can create new Sender Identities for use with your solution, or you can reach out to your account manager for help with migrating existing Sender Identities from your standalone WhatsApp API solution to your Conversation API solution.
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.Access
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.Webhooks
POST callbacks to the given URL. See How to add a webhook to a Conversation API app for more information. You can also create webhooks using API calls.3. Configure your WhatsApp channel
Configure your WhatsApp channel: To send and receive messages on WhatsApp, the WhatsApp channel on the app you created in the previous step must be configured.Work with your Sinch account manager to enable the WhatsApp channel on your Conversation API app. Your account manager will be able to provide you with test/demo Sender Identities and pre-configured WhatsApp message templates. Once you your account manager provides you with test/demo Sender Identities, you can add the WhatsApp channel to your Conversation API app and begin testing your solution. After you are done testing your solution, your account manager will be able to help you migrate any existing Sender Identities used in you standalone WhatsApp API solution to the Conversation API.
Sender Identities
Sender Identities that were created for use with the standalone WhatsApp API are unavailable for use with the WhatsApp channel of the Conversation API by default. To migrate these Sender Identities, you must reach out to your Sinch account manager for assistance.
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 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 WhatsApp channel has been configured for your app, you're ready to get started sending messages with Conversation API.
Templates
These guides will walk you through setting up a simple application in the following languages:
Alternatively, you can use this reference to begin recreating your existing solution using the Conversation API.