LinQ2 P-Series XML Structure Description v 2.0

Modified on Mon, 11 Mar 2024 at 02:51 PM

Cover Letter

Document Control


Product Name	LinQ2 P-Series
Prepared by:	Cerebra
Version and Date	16th September 2021
Distribution

Authors and Reviewers

Name	Company	Email
Derhem Al Nuaimi	Cerebra	dnuaimi@cerebra.sa
Abdulmalik Alomayri	Cerebra	aomayri@cerebra.sa

Change Control

Name	Date	Version	Change Made
Abdulmalik Alomayri	12th September 2021	1.0	Initial Draft
Rehan Farooq	13th September 2021	1.0	Updated as per new Schema
Derhem Al Nuaimi	16th September 2021	1.1	Review
Derhem Al Nuaimi	6th January 2022	1.2	Add JSON samples

Reference Document

Document Description	Date	Version

Confidentiality Agreement

This document is the property of Cerebra and may not be reproduced, by any means, in whole or in part, without prior permission of Cerebra. The document is provided on the understanding that its use will be confined to the officers of your Company, and that no part of its contents will be disclosed to third parties without prior written consent of Cerebra. The document is to be returned to Cerebra when no longer required for the agreed purpose

XML File Integration

Introduction: -

This is a doc representing in details LinQ2 XML structure regardless channel is using it.

LinQ2 channels using this XML structure are:

XML File Channel
Default Database channel
MQueue channel
Http Push channel “i.e. GatewayServlet”

Each one of these channels is handling fetching and extracting the XML content in its own way.

Structures

XML Message Structure:


