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. Create an API Key
  2. Add the API Scopes to the API Key
  3. Copy API Key information
  4. Configure your numbers 
  5. 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: Create and API Key

Create an API Key by going to the Infobip portal and selecting API Keys menu under the Developer Tools section
  1. Click the CREATE API KEY button
  2. Enter the name you wish to call the API key e.g. 'YakChat'
  3. Enter your preferred expiration date for the API key
  4. In the Allowed IP Addresses box enter the YakChat public IP address: 13.83.64.20





Step 2: Add API Scopes

While creating or editing the API Key, scroll down to the API Scopes section to define the API permissions.  The following scope must be allowed:

General

Click on the General section and select the following scopes:
  1. inbound-message:read
  2. message:send


Channels

Click on the Channels section and select the following scopes to enable SMS:
  1. sms:inbound-message:read
  2. sms:logs:read
  3. sms:manage
  4. sms:message:send
To enable MMS for numbers that support MMS, select the following scopes:
  1. mms:inbound-message:read
  2. mms:logs:read
  3. mms:manage
  4. mms:message:send
To enable WhatsApp for numbers that support WhatsApp select the following scopes:
  1. whatsapp:inbound-message:read
  2. whatsapp:logs:read
  3. whatsapp:manage
  4. whatsapp:message:send


Platform

Click on the Platform section and select the following scopes:
  1. messages-api:manage
  2. messages-api:message:send


Customer Engagement

Click on the Customer Engagement section and select the following scopes:
  1. content-messages:manage
  2. content-messages:read
  3. conversations:manage



Finally, click on the Save button to save the API Key Scope.


Step 2: Copy API Key Information

Navigate to the home page by clicking on the Infobip icon to copy the API Base URL and the API key using the following steps:
  1. Click on the copy icon beside the API Base URL and paste in a document so that it can be used in Step 4
  2. Click on the Manage API Keys link to navigate to the API Keys page
  3. Find the key that you wish to use (created in Step 1) and click on the copy button beside the API Key and paste in a document so that it can be used in Step 4





Step 3: Assign Messaging Profile to Number(s)

Navigate to the Numbers page by clicking on the Numbers menu under the Channels and Numbers menu section and select the number that you wish to use for YakChat and edit the configuration using the following steps:

SMS

To add SMS to the number, click on the SMS tab and select the edit icon in the Inbound Configuration tile
  1. Select 'Forward to HTTP' from the Forwarding action drop down
  2. Enter https://sp.yakchat.com/infobip/sms/message into the URL box
  3. Select 'MO_JSON_2' in the Renderer dropdown
  4. Click on the Configure button to save the configuration

MMS

To add MMS to the number, click on the MMS tab and select the edit icon in the Inbound Configuration tile
  1. Select 'Forward to HTTP' from the Forwarding action drop down
  2. Enter https://sp.yakchat.com/infobip/mms/message into the URL box
  3. Tick the Use custom renderer
  4. Type 'MMS_JSON' in the Custom renderer
  5. Click on the Configure button to save the configuration

WhatsApp

To add WhatsApp to the number, click on the WhatsApp tab and select the edit icon in the Inbound Configuration tile
  1. Select 'Forward to HTTP' from the Forwarding action drop down
  2. Enter https://sp.yakchat.com/infobip/whatsapp/message into the URL box
  3. Tick the Use custom renderer
  4. Select 'MO_OTT_CONTACT' in the Renderer dropdown
  5. Click on the Configure button to save the configuration




Step 4: 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 2)
  3. Enter your Infobip API Key into Integration Data 2 (from step 2)
  4. The phone number we can use to test the service is working correctly (step 3)