How to Connect YakChat to your Infobip & Peerless Service

How to Connect YakChat to your Infobip (Peerless) Service

Overview

YakChat can connect with your Infobip (Peerless) telephony service in 4 easy steps: These are:
  1. Copy the API Base URL
  2. Copy the API Token 
  3. Choose an Infobip Number for Setup and Testing
  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 Base URL

This value is automatically created when an account is setup with Infobip.  The easiest way to get this value is to sign in to the Infobip Portal and copy it from the upper right-hand corner of the Infobip Portal Home Page.



Step 2: API Key 

The API Key must be generated using the following steps:  
1. Click on “Manage API Keys” from the Infobip Portal Home Page
2. Click on “CREATE API KEY” button at the upper right of the page
  1. Give the key a helpful name
  2. Set an expiration date (several years in to the future)
  3. Define the necessary API Scopes
  4. Under “General” select the following two items
                 1. “inbound-message:read”
                 2.  “message:send”
  5. Under “Channels” select the following 12 items
        1.  “mms:logs:read”
        2.  “mms:manage”
        3.  “mms:message:send”
        4.  “sms:inbound-message:read”
        5.  “sms:logs:read”
        6.  “sms:manage”
        7.  “sms:message:send”
        8.  “whatsapp:conversions”
        9.  “whatsapp:inbound-message:read”
        10.  “whatsapp:logs:read”
        11.  “whatsapp:manage”
        12.  “whatsapp:message:send”
  1. Under “Platform” select the following two items
        1.  “messages-api:manage”
        2.  “messages-api:message:send"
  1. Under “Customer Engagement” select the following three items
        1.  “content-messages:manage”
        2.  “content-messages:read”
        3.  “conversations:manage”




Step 3: Adding a Subscription for each message channel

SMS Channel

Add and new SMS channel using the following steps:  
1. Select Developer Tools > Subscription Management from the left menu.
2. Click on “CREATE SUBSCRIPTION”  button at the upper right of the page.

Video clip 1 showing creating SMS subscription in infobip portal

3. In the Create Subscription section enter the following:
  1. Select "SMS" from the Channel pulldown
  2. Select "DELIVERY" from the Select events to subscribe to pulldown.
Video clip 2 showing creating SMS subscription in infobip portal

4. In the Notifications section enter the following:
  1. Enter "sms-callback" in the Profile ID field.
  2. Enter "https://sp-yakchat.com/sms/statuscallback" in the Webhook URL field.
Video clip 3 showing creating SMS subscription in infobip portal

MMS Channel

If your region supports MMS, add and new MMS channel using the following steps:  
1. Select Developer Tools > Subscription Management from the left menu.
2. Click on “CREATE SUBSCRIPTION”  button at the upper right of the page.
Video clip 1 showing creating MMS subscription in infobip portal

3. In the Create Subscription section enter the following:
  1. Select "MMS" from the Channel pulldown
  2. Select "DELIVERY" from the Select events to subscribe to pulldown.
Video clip 2 showing creating MMS subscription in infobip portal


4. In the Notifications section enter the following:
  1. Enter "mms-callback" in the Profile ID field.
  2. Enter "https://sp-yakchat.com/mms/statuscallback" in the Webhook URL field.
Video clip 3 showing creating MMS subscription in infobip portal

WhatsApp Channel

If your YakChat subscription includes WhatsApp, add the WhatsApp channel using the following steps:  
1. Select Developer Tools > Subscription Management from the left menu.
2. Click on “CREATE SUBSCRIPTION”  button at the upper right of the page.
Video clip 1 showing creating WhatsApp subscription in infobip portal

3. In the Create Subscription section enter the following:
  1. Select "WHATSAPP" from the Channel pulldown
  2. Tick "DELIVERY" and "SEEN" from the Select events to subscribe to pulldown.
Video clip 2 showing creating WhatsApp subscription in infobip portal

4. In the Notifications section enter the following:
  1. Enter "whatsapp-callback" in the Profile ID field.
  2. Enter "https://sp-yakchat.com/whatsapp/statuscallback" in the Webhook URL field.
Video clip 3 showing creating WhatsApp subscription in infobip portal


Step 4: Choose a Number for Setup and Testing

Please choose one Infobip number that we can use for initial setup and testing.


Step 5: Submit your connection details

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