dxp-ux

(0 reviews)

Notifications (TMF-681)

[POST]

communicationMessage (TMF681): This use case creates a communication entity for SMS and Email for PayTM

/communicationMessage:

Key Considerations for PR:

  1. The Paytm team will manage email and SMS templates.
  2. We are assuming that there won't be a large payload for P0 notifications and attachment.
  3. Both application/json & application/zip request payload is supported.
  4. P0 notifications will be customer-specific and will be sent one at a time.

"SMS"

  1. For "SMS", the message is sent from Mavenir.
  2. Mavenir doesn't accept special characters in "content" field (Example: á, é, ñ).
  3. Mavenir will send SMS to only one reciever.phonenumber at a time.
  4. Mavenir will send SMS with the same name sent from input request field "sender.name". If we wont receive sender.name from input request, ESB will send default value as "Liberty".
  5. There is no format and length validation on reciever.phoneNumber in ESB.
  6. Mavenir doesn't accept spaces and special characters in case of Phone Number, expected phoneNumber format "1++"countryCode"++PhoneNumber". Example: 1787XXXXXX.

"Email"

  1. For "Email", ESB is integrated with AWS SES Service.
  2. Sender email(from email address) should configured in AWS SES, same configured email should be passed. Example: For eCommerce LCPR "shop-noreply@libertypr.com" is configured.
  3. The payload.content type should be "JSON" string.

/communicationMessage/send:

URL

https://[localhost]:[port]/ecom-ux/v1/CR/communicationMessage/send

Base URI Parameter

NameTypeM/ODescription
businessIdstringMbusinessId string M Business unit identifier. Example: "CR”

Headers

NameTypeM/ODescription
channelIdstringOChannel to identify the business group.

Security Headers

NameTypeM/ODescription
client_idstringMClient Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332
client_secretstringMClient secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43f

QueryParams

NameTypeM/ODescription
notificationTypestringMBusiness notification type.
Example: "B2B_PLACE_ORDER_CUSTOMER"

Data Model: CR B2B

Field NameM/ONotes
SubjectMFor B2B_PLACE_ORDER_CUSTOMER: Su orden de Liberty ha sido solicitada
For B2B_PLACE_ORDER_AGENT: Web B2B Venta - Empresa: Ex: Web B2B Venta - Empresa: LLA
For B2B_PLACE_LEAD_CUSTOMER: Su solicitud de contacto con Liberty ha sido recibida
For B2B_PLACE_LEAD_AGENT: Web B2B Lead - Empresa: Ex: Web B2B Lead - Empresa: LLA
receiver.emailMThe recipients email address
sender.emailMSenders email address
TypeMEmail. Currently only supported
CharacteristicMIs the array object with name value pairs.
"name": "CUSTOMER_NAME",
"value": "david"
MM for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_ORDER_CUSTOMER/ B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER
"name": "PHONE",
"value": "9999-9999"
M (Format should be : XXXX-XXXX (8 digits in 2 groups of 4 digits separated by a Hyphen))M for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_ORDER_CUSTOMER/ B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER
"name": "COMPANY",
"value": "LLA"
MM for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_ORDER_CUSTOMER/ B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER
"name": "ID_NUMBER",
"value": "9876543210"
M (Format should be: XXXXXXXXXX (10 digits with no separation))M for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_ORDER_CUSTOMER/ B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER
"name": "EMAIL",
"value": "fname.lname@gmail.com"
MM for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_ORDER_CUSTOMER/ B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER
"name": "PRODUCT_NAME1",
"value": "Triple Play Full"
MM for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_ORDER_CUSTOMER/ B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER
"name": "PRODUCT_SUPERCATEGORY_NAME1",
"value": "3P-Bundles"
MM for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_ORDER_CUSTOMER/ B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER
"name": "REQUEST_URL",
"value":"https://libertycr.com/es/home-empresas?
u_content=GoogleAds&utm_medium=cpc&utm_source=
google.com&utm_campaign=CRC_B2B_LAUNCH"
MM for notificationType= B2B_PLACE_ORDER_AGENT/ B2B_PLACE_LEAD_AGENT
"name": " MESSAGE",
"value":"Lorem ipsum dolor sit amet consectetur adipisicing elit. Incidunt consequatur ad impedit.
At nostrum aspernatur non totam, voluptatem quis. Blanditiis, debitis pariatur non vel deserunt
dolorum voluptate aliquid perspiciatis possimus?"
MM for notificationType= B2B_PLACE_LEAD_AGENT/ B2B_PLACE_LEAD_CUSTOMER

Reviews