Unified API

Headers

Request Header	Description
key	Service Key
content-type	application/json

##Request Body

{
  "correlationid":"<Unique transaction ID from the client end>", //optional
  "notifyurl":"<Notifications will be sent to the URL specified here>", //optional
  "callbackData":"<Identifier sent alongside notifications to the notifyurl>", //optional
  "expiry":"<Expiry time in UTC format, after which messages will not be pushed. For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30.>", //optional
	"priority": "<Accepts numbers 1-low, 2-medium, and 3-high>", //optional
  "deliverychannel":"<Channel to use for delivery: (sms/voice/push/rt/fb/twitter/wa/wechat>", //Mandatory 
  "message":{//optional
    "template":"<Message template ID.>",
    "parameters":{
      "parameter1":"<value>",
      "parameter2":"<value>",
      "parameter3":"<value>"
    }
  },
   "channels":{ //Mandatory
      "smartlinks":[
        {
            "linkid": "<specifies the link id that is generated for a Smartlink using  IMIconnect. >",
            "validity": "<Specifies the time in minutes after which the link will expire>"
        }
      ],
      "sms":{
        "type":"<Message type 1– Text, 2- Flash, 3– Binary, 4– Unicode>",
        "text":"<Channel specific message text>",
        "body":"<Hexadecimal content for binary type message>",
        "media-path":"<Media path which will be appended to SMS text>",
        "senderid":"<Predefined Sender ID for this message>"
      },
      "voice":{ //Either callflowid or promptid must be passed in the request. If you pass both the parameters, promptid takes the priority.
        "callflowid":"<Call Flow ID (Created in Call Flow Builder).>",
        "promptid":"<id of the uploaded media file (Id is displayed in IMIconnect UI after uploading the file).>",
        "cli":"<Predefined Caller Line Identity to initiate the call.>"
      },
      "appmessaging": {
            "message": {
                "text": "RTM_message",
                "attachment": {
                    "file": "<URL of resource, e.g. http://ip/image.jpg>",
                    "contentType": "image",
                    "size": "10"
                }
            },
            "notification": {
                "web_extras": {
                    "collapse_key": "web_col_key",
                    "action": "web_col_key",
                    "url": "<Valid http URL>"
                },
                "title": "notification_title",
                "text": "notification_text",
                "windows_extras": {
                    "logo": "<URL of resource, e.g. http://ip/image.jpg>",
                    "sound": "wind_not_sound",
                    "image": "<URL of resource, e.g. http://ip/image.jpg>",
                    "badge": "wnd_badge",
                    "notificationaction": {
                        "action": "OPEN_URL",
                        "value": "<Valid HTTP URL>"
                    }
                },
                "interactive": {
                    "category": "DOUBLE_YES_NO",
                    "pushref": "pu_ref",
                    "actions": [{
                            "action": "OPEN_APP",
                            "identifier": "YES",
                            "pos": 1
                        }, {
                            "action": "OPEN_APP",
                            "identifier": "NO",
                            "pos": 2
                        }
                    ]
      },
      "push":{
        "ios":{
          "text":"<iOS specific push message text>",
          "extras":{Refer to iOS extras}
        },
        "android":{
          "text":"<Android specific message text>",
          "priority":"<A value from 1 to 5, where 5 is the highest>",
          "extras":{Refer to Android extras}
        },
        "web" : {
          "title" : "<title text for web browser push message>",
          "text" : "<push message text for Web browser>",
          "url" : "<URL that opens when message is clicked>",
          "actiontext" : "<Specifies the text of the button for safari browsers only>",
          "platorm_types" : ["chrome", "safari", "firefox"],//Specifies the browsers to which the message is sent.
          "extras" : {Refer to web extras}
      },
        "interactive":{
          "pushref":"<Provide a reference value if the results of the push interaction is required as a trigger for rules.>",
          "device_types":[
            "ios",
            "android"
          ],
          "category":"<Each category has a specific context and associated set of actions. Refer to the list of categories.>",
          "actions":[
            {
              "pos":1,
              "action":"<Actions depend on the category>",
              "value":"<Value depends on the action>"
            },
            {
              "pos":2,
              "action":"<Actions depend on the category>",
              "value":"<Value depends on the action>"
            }
          ]
        },
        "OTT-Messaging":{
          "fb":{
            "text":"<Channel specific message text>",    
            "attachment": {
                "type": "<type of attachment: image/template>",
                "payload": { 
                    "template_type": "<type of template: generic/buttons/receipt>",
                    "elements": [{
                        "title": "<bubble title>",
                        "image_url": "<image url that opens when bubble is tapped>",
                            "subtitle": "<subtitle for a bubble>",
                            "buttons": [{
                               "type": "<options for button: web_url/postback>",
                               "url": "<Applicable when button type is web url. Specifies the url that opens in a browser when button is tapped>",
                               "title": "<url title>",
                               "payload": "<Applicable when button type is postback. A user defined payload  that is used in rules>"
                                }]
                            }

                        ]
                    }
                }       
            },
          "twitter":{
            "text":"<Channel specific message text>"
          },
          "wechat": {//text or attachment must be provided. If you provide both, only text is delivered.
              "text": "<Channel specific message text>",
              "attachment": {//Use this object if you have uploaded media without using IMIconnect. 
              "type": "<Supported file types as attachment image/video/>",
              "media_id": "<Media id received from WeChat for the uploaded file>"
              }
           }
        }
      },
      "destination":[ //Mandatory
        {
          "customerid/msisdn/email/android_pushid/ios_pushid/chrome_pushid/safari_pushid/psid/twitterid/wechat_user_id":[
            "<value1>",
            "<value2>"
          ],
          "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
        },
        {
          "customerid/msisdn/email/android_pushid/ios_pushid/chrome_pushid/safari_pushid/psid/twitterid/wechat_user_id":[
            "<value1>",
            "<value2>"
          ],
          "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
        }
      ]
    }
  
}

{  
   "correlationid":"<Unique transaction ID from the client end>", //Optional
   "notifyurl":"<Notifications will be sent to the URL specified here>", //Optional
   "callbackData":"<Identifier sent alongside notifications to the notifyurl>", //Optional
   "expiry":"<Expiry time in UTC format, after which messages will not be pushed. For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30>", //Optional
   "priority":"<Accepts numbers 1-low, 2-medium, and 3-high>", //Optional
   "deliverychannel":"sms", //Mandatory
   "message":{  //Optional
      "template":"<Message template ID.>",
      "parameters":{  
         "parameter1":"<value>",
         "parameter2":"<value>",
         "parameter3":"<value>"
         }
      },
      "channels":{  //Mandatory
         "smartlinks":[
        {
            "linkid": "<specifies the link id that is generated for a smartlink using  IMIconnect. >",
            "validity": "<Specifies the time in minutes after which the link will expire>"
        }
      ],
         "sms":{  
            "type":"<Message type 1– Text, 2- Flash, 3– Binary, 4– Unicode>",
            "text":"<Channel specific message text>",
            "body":"<Hexadecimal content for binary type message>",
            "media-path":"<Media path which will be appended to SMS text>",
            "senderid":"<Predefined Sender ID for this message>"
         }
      },
      "destination":[  //Mandatory
         {  
            "msisdn/customerid":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
         },
         {  
            "msisdn/customerid":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>" //Optional
         }
      ]
   
}

{  
   "correlationid":"<Unique transaction ID from the client end>", //Optional
   "notifyurl":"<Notifications will be sent to the URL specified here>", //Optional
   "callbackData":"<Identifier sent alongside notifications to the notifyurl>", //Optional
   "expiry":"<Expiry time in UTC format, after which messages will not be pushed. . For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30>", //Optional
   "priority":"<Accepts numbers 1-low, 2-medium, and 3-high>", //Optional
   "deliverychannel":"voice", //Mandatory
   "message":{  //Optional
      "template":"<Message template ID.>",
      "parameters":{  
         "parameter1":"<value>",
         "parameter2":"<value>",
         "parameter3":"<value>"
          }
      },
      "channels":{  //Mandatory
         "voice":{ //Either callflowid or promptid must be passed in the request. If you pass both the parameters, promptid takes the priority.
        "callflowid":"<Call Flow ID (Created in Call Flow Builder).>",
        "promptid":"<id of the uploaded media file (Id is displayed in IMIconnect UI after uploading the file).>",
        "cli":"<Predefined Caller Line Identity to initiate the call.>"
      }
      },
      "destination":[  //Mandatory
         {  
            "msisdn/customerid":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
         },
         {  
            "msisdn/customerid":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>" //Optional
         }
      ]
   
}

{  
   "correlationid":"<Unique transaction ID from the client end>", //Optional
   "notifyurl":"<Notifications will be sent to the URL specified here>", //Optional
   "callbackData":"<Identifier sent alongside notifications to the notifyurl>", //Optional
   "expiry":"<Expiry time in UTC format, after which messages will not be pushed. . For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30>", //Optional
   "priority":"<Accepts numbers 1-low, 2-medium, and 3-high>", //Optional
   "deliverychannel":"rt", //Mandatory
   "message":{  //Optional
      "template":"<Message template ID.>",
      "parameters":{  
         "parameter1":"<value>",
         "parameter2":"<value>",
         "parameter3":"<value>"
         }
      },
      "channels":{  //Mandatory
         "smartlinks":[
        {
            "linkid": "<specifies the link id that is generated for a smartlink using  IMIconnect. >",
            "validity": "<Specifies the time in minutes after which the link will expire>"
        }
      ],
         "appmessaging":{  
            "senderid":"<App Messaging sender ID>",
            "extras":{  
               "notificationaction":{
                     "action":"OPEN_URL",
                     "value":"www.google.com"
                        },
               "customtags":{  
                  "key1":"object1",
                  "key2":{  
                     "object2":"val"
                  },
                  "key3":[  
                     "object3",
                     "object4"
                  ]
               }
            },
            "text":"<Channel specific message text>",
            "priority":"<A value from 1 to 5, where 5 is the highest.>",
            "attachments":[
                {
                   "contentType":"<MIME content type, eg. image>",
                   "file":"<URL of resource, e.g. http://ip/image.jpg>",
                   "preview":"<A base64 string of a preview image in JPEG format for video>",
                   "size":"<Size of file in bytes>",
                   "duration":"<Length of audio or video in seconds.>",
                   "latitude":"<Latitude location>",
                   "longitude":"<Longitude location>"
                }
            ],
            "interactive":{  
               "messageref":"<Message reference, for use with as a trigger for rules.>",
               "category":"<Each category has a specific context and associated set of actions. Refer to the list of categories.>",
               "actions":[  
                  {  
                     "pos":1,
                     "action":"<Actions depend on the category>",
                     "value":"<Depends on the action>"
                  },
                  {  
                     "pos":2,
                     "action":"<Actions depend on the category>",
                     "value":"<Depends on the action>"
                  }
               ]
            }
         }
      },
      "destination":[  //Mandatory
         {  
            "msisdn/customerid":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
         },
         {  
            "customerid":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
         }
      ]
   
}

{
    "correlationid": "<Unique transaction ID from the client end>",
    "notifyurl": "<Notifications will be sent to the URL specified here>",
    "callbackData": "<Identifier sent alongside notifications to the notifyurl>",
    "expiry": "<Expiry time in UTC format, after which messages will not be pushed. . For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30>",
    "priority": "<Accepts numbers 1-low, 2-medium, and 3-high>",
    "deliverychannel": "push",
    "message": {
        "template": "<Message template ID.>",
        "parameters": {
            "parameter1": "<value>",
            "parameter2": "<value>",
            "parameter3": "<value>"
        }
    },
    "channels": {
        "push": {
            "pushref": "<Provide a reference value if the results of the push interaction is required as a trigger for rules.>",
            "ios": {
                "text": "<iOS specific push message text>",
                "extras": "<Refer to iOS extras>"
            },
            "android": {
                "text": "<Android specific message text>",
                "priority": "<A value from 1 to 5, where 5 is the highest>",
                "extras": "<Refer to Android extras>"
            },
            "web": {
                "title": "<title text for web browser push message>",
                "text": "<push message text for Web browser>",
                "url": "<URL that opens when message is clicked>",
                "actiontext": "<Specifies the text of the button for safari browsers only>",
                "platorm_types": ["chrome", "safari", "firefox"],
                "extras": "<Refer to web extras>"
            },
            "interactive": {

                "device_types": [
                    "ios",
                    "android"
                ],
                "category": "<Each category has a specific context and associated set of actions. Refer to the list of categories.>",
                "actions": [{
                    "pos": 1,
                    "action": "<Actions depend on the category>",
                    "value": "<Value depends on the action>"
                }, {
                    "pos": 2,
                    "action": "<Actions depend on the category>",
                    "value": "<Value depends on the action>"
                }]
            }
        }
    },
    "destination": [{
        "customerid/android_pushid/ios_pushid/chrome_pushid/firefox_pushid/safari_pushid": [
            "<value1>",
            "<value2>"
        ],
        "correlationid": "<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
    }, {
        "customerid/android_pushid/ios_pushid/chrome_pushid/firefox_pushid/safari_pushid": [
            "<value1>",
            "<value2>"
        ],
        "correlationid": "<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
    }]
}

{  
   "correlationid":"<Unique transaction ID from the client end>",
   "notifyurl":"<Notifications will be sent to the URL specified here>",
   "callbackData":"<Identifier sent alongside notifications to the notifyurl>",
   "expiry":"<Expiry time in UTC format, after which messages will not be pushed. For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30>",
   "priority":"<Accepts numbers 1-low, 2-medium, and 3-high>",
   "deliverychannel":"fb/twitter/wa/wechat",
   "message":{  
      "template":"<Message template ID.>",
      "parameters":{  
         "parameter1":"<value>",
         "parameter2":"<value>",
         "parameter3":"<value>"
          }
      },
      "channels":{
         "smartlinks":[
        {
            "linkid": "<specifies the link id that is generated for a smartlink using  IMIconnect. >",
            "validity": "<Specifies the time in minutes after which the link will expire>"
        }
      ],
        "OTT-Messaging":{
          "fb":{
                "attachment": {
                    "type": "<type of attachment: image/template>",
                    "payload": { 
                        "template_type": "<type of template: generic/buttons/receipt>",
                        "elements": [{
                             "title": "<bubble title>",
                             "image_url": "<image url that opens when bubble is tapped>",
                             "subtitle": "<subtitle for a bubble>",
                             "buttons": [{
                                 "type": "<options for button: web_url/postback>",
                                 "url": "<Applicable when button type is web url. Specifies the url that opens in a browser when button is tapped>",
                                 "title": "<url title>",
                                 "payload": "<Applicable when type is postback. A user defined payload that  is used in rules>"
                                }]
                            }

                        ]
                    }
                }       
            },
            "twitter":{
               "text":"<Channel specific message text>"
            },
            "wa":{  
               "text":"<Channel specific message text>"
            },
            "wechat": {//text or attachment must be provided. If you provide both, only text is delivered.
               "text": "<Channel specific message text>",
               "attachment": {//Use this object if you have uploaded media without using IMIconnect. 
               "type": "<Supported file types as attachment image/video/>",
               "media_id": "<Media id received from WeChat for the uploaded file>"
              }
           }
         }
      },
      "destination":[  
         {  
            "customerid/psid/twitterid/wechat_user_id":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
         },
         {  
            "customerid/psid/twitterid/wechat_user_id":[  
               "<value1>",
               "<value2>"
            ],
            "correlationid":"<A unique transaction ID up to 50 bytes used by Client to match requests with responses. Will override correlationid given in request body.>"
         }
      ]
   
}

The following table describes the elements in the request body:

Parameter	Type	Mandatory	Description
deliverychannel	String	Yes	Specifies the channel to send a message. (sms/voice/push/rt/fb/twitter/wechat).
destination	JSONArray	Yes	The destination parameter is a sub-parameter array of strings. This allows multiple destinations.
channels	JSONArray	Yes	The channel parameter encompasses sub-parameters.
message	JSONObject	No	This parameter is used when the message consisting of a predefined template.
expiry	String	No	Expiry time in UTC format, after which messages will not be pushed. For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30.
correlationid	String	No	A unique transaction ID up to 50 bytes used by Service Providers to match requests with responses.
notifyurl	String	No	A URL that receives notifications. This overrides the service's Notify URL.
callbackData	String	No	Data to be passed alongside notifications to the notifyurl. This can serve as identifying notifications.
priority	String	No	This parameter is used to specify the message priority.

Response

This API may return the following response codes:

Response Code	Message	Description
1001	Queued	Returned when the request is accepted by IMIconnect.
7000	Invalid JSON	Returned when an invalid JSON request is sent.
7001	Authentication failed	Returned when an invalid service key or profile key is provided in the request.
7002	Service key missing	Returned when the parameter key is missing in the message request.
7003	Mandatory parameters missing	Returned when the mandatory parameters configured in custom event are missing.
7004	Invalid parameters	Returned when the parameters are invalid.
7006	Internal error occurred	Returned when an internal error occurs.
7007	Service inactive	Returned when the service is in inactive state.
7009	Max number of destinations	Returned when an API request exceeds the limit (1000) to send messages using messaging API.

Parameters

The section below details all the parameters within the API request.

correlationid

A client-side identifier chosen by the Service Provider to correlate requests and their subsequent responses. The correlationid can be up to 50 bytes long.

{  
   "correlationid":"<Unique transaction ID from the client end up to 50 bytes.>"
}

notifyurl

The IMIconnect platform will send notifications to the URL specified in the notifyurl parameter. The URL is used to retrieve the status of the message sent. The notifyurl can also be configured while creating a service. If the URL is specified in both the service and the messaging API, preference will be given to the messaging API request.

More information of receipts can be found here - http://docs.imiconnect.com/docs/delivery-and-read-receipt-notifications.

{
   "deliveryInfoNotification":{
      "correlationid":"32607da6-8b72-4b71-990d-15d05765c7e6",
      "transid":"2137c260-dae8-4ffa-9ca8-3f5d8a4cab8e",
      "callbackData":"some-use-ful-data",
      "deliveryInfo":{
         "destination":"2105",
         "deliveryStatus":"Delivered",
         "deliveryChannel":"SMS"
      }
   }
}

{  
   "notifyurl":"<Notifications will be sent to the URL specified here>"
}

callbackData

An identifier or data that will be sent alongside notifications to the URL specified in notifyurl.

{  
    "callbackData":"<An identifier that will be returned via the notifyurl.>"
}

priority

This parameter is used to specify the message priority. The priority is defined while creating the client in the admin screen. All the services that are created under this client will have same priority. Messages of equal priorities are delivered in the natural order of their arrival at their destinations. The options for this parameter are:

1 - low
2 - Medium
3 - High

If any invalid option or text is passed, then the priority is set as configured while creating the client.

{

    "priority": "1",
    "deliverychannel": "sms",
    "channels": {
        "sms": {
            "text": "test",
            "type": "1"
        }
    },
    "destination": [{
        "msisdn": ["918519909999"]
    }]

}

expiry

Expiry time in UTC format, after which messages will not be pushed. For example, 2015-04-12T13:00:19.456Z or 2015-04-12T18:30:19.456+5:30.

{
   "expiry":"2015-04-12T13:00:19.456Z " <//UTC message expiry time> 
}

message

The message parameter block references a template via the template ID which is created within the IMIconnect platform.

The amount of sub-parameters in the parameters block depends on the number of parameters expected in the template. These parameters are supplied to the template for substitution in the final message.

{

   "message":{  
      "template":"<Template ID>",
      "parameters":{  
         "parameter1":"<value>",
         "parameter2":"<value>",
         "parameter3":"<value>"
      },
   }
...
}

❗️
Using parameters
If you use message templates, then the parameter name should match with the parameter specified in the template.

📘
The parameters in this message block are overridden if a channel specific parameter block is also used.
Message length is limited as per channel used. The sizes are:

SMS: 1024 bytes

Application notifications:

Android: 4096 bytes

iOS: 4096 bytes

destination

The destination parameter can be a string array of up to 1,000 entries.

📘
Messages can be sent to single or multiple recipients in a single request.

Name	Description
customerid	A customerid is the Client specific unique alphanumerical ID for distinguishing customers. The IMIconnect platform uses this customerid to reference a Customer Profile which may contains one or more customer contact details.The IMIconnect platform will intelligently match the appropriate communication detail within the context of the current communication method.
msisdn	A msisdn is the Mobile Station International Subscriber Directory Number.The msisdn is the subscriber number in international format that starts with the country code and continues with the subscribe number (with the leading zero omitted). For instance the UK number 01234567890 becomes 441234567890.
email	Destination specific ID.
android_pushid	Specifies the Android push ID.
ios_pushid	Specifies the iOS push ID.
chrome_pushid	Specifies the Chrome push ID.
firefox_pushid	Specifies the Firefox push ID and key. The format is pushid@key.
safari_pushid	Specifies the Safari push ID.
psid	Destination specific ID.
twitterid	Destination specific ID.
wechat_user_id	Destination specific ID.
correlationid	A unique transaction ID used by a Client to match requests with responses.Note: This value will override the correlationid in the request body.

{
  "destination":[
    {
      "customerid/msisdn/email/psid/android_pushid/ios_pushid/chrome_pushid/firefox_pushid/safari_pushid/twitterid/wechat_user_id":[
        "<value1>",
        "<value2>"
      ],
      "correlationid":"<Will override correlationid given in request body>"
    },
    {
      "customerid/msisdn/email/psid/android_pushid/ios_pushid/chrome_pushid/firefox_pushid/safari_pushid/twitterid/wechat_user_id":[
        "<value1>",
        "<value2>"
      ],
      "correlationid":"<Will override correlationid given in request body>"
    }
  ]
}

deliverychannel

The deliverychannel value determines the channel to use for delivering messages.

{
  "deliverychannel":"<sms/voice/push/rt/fb/twitter/wa/wechat>"
}

The deliverychannel value may be one of the following:

Channel	Description
sms	Short Messaging Service.Messages are limited to 1024 bytes.
voice	Voice services.
push	Push messaging service
appmessaging	Real Time channel that sends messages to enabled mobile apps to provide App-Messaging.Supports rich multimedia messages with text and optional multimedia items.
Messenger	Facebook Messenger
twitter	TwitterMessages are limited to 140 bytes.
wechat	WeChat

channels

The channels parameter block configures channel communication parameters and will overrides the service's default values and the parameters in the base request.

Click the respective channel links to go to channels API details.

Channel	Subchannels
sms	None
voice	None
Appmessaging	None
push	Android iOS Windows Web Chrome Firefox Safari
OTT-Messaging	fb twitter wa wechat
smartlinks	Smartlinks are supported in the following channels: SMS RT OTT-Messaging channels

smartlinks

An array that contains the parameters of Smartlink. This is an optional. To use Smartlinks, you must create a smartlink and use the link id in messaging API. These Smartlinks can be used in SMS, RT and OTT messaging channels.

Following are the parameters of smartlinks:

Parameter	Type	Mandatory	Description
linkid	Number	Yes	This parameter is mandatory when the `smartlinks` parameter is configured in Messaging. The link id gets generated when a Smartlink is created in IMIconnect.
validity	Number	No	Specifies the time in minutes after which the link will expire.

{
  "smartlinks":[
        {
            "linkid": "<specifies the link id that is generated for a Smartlink using  IMIconnect. >",
            "validity": "<Specifies the time in minutes after which the link will expire>"
        }
      ]
}

Unified API

Headers

Response

Parameters

correlationid

notifyurl

callbackData

priority

expiry

message

❗️
Using parameters

📘
The parameters in this message block are overridden if a channel specific parameter block is also used.

destination

📘
Messages can be sent to single or multiple recipients in a single request.

deliverychannel

channels

smartlinks

Headers

Response

Parameters

correlationid

notifyurl

callbackData

priority

expiry

message

❗️Using parameters

📘The parameters in this message block are overridden if a channel specific parameter block is also used.

destination

📘Messages can be sent to single or multiple recipients in a single request.

deliverychannel

channels

smartlinks

❗️
Using parameters

📘
The parameters in this message block are overridden if a channel specific parameter block is also used.

📘
Messages can be sent to single or multiple recipients in a single request.