Element						Type	Max. Len	Rep	Allowed Values	Mandatory	Description
Evnt_Id						Text	10	1	N/A	Y	Unique Event Identifier.
Evnt_Source						Text	10	1	‘OMS’, ‘CRM’	Y	Event source. Put here a text representing which internal system has generated this XML. It should be meaningful enough as it is going to be viewed in reports as it is.
Evnt_Priority						Number	1	1	1-9 Default 1	N	Notification priority If not specified then notification will be sent with normal priority 1 is the least priority and 9 is the highest.
Org_Id						Number	10	1	Default = 1	N	Organization id. You can find the Organization ID saved in LinQ2 from web interface Organization> Hierarchy .If you used the main organization (i.e. tree root) then you use the default value.
Due_Dt						Text	19	1	yyyy-MM-dd HH:mm:ss	N	Due date Useful in case you want to schedule messages If null, notification will be sent immediately.
Validity						Number	10	1	N/A	N	Define the validity time in millisecond  for this message. after this period the message will be expired
SMS_Type						Number	1	1	1- SMS Template Name is passed. 2-English SMS Content is passed 3- Unicode SMS content is passed 4- Arabic text is passed	Y(if SMS notification method is required)	Identifier for the SMS Message Content. Unicode is in the format “\uXXXX\uYYYY\uZZZZ … etc”
SMS						Text	1000	1	Message Content/ Template Name.	Y (if SMS notification method is required)	SMS Content or Template Name.
SMSSender						Text	11	1	Sender	N	Identifier the SMS Sender
Email_Type						Text	1	1	1- Email Template Name is passed. 2-English Email Content is passed 3- Unicode Email content is passed 4- Arabic text is passed 5 – Html content is passed	Y (if Email notification method is required)	Identifier for the Email Content.
Email						Text	10000	1	Template Name / Email Content (plain text)/ Email Content (html within CDATA tag)	Y(if SMS notification method is required)	Email Content or Email Template Name
Rcpnt_Lst						Text	0	0-n	N/A	N	Parent tag for recipient list
	Rcpnt_Dtls					Text	0	0-n	N/A	N	recipient details
		Ntfctn_Mthd				Text	5	1	1^st char for SMS activation status 2^nd char for Email activation status 3^rd -4^th Reserved. 5^th char for Push Notifications 6^th char for Voice Notification Allowed values for each character: 0: Available but not activated. 1: Available and activated. N: Not available.	Y	Notification method SMS/E-mail or both. e.g. 10000 means only SMS. 01000 means only Email. 11000 means this message is sent as an email and SMS.
		Ntfctn_Lng				Text	5	1	ar_SA: Arabic en_US: English ea: English template with Unicode parameters	Y (if template is used)	Notification language
		Provider_Id				Number	2	1	0, 1, 2, 3…	N	The assigned provider for this message
		Group_Id				Text	14	1	N/A	N	Recipients Group Id To get Group ID: create a group on the root level Contact a LinQ2 team member to extract Group ID for you.
		Contact_Id				Text	14	1	N/A	N	Recipient Contact Id To get Contact ID: create a contact on the root level Contact a LinQ2 team member to extract Contact ID for you.
		Mbl_Tel				Text	14	1	N/A	Y (If sms notification is required and both group_id and contact_id are not specified)	Recipient mobile telephone. The mobile number going to receive the SMS. It should be in international format 9665NNNNNNNN.
		Message_Options				Number		1	0: Normal Message 1: Flash Message	N	Message Types : Normal or Flash
		Fax_Number				Text	14	1	N/A	Y (if fax notification is required)	Recipient fax number
		Dlv_Ntfn				Text	1	1	0: No SMSC Delivery Receipt requested (default) 1: SMSC Delivery Receipt requested for delivery success or failure 2: SMSC Delivery Receipt requested for delivery failure	N	Delivery Notification
		Email_To				Text	48	1	N/A	N	Recipient Email Id, mandatory if Email notification is activated In case of multiple, Email Ids will be separated with ‘,’
		Email_CC				Text	4899	1	N/A	N	Copy carbon Email Id. In case of multiple CC, Email Ids will be separated with ‘,’
		Email_BCC				Text	4899	1	N/A	N	Private copy carbon Email Id. In case of multiple BCC, Email Ids will be separated with ‘,’
		Email_server				Text	20	1	N/A	N	Not used
		Email_Sbjct				Text	60	1	N/A	N	Email subject
		Att_Fl_Name				Text	256	1	N/A	N	If specified, the file from email folder will be sent as attachment
		Att_Dp_Name				Text	256	1	N/A	N	The display name of attachment
		Additional_info				Text		1	N/A	N	Not used
		Push_Dtls				Text	0	0-n	N/A	N	Parent tag for push notifications list
					Svc	Number		1	1: mPass Push 2: PushWoosh 3: OneSignal 4: Google FCM	Y	Push service selection
					Title	Text	20	1	N/A	Y	Push notification title
					Body	Text	500	1	N/A	Y	Push notification body
					Notif_Type	Number		1	1: Normal 2: In App	N	Optional notification type not implemented yet
					Recipient	Text	30	1	N/A	Y	Device ID for mPass, and OneSignal & tag value for PushWoosh Device toke for Google FCM
					Device_Platform	Text	7	1	Android Or iOS	N	Device platform for mPass push
					Segment	Text	20	1	N/A	N	Segment name for OneSignal
					Template_Code	Text	20	1	N/A	Y	Push notification template code from P-Series enumerations
					Tag_Value	Text	20	1	N/A	N	Tag value for pushwoosh
		Voice_Dtls				Text	0	0-n	N/A	N	Parent tag for voice notifications list
					Recipient	Text	30	1	N/A	Y	Recipient’s phone number
					Template	Text	20	1	N/A	Y	Voice template name from P-Series voice templates
			Parameters			Text	100	0-n	N/A	Y	Template parameter
				Param-name		Text	100	1	N/A	Y	Parameter name.
				Param-value		Text	100	1	N/A	Y	Parameter numeric value.
		Parameters				Text	100	1	N/A	N	Template parameters
			Parameter			Text	100	0-n	N/A	Y	Template parameter
				Param-name		Text	100	1	N/A	Y	Parameter name. It is the name you provided inside your template stored in LinQ2. Usually in the format ${Param}. IT IS A CASE SENSTIVE ELEMENT.
				Param-value		Text	100	1	N/A	Y	Parameter value. Can be processed it in the form of “\uXXXX\uYYYY\uZZZZ … etc” if the *SMS_Type* was Template, *Ntfctn_Lng* was Arabic and the application could find the string”\u” in this tag *Param-value*.
*Comments*						If optional fields do not have values it should not appear in the XML message. Parameters will be supplied as replaceable tokens in case of using predefined template. Parameters names should be synchronized between IT team (who will generate this xml) and Business team (who will define templates) The following order will be checked to determine the recipient(s): Group_Id: the message will be sent to all contacts in this group Contact_Id: the message will be sent to this contact Mbl_Tel & Email_To: the message will be sent to specified number. The XSD file of this XML structure will be provided while project implementation. Each request can have SMS, Email and Push Notification, this is controlled through Ntfctn_Mthd

XML Samples

Sample request 1-Send message to group using template

Request

