The YakChat service can connect with your Telnyx telephony service in 5 easy steps:.
- Create an API Key
- Add Messaging Profile
- Assign the Messaging Profile to an SMS/MMS enabled number
- Send API information to YakChat at email@example.com
- We’ll then test the connection for you and confirm when everything is setup
Step 1: Create and API Key
Create an API Key by going to the Telnyx portal and selecting the API Keys option from the left side menu. We recommend creating an API Key specifically for the YakChat integration although an existing key can be used if required.
Click on the Create API Key button and . Cnce saved, click on the Copy icon beside the API key and save it so that it can be sent to YakChat in step 4.
Step 2: Add a Messaging Profile
Select Messaging from the left side menu in the Telnyx portal and then click on the Add new profile button.
Enter a profile name, select the API V2 option and the enter the following URL into the Send a webhook to this URL field and click the Save button.
Step 3: Assign Messaging Profile to Number(s)
Select Numbers from the left side menu in the Telnyx portal to display your existing numbers. The Messaging Profile created in the previous step can be assigned to any SMS/MMS capable numbers.
If the Messaging Profile is not available on any of the numbers listed, click on Search & Buy Numbers in the top menu bar, and search for available numbers with the SMS and MMS feature by adding SMS and MMS to the Number Features drop down.
Select and purchase a number with the SMS and MMS feature and add the Messaging Profile as described above.
Step 4: Submit your connection details
Send the following Telnyx connection details to firstname.lastname@example.org:
- Telnyx API Key
- A number has been configured so that we can use to test the service is working correctly (step 2)
Step 5: Integration Confirmation
We will use the information provided to connect with your Telnyx service and test using the Telnyx phone number provided. Once successfully connected, we will create and assign the number to the YakChat user for you to test.
We will contact you with troubleshooting steps if the integration fails for any reason.