How to Connect YakChat to your Infobip & Peerless Service

How to Connect YakChat to your Tychron SMS Service

Overview

YakChat can connect with your Tychron telephony service in 4 easy steps: These are:
  1. Copy the SMS API Token 
  2. Add the YakChat URL to your 'Switch'
  3. Assign Phone Numbers to your 'Switch'
  4. Send API information to YakChat
After these steps, we’ll then test the connection for you and confirm when everything is set up.


Step 1: API Token

Navigate to the Numbers page in the Tychron portal in the API section using the following steps:
You can either create a new API or select an existing API to obtain the Key. 

Create a New API

  1. Navigate to MAIN > API KEYS from the left menus.
  2. To create a new API key click on the "New" button.
  3. Enter the API Name and any notes describing what the API is to be used for.
  4. Ensure "Active" is turned on and click on the "Create" button.
  5. Copy the key and save for use in step 4


Find the Key for an existing API 

  1. Navigate to MAIN > API KEYS from the left menus.
  2. Select the API Key that you want to connect to
  3. Click on the view icon in the "Key" field
  4. Copy the key and save for use in step 4


Step 2: Add the YakChat URL

Navigate to your 'Switch' associated with the phone numbers or create a new 'Switch' to add the phone numbers you want to add SMS/MMS to and add the YakChat URL using the following steps:

SMS Configuration

  1. Navigate to CONFIGURATION > SWITCHES from the left menus.
  2. Select an existing 'Switch' or use the "New" button to add a new 'Switch'
  3. Turn on the "SMS" toggle an configure the following:
    1. Outbound segment threshold: 9
    2. Protocol: HTTP
    3. URL: https://sp.yakchat.com/tychron/sms/message
    4. Message format: JSON (Default)
    5. Auth method: None
    6. Forward SMS DLR's?: On 



MMS Configuration

  1. In the 'Switch' configuration, turn on the "MMS" toggle an configure the following:
    1. Protocol: HTTP
    2. Data: https://sp.yakchat.com/tychron/mms/message
    3. Message format: JSON (Default)
    4. Auth method: None
    5. Forward SMS DLR's?: On 





Step 3: Assign Phone Numbers to 'Switch'

Navigate to a phone numbers you want to add SMS/MMS to and assign them to your 'Switch' that was configured in the previous step or create a new 'Switch' to add the phone numbers you want to add SMS/MMS to and add the YakChat URL using the following steps:
  1. Navigate to INVENTORY > PHONE NUMBERS from the left menus
  2. Search and select a phone number
  3. Scroll down and select "Messaging" block
  4. Select the "Messaging Switch" block and select the 'Switch' configured in step 2




Step 4: Submit your connection details

Enter the following Tychron connection details in the the form below:
  1. Select "Tychron" as the SMS service provider
  2. Enter your Tychron API Key into Integration Data 1 (from step 1)
  3. The phone number we can use to test the service is working correctly (step 1)