<?xml version='1.0' ?>

<Evnt_Id>1002</Evnt_Id>

<Evnt_Source>CreditCard</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<SMSSender>MySenderId</SMSSender>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Group_Id>g1</Group_Id>

<Email_CC>abcd@xyz.com</Email_CC>

<Email_BCC>abcd1@xyz.com </Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abcd</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample request 2-Send SMS to multiple recipients using template.

Request

<?xml version='1.0' ?>

<Evnt_Id>11111</Evnt_Id>

<Evnt_Source>creditcard</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<SMSSender>MySenderId</SMSSender>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>11000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966557702129</Mbl_Tel>

<Email_To>abc@xyz.com</Email_To>

<Email_CC>abc1@xyz.com</Email_CC>

<Email_BCC>abc2@xyz.com</Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abc</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

<Rcpnt_Dtls>

<Ntfctn_Mthd>11000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966557702129</Mbl_Tel>

<Email_To>abc@xyz.com</Email_To>

<Email_CC>abc1@xyz.com</Email_CC>

<Email_BCC>abc2@xyz.com</Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abc2</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample - SMS Template Not Available

Request

<?xml version='1.0' ?>

<Evnt_Id>1001</Evnt_Id>

<Evnt_Source>123</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<SMSSender>MyApplication</SMSSender>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Group_Id>g1</Group_Id>

<Email_CC>abcd@xyz.com</Email_CC>

<Email_BCC>abcd1@xyz.com </Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abcd</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample - Email Template Not Available

Request

<?xml version='1.0' ?>

<Evnt_Id>1002</Evnt_Id>

<Evnt_Source>123</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<SMSSender>MyApplication</SMSSender>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Group_Id>g1</Group_Id>

<Email_CC>abcd@xyz.com</Email_CC>

<Email_BCC>abcd1@xyz.com </Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abcd</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample - Duplicate Event Id test

Request

<?xml version='1.0' ?>

<Evnt_Id>1002</Evnt_Id>

<Evnt_Source>123</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<SMSSender>MyApplication</SMSSender>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Group_Id>g1</Group_Id>

<Email_CC>abcd@xyz.com</Email_CC>

<Email_BCC>abcd1@xyz.com </Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abcd</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample:- Invalid XML

Request

<?xml version='1.0' ?>

<Evnt_Id>1002</Evnt_Id>

<Evnt_Source>123</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<SMSSender>MyApplication</SMSSender>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Group_Id>g1</Group_Id>

<Email_CC>abcd@xyz.com</Email_CC>

<Email_BCC>abcd1@xyz.com </Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abcd</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample:- Send message to direct recipients.

Request

<?xml version='1.0' ?>

<Evnt_Id>11111</Evnt_Id>

<Evnt_Source>123</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>11000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966557702129</Mbl_Tel>

<Email_To>abc@xyz.com</Email_To>

<Email_CC>abc1@xyz.com</Email_CC>

<Email_BCC>abc2@xyz.com</Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abc</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

<Rcpnt_Dtls>

<Ntfctn_Mthd>11000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966557702129</Mbl_Tel>

<Email_To>abc@xyz.com</Email_To>

<Email_CC>abc1@xyz.com</Email_CC>

<Email_BCC>abc2@xyz.com</Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abc2</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample 6- Send message to group.

Request

<?xml version='1.0' ?>

<Evnt_Id>1012</Evnt_Id>

<Evnt_Source>123</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<SMSSender>MyApplication</SMSSender>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Group_Id>g1</Group_Id>

<Email_CC>abcd@xyz.com</Email_CC>

<Email_BCC>abcd1@xyz.com </Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>abcd</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample - Arabic message

Request

<?xml version='1.0' ?>

<Evnt_Source>5677</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>4</SMS_Type>

<SMS>سيريبرا</SMS>

<SMSSender>senderId</SMSSender>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>ar_SA</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966511111111</Mbl_Tel>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample - Unicode message

Request

<?xml version='1.0' ?>

<Evnt_Source>5677</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>3</SMS_Type>

<SMS>\u0634\u0631\u0643\u0629\u0627\u0644\u062d\u0644\u0648\u0644\u0020

\u0627\u0644\u0645\u062a\u0645\u064a\u0632\u0647</SMS>

<SMSSender>senderId</SMSSender>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>10000</Ntfctn_Mthd>

<Ntfctn_Lng>ar_SA</Ntfctn_Lng>

<Ntfctn_Enc>U</Ntfctn_Enc>

