Karix

Introduction 

Karix is a mobile engagement and communications provider enabling enterprises to intelligently personalize their two-way marketing and customer care interactions across multiple channels.

library_add_check

Prerequisites

Ensure you have access to your Infobip Dashboard and have the API key for your Infobip account.

Configure Karix as a Custom SMS Connector (Service Provider)

This article will help you set Karix as a Custom Connector on the MoEngage dashboard.

info

Information

We've revamped our dashboard settings. This article describes the steps to be followed to configure Karix as a Custom Connector (Service Provider) in the revamped settings UI and the older UI.

Configure in Revamped UI

Log in to the MoEngage Dashboard and follow these steps:

  1. Navigate to Settings -> Channel -> SMS -> Sender Configuration.
  2. Click +Add Service Provider at the top right corner.
  3. Add the following details in the Sender Details screen.

    Mark as default

    Turn on this toggle to mark the sender as the default sender for the service provider being configured. If marked as default, this sender would be used for sending all SMS campaigns from MoEngage unless you select a different sender while creating the campaign.

    Field Description
    Service provider name

    This field identifies the service provider you are configuring on the MoEngage Dashboard and has to be unique. Type the name of the service provider here.

    Sender name

    This field identifies the Sender. Type the name of the sender here.

    Sender type

    The Sender type can either be Promotional or Transactional. Choose the Sender type as Promotional when you would be using the Sender for sending information about your brand, promoting deals, or engaging with users. Choose the Sender type as Transactional when you would be using the Sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.

  4. Configure the Webhook by adding the following details:
    Field Description

    API URL

    This field contains information about the URL that should be used to send an API request to the Sender. You can get this information from the API Documentation of the Sender. Type the API Endpoint of the sender here. The API URL for Karix is: https://yr8qyp.api.infobip.com/sms/2/text/advanced

    Method

    Select POST as the HTTP method.

    URL Parameters

    Add the URL Parameters to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. For example, if the API URL call uses the GET method, all the parameters, such as API Key, Authorization, and so on, are passed as URL Parameters.

    Headers

    Add the Request Headers to be passed to the API as Key-Value pairs using this option. You can get this information from the API Documentation of the Sender. Add the Authorization Header.

    Body Type

    Choose the Body Type as JSON and add the following details:

    {
    "messages": [
      {
          "text": "Moesms_message",
          "dest": [Moesms_destination],
          "send": "SENDER_ID"
      }
      "key": "API_KEY",
      "ver": "1.0"
    ]/pre

    Change value for these keys:

    • SENDER_ID and API_KEY - Set as per the Karix account credentials 
      (If the API key has '=' at the end, add the '=' in the Key Value Pair section explicitly)
                        
  5. Send a test SMS to verify your configuration.
  6. Click Save to save the Sender Configuration.
  7. You can configure delivery tracking after creating the sender in the MoEngage Dashboard. For information about Delivery Tracking, refer to Delivery Tracking for Custom Connectors.
  8. You can map the attributes of the delivery tracking response manually or automatically.Karix_NewUI_PG_DT.png

Configure in Old UI

Log in to the MoEngage dashboard, navigate to Settings > Channel > SMS & Connectors and click the SMS Connector Config tab. Click +CREATE beside Custom Connectors in the left menu.

Step 1: Set the Connector

Fill in the following details:

Field Description
Connector Name Type the name to identify the Karix custom connector.

Sender Name

Type the name to identify the Karix sender.

Step 2: Configure API URL

Add Karix Webhook URL. Use POST Method to send the API request.

API URL: Just copy the below URL in API  URL Field:

http://japi.instaalerts.zone/httpapi/JsonReceiver

In the Body Type, choose Raw and add the following code:

JSON

{
    "messages": [
       {
         "text": "Moesms_message",
         "dest": [Moesms_destination],
         "send": "SENDER_ID"
       }
    ],
    "key": "API_KEY",
    "ver": "1.0"
}

Change value for these keys: 

  • SENDER_ID and API_KEY - Set as per the Karix account credentials 
    (If the API key has '=' at the end, add the '=' in the Key Value Pair section explicitly)

Step 3: Test and save the settings

Do a Test SMS to make sure everything is set up correctly. And finally, click Save to save the settings. 

Step 4: Delivery Tracking

You can configure delivery tracking after creating the sender in the MoEngage Dashboard. For information about Delivery Tracking, refer to Delivery Tracking in Custom Connectors.

Sample response from Karix for a successfully sent message

KarixConfiguration_SMSSentResponse.png

Sample response from Karix for a delivered message

Karix_DeliveryResponse.png

Mapping delivery response

Choose fields from Delivery Response to auto-populate the response mapping fields, as shown below.

Delivery_Response_Mapping.png

Click Save to Save the delivery tracking configuration for the custom connector.

Next Steps

Previous

Next

Was this article helpful?
0 out of 0 found this helpful

How can we improve this article?