Overview

1. Copy the API Base URL
2. Create and API Key 
   
3. Create an Application
4. Configure SMS/MMS for a phone number
   
5. Provide information to YakChat for configuration and testing
   

1. Select the API Keys menu under the Developer Tools section of the left side menu
   
2. Look for the API base URL and click on the copy icon to copy the URL
   
3. Save the URL so that it can be used in Step 5 below.
   

Step 2: API Key 

An existing API Key can be used but is only visible for 2 days.  Use the following instructions to create a new API Key:

1. Select the API Keys menu under the Developer Tools section of the left side menu

2. Click on the CREATE API KEY button 

1. Give the key a name
   
2. Set an expiration date (several years in to the future
   
3. Define the necessary API Scopes using the list below:
   
1. Under General select the following two items:
   
1. inbound-message:read
   
2. message:send
   

1. Under Channels select the following 8 items:
   
1. mms:inbound-message:read
2. mms:logs:read
3. mms:manage
4. mms:message:send
5. sms:inbound-message:read
6. sms:logs:read
7. sms:manage
8. sms:message:send
   

1. Under Platforms select the following 2 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: Create an Application

Create an Application using the following steps to enable the events to be inbound and delivery results to be filtered for the numbers and channels associated with the Application using the following steps:

1. Select the Applications and Entities menu under the Developer Tools section of the left side menu
   
2. Click on the CREATE Application button 
   
3. Enter the name of the Application e.g. "YakChat" as the Application ID
   
4. Enter the name of the Application e.g. "YakChat Integration" into as the Application Name 

---

Step 4: Add a Subscription and Notification Profile for each message channel

SMS Channel

Add a new SMS channel using the following steps:  

1. Select the Subscriptions Management menu under the Developer Tools section of the left side menu
   
2. Click on the CREATE SUBSCRIPTION button 
   
3. In the Category section enter the following:
   
1. Add "SMS Delivery" for the Even subscription name
2. Select the SMS tile
   
3. Click the NEXT Button
4. In the Events section tick the DELIVERY box but don't select an event from the pulldown and click the NEXT button
   
5. In the Filtering section use the pulldown to select the Application that was created in the previous step to filter callback events for just the numbers assigned to the Application
6. In the Notification Profile section enter the following:
   
1. Open the Notification Profile pull-down and select CREATE NEW NOTIFICATION PROFILE at the bottom of the list
2. In the Notification profile name enter "sms-callback"
   
3. Enter "https://sp-yakchat.com/sms/statuscallback" as the Webhook URL 
   
7. Review the summary to ensure the information entered is correct
   

MMS Channel

After creating the SMS channel, an MMS channel can be created created using the following steps:  

1. Select the Subscriptions Management menu under the Developer Tools section of the left side menu
   
2. Click on the CREATE SUBSCRIPTION button 
   
3. In the Category section enter the following:
   
1. Add "SMS Delivery" for the Even subscription name
2. Select the MMS tile
   
3. Click the NEXT Button
4. In the Events section tick the DELIVERY box but don't select an event from the pulldown and click the NEXT button
   
5. In the Filtering section use the pulldown to select the Application that was created in the previous step to filter callback events for just the numbers assigned to the Application
6. In the Notification Profile section enter the following:
   
1. Open the Notification Profile pull-down and select CREATE NEW NOTIFICATION PROFILE at the bottom of the list
2. In the Notification profile name enter "mms-callback"
   
3. Enter https://sp-yakchat.com/mms/statuscallback as the Webhook URL 
   
7. Review the summary to ensure the information entered is correct
   

Step 5: Configure SMS/MMS for a phone number 

1. Select the Numbers menu under the Channels and Numbers section of the left side menu
   
2. In the General tab use the pull-down to select the Application
   
1. In the Application and Entity section use the pull-down to select the Application created in Step 3
   
3. In the SMS tab edit the Inbound configuration
   
1. In the Forwarding action section select Forward to HTTP from the pull down
   
2. Set the URL to be https://sp.yakchat.com/infobip/sms/message
   
3. Use the pull-down to set the Renderer to be MO_JSON_2
   
4. Scroll down to the Application and entities section and select the Application to be the same as created in Step 3
   
4. In the MMS tab edit the Inbound configuration
   
1. In the Forwarding action section select Forward to HTTP from the pull down
   
2. Set the URL to be https://sp.yakchat.com/infobip/mms/message
   
3. Select Use custom renderer
4. Add "MMS_JSON" as the Customer renderer 
   
5. Scroll down to the Application and entities section and select the Application to be the same as created in Step 2
   

Step 6: Submit your connection details

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)