<Mbl_Tel>966511111111</Mbl_Tel>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample - Send Long Message.

Request

<?xml version='1.0' ?>

<Evnt_Id>S3</Evnt_Id>

<Evnt_Source>dMS</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>5</Evnt_Priority>

<SMS_Type>2</SMS_Type>

<SMS>User's dashboard displays current messaging activities for you. The up-to-date status of messages are shown in the form of graphical charts. The credit chart displays current available credits and sent messages while message history chart displays sent messages for last 6 months.</SMS>

<SMSSender>WatanInvest</SMSSender>

<Email_Type>2</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>11000</Ntfctn_Mthd>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966557702129</Mbl_Tel>

<Email_To>spatel@is.com.sa</Email_To>

<Email_CC>spatel@is.com.sa.com</Email_CC>

<Email_BCC>spatel@is.com.sa.com</Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>Talal Al-Basha</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

<Rcpnt_Dtls>

<Ntfctn_Mthd>11000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966557702129</Mbl_Tel>

<Email_To>talal_basha@is.com.sa</Email_To>

<Email_CC>spatel@is.com.sa</Email_CC>

<Email_BCC>spatel@is.com.sa.com</Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<param-name>custName</param-name>

<param-value>Talal Al-Basha</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample:- Send SMS and email with attachment

Request

<?xml version='1.0' ?>

<Evnt_Id>11111</Evnt_Id>

<Evnt_Source>123</Evnt_Source>

<Due_Dt>2008-07-16 16:04:04</Due_Dt>

<Evnt_Priority>1</Evnt_Priority>

<SMS_Type>1</SMS_Type>

<SMS>ACCOUNT_OPENED_TPL</SMS>

<Email_Type>1</Email_Type>

<Email>ACCOUNT_OPENED_EMAIL_TPL</Email>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>11000</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>A</Ntfctn_Enc>

<Mbl_Tel>966557702129</Mbl_Tel>

<Email_To>abc@xyz.com</Email_To>

<Email_CC>abc1@xyz.com</Email_CC>

<Email_BCC>abc2@xyz.com</Email_BCC>

<Email_Sbjct>Account Opened</Email_Sbjct>

<Att_Fl_Name>Account_details.xls</Att_Fl_Name>

<Att_Dp_Name>Account_details.xls</Att_Dp_Name>

<param-name>custName</param-name>

<param-value>abc</param-value>

</parameter>

<param-name>accountNumber</param-name>

<param-value>444883273987</param-value>

</parameter>

</parameters>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample:- Send Push Notifications OneSignal

Request

<?xml version='1.0' ?>

<Evnt_Id>123456</Evnt_Id>

<Evnt_Source>Default</Evnt_Source>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>00001</Ntfctn_Mthd>

<Push_Dtls>

<Title>A Test Push Message</Title>

<Body>This is a test push message</Body>

<Template_Code>OneSig01</Template_Code>

</Push_Dtls>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample:- Send Push Notifications PushWoosh

Request

<?xml version='1.0' ?>

<Evnt_Id>12345678</Evnt_Id>

<Evnt_Source>Default</Evnt_Source>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>00001</Ntfctn_Mthd>

<Push_Dtls>

<Title>A Test Push Message</Title>

<Body>This is a test push messgage from MQ</Body>

<Notif_Type>1</Notif_Type>

<Template_Code>T100</Template_Code>

<Tag_Value>rfarooq</Tag_Value>

</Push_Dtls>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample:- Send Push Notifications Google FCM

Request

<?xml version='1.0' ?>

<Evnt_Id>12345678</Evnt_Id>

<Evnt_Source>Default</Evnt_Source>

<SMS_Type>2</SMS_Type>

<Rcpnt_Lst>

<Rcpnt_Dtls>

<Ntfctn_Mthd>00001</Ntfctn_Mthd>

<Ntfctn_Lng>en_US</Ntfctn_Lng>

<Ntfctn_Enc>E</Ntfctn_Enc>

<Push_Dtls>

<Title>Test Google Fcm from Webservice</Title>

<Body>FCM push from Webservice</Body>

<Notif_Type>1</Notif_Type>

<Recipient>devicetokenfromgooglefcm</Recipient>

<Template_Code>GoogleFcm01</Template_Code>

</Push_Dtls>

</Rcpnt_Dtls>

</Rcpnt_Lst>

</EAIMessage>

Sample:- PushWoosh template code enumeration value

Template Code

