dxp-ux

1. This use case creates a communication entity to send Email and SMS.
2. It is implemented for 'PR' and 'PA'.

POST /communicationMessage

URL

https://[localhost]:[port]/dxp-ux/v1/PA/communicationMessage

URL PARAMS

Header

QueryParams

Data Model

Request Data Model

receiver subRequest - dataModel

characteristic subRequest - dataModel

Response Data Model

receiver subResponse - dataModel

Key Considerations :

• Please refer the examples from the following URL - DXP UX - POST 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.

Key Considerations for PA:

General SMS Key points:

1. The SMS is sent from Mavenir.
2. Mavenir doesn't accept accent / 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 won't receive sender.name from input request, ESB will send default value as "Liberty".
5. Mavenir doesn't accept spaces and special characters in case of "sender.name", expected "sender.name" format Example: MasMovil.
6. There is no format and length validation on reciever.phoneNumber in ESB.
7. Mavenir doesn't accept spaces and special characters in case of Phone Number, expected phoneNumber format "1++"countryCode"++PhoneNumber".
8. In case of any dynamic parameters in the template, the request need to be sent by adding notification_type (queryParameter) and characteristics in request payload accordingly.
9. "state" should be sent as "initial" in the request.

roamingPlanPurchase-purchaseConfirmation:

1. For Roaming Purchase Confirmation SMS usecase when the purchase is successful, the queryParam 'notificationType 'should be 'ROAMING_PURCHASE_CONFIRMATION' and characterstic 'ProductName' should be sent in input payload request (refer the example 'PA-MiAPP-Purchase-Confirmation-SMS-Success-Request').
2. When the plan purchase can not be completed, Static failure message should be sent in the input request payload (payload.content).
3. Sender name should always need to be sent as 'MasMovil'.
4. For purchase confirmation SMS notification success usecase, the SMS content value will be 'Su paquete <ProductName> ha sido activado. Disfruta tu viaje!'
5. For purchase confirmation SMS notification error usecase, the SMS content value will be
   'Error de transaccion
   Hubo un error y no pudimos completar la transaccion. Puedes volver a intentarlo o cambiar el metodo de pago'

prepaidAdvanceBalanceAndPlans:

1. For prepaidAdvanceBalanceAndPlans characteristic[] array is dynamic and will be sent from input request

/communicationMessage/send:

URL

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

Base URI Parameter

Headers

Security Headers

QueryParams

Data Model: CR B2B