name:<template_name>,app_code:<your_app>,auth_token:<your_auth_token>,userTag:<your_pushwoosh_tag>,tagType:<push_woosh_tag_type>,tagScope:<app/gen>,pushSvc:pw

Sample:- OneSignal template code enumeration value

Template Code

name:<template_name>,app_code:<onesignal_app_id>,auth_token:<onesignal_auth_toke>,pushSvc:os

Sample:- Google FCM template code enumeration value

Template Code

name:<template_name>,auth_token:<fcm_auth_toke>,pushSvc:fc

1.1.1 Sample:- SMS Template (JSON)

Request

{

   "EAIMessage": {

      "Evnt_Id": "5",

      "Evnt_Source": "Default",

      "SMS_Type": "1",

      "SMS": "OTP1",

      "Rcpnt_Lst": {

         "Rcpnt_Dtls": {

            "Ntfctn_Mthd": "1000",

            "Ntfctn_Lng": "ar_SA",

            "Mbl_Tel": "966560833897",

            "parameters": {

               "parameter": {

                  "param-name": "code",

                  "param-value": "9091"

               }

Sample:- Send Push Notifications PushWoosh (JSON)

Request

{

  "EAIMessage": {

    "Evnt_Id": "1",

    "Evnt_Source": "Default",

    "Rcpnt_Lst": {

      "Rcpnt_Dtls": {

        "Ntfctn_Mthd": "00001",

        "Push_Dtls": {

          "Svc": "2",

          "Title": "A Test Push Message from WS",

          "Body": "pushwoosh message from webservice",

          "Notif_Type": "1",

          "Recipient": "dnuaimi",

          "Template_Code": "PWT1",

          "Tag_Value": "dnuaimi"

        }

Sample:- Send Push Notifications OneSignal (JSON)

Request

{

  "EAIMessage": {

    "Evnt_Id": "1",

    "Evnt_Source": "Default",

    "Rcpnt_Lst": {

      "Rcpnt_Dtls": {

        "Ntfctn_Mthd": "00001",

        "Push_Dtls": {

          "Svc": "3",

          "Title": "A Test Push Message from WS",

          "Body": "OneSignel message from webservice",

          "Notif_Type": "1",

          "Recipient": "be37cfd9-5a49-4dff-86f8-1123e83298ce",

          "Template_Code": "OST1",

          "Tag_Value": "dnuaimi"

        }

Sample:- Send Push Notifications Google FCM (JSON)

Request

{

  "EAIMessage": {

    "Evnt_Id": "1",

    "Evnt_Source": "Default",

    "Rcpnt_Lst": {

      "Rcpnt_Dtls": {

        "Ntfctn_Mthd": "00001",

        "Push_Dtls": {

          "Svc": "3",

          "Title": "Test Google Fcm from Webservice",

          "Body": "FCM push from Webservice",

          "Notif_Type": "1",

          "Recipient": " cqkILWKXQku9cPA40V0A5K:APA91bFCx3btI7g_aUZMxO6TTafC6rPRRPqa1V5BhyujJIOX1Qt11UxHzFuEdJ7OTnLRP_ntQAxMTaurkomau8XB1GrZUI8RDkwBnS-oJXiP0n0CU5qt03032l1IDLUiJKp1yR4pw6kR

          "Template_Code": "FCM",

          "Tag_Value": "dnuaimi"

        }

Error description: -

Error Description	Action To take	S.No
Invalid XMl / Unable to parse xml	Xml Is not correct please check the xml format	1
SMS template should be defined in both languages English and Arabic	Specified SMS template is not available please add SMS template in English and Arabic	2
Email template should be defined in both languages English and Arabic	Specified Email template is not available please add Email template in English and Arabic and check resource directory path.	4
Please change event id to make this transaction unique	Change Event id for this xml	5
Unable to Validate the file XYZ.xml Error Message::error: Unexpected element: CDATA. This issue occurs in case of XML file channel.	File is not saved in UTF8 format. Please save file in UTF 8 Format	6

Constraints

1. SMS template should be defined in both languages English and Arabic.

2. Email template should be defined in both languages English and Arabic. If email option is also selected.

3. Event id should be unique.

4. Xml format should be correct as mention structure.

5. In case of XML File channel, XML File should be saved in UTF8 format.

6. You can't send SMS to groups created by other than administrator.

7. For Push Notifications the push template code should be defined in the enumerations as per the required formats of PushWoosh, OneSignal.and Google FCM.