Get Customer Push Notifications

Get Customer Push Notifications API is used to retrieve customer related notifications of various types.

HTTP URL  
GET api/v2/customer/{id}/notification

NOTE: Customer {id} is the requesting customer (owner_account_id in database).

Eligibility

The Requestor is eligible to request and receive a list of his own customer notifications or his sub-customer’s notifications.

Query Parameters

Parameter Type M/O/CM Description
fromDate Date M

Starting date of notification retrieval. Format: yyyy-MM-dd. Must occur at least one day before current date
channelNotificationType String M The channel notification type. ENUM valid values: EMAIL, HTTP

Search Parameters (RSQL)

Parameter Type M/O/CM Description
toDate String O Ending date of notification retrieval. Format: yyyy-MM-dd. If empty, then current date [TODAY()] is considered.
customerId UUID O The account notifications were addressed for. If sent empty retrieve any of the requestor’s (customer) notifications including all sub-accounts
deliveryStatus String 0 Notification delivery status. ENUM valid values: SUCCESS, FAILURE. If sent empty retrieve both SUCCESS and FAILURE delivery statuses
ruleType String O Defines the requested rule type. If sent empty retrieve any rule type
fromIccid String O Defines the requested notifications sent to an individual SIM or the first SIM in range to fetch by. If sent empty ignore “toIccid” and retrieve any SIM
toIccid String O Defines the last SIM requested notifications sent to a range of SIM cards. If sent empty, refer to “fromIccid” attribute. In such a case there is no range to fetch by. If populated, it defines the last ICCID value

EXAMPLE: api/v2/customer/{id}/notification?fromDate=20231231&channelNotificationType=EMAIL&search=toDate==20231230;customerId==5ba39f3b-29d2-43ba-948e-0b7103ed0740;deliveryStatus== FAILURE;ruleType==FirstEventAccount;fromIccid==555550;toIccid==5555552. You need to add apostrophes for white space text

Request Structure

Not applicable.

NOTE: Validate correctness of various input parameters such as whether ICCID belongs to a given customer etc.

Response Structure

Parameter Type M/O/CM Description
errorCode String O Failure code. See list below, ‎under ‘Error Codes’ section
errorMessage String O Failure detailed description. See list below, ‎under ‘Error Codes’ section
content Object O Array of main response body object. Displayed when an API call was successful. For a failure it will be empty.
pageable Object O Paging information object. Displayed when an API call was successful. For a failure it will be empty.

Content

Parameter Type M/O/CM Description
iccid String O SIM card serial number receiving the push notification
message String O Message content
deliveryStatus String M Notification delivery status. ENUM valid values: SUCCESS, FAILURE.
customerId UUID M Indicates the customer ID which the notification was sent to.
customerName String M Indicates the customer name which the notification was sent to.
ruleType String O Indicates the requested rule type (action name)
channelNotificationType String M Indicates the channel notification type. ENUM valid values: EMAIL, HTTP
creationTime DateTime M Notification creation date and time
sentTime DateTime O Last notification send attempt date and time

Pageable

Parameter Type M/O/CM Description
page Numeric M Page number
size Numeric M Page size. Number of requested elements per page
 totalPages Numeric M Total amount of available pages per requested page size
totalElements Numeric M Total amount of retrieved elements.

Error Codes

In addition to the general success and failure codes, the following error codes are possible:

Element Description
CUSTOMER_1002 Customer does not exist
CUSTOMER_1006 Failed to retrieve customer details
GLOBAL_1001 Service unavailable. Please try again

Examples

Response Body - Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "iccid": "8935711001000034535",
      "message": "<p>Welcome to floLIVE!<br>As a new user, we ask you to define your password, as follows:<br>Note that your username is your email address: test_bff@mail.com<br>To define your password:<br>1. Click this link: <a href=http://flo-keycloak.solid.flolive.int/auth/realms/flo-realm/login-actions/action-token?key=eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI4NzlmN2I0Yy1hZjU3LTQ4Y2ItYTc2Mi1kY2EwOWU0YzQwMDUifQ.eyJleHAiOjE2OTk4NjUzNDIsImlhdCI6MTY5OTgyMjE0MiwianRpIjoiNWQzMTE0NTctZTMzZC00MjhjLWFkZWEtNTAxZjBiNWE3NmIwIiwiaXNzIjoiaHR0cDovL2Zsby1rZXljbG9hay5zb2xpZC5mbG9saXZlLmludC9hdXRoL3JlYWxtcy9mbG8tcmVhbG0iLCJhdWQiOiJodHRwOi8vZmxvLWtleWNsb2FrLnNvbGlkLmZsb2xpdmUuaW50L2F1dGgvcmVhbG1zL2Zsby1yZWFsbSIsInN1YiI6IjFiMDBjMTg3LTVkNTQtNGY2Yy05NDliLTliNDgzOTkyMTczNSIsInR5cCI6ImV4ZWN1dGUtYWN0aW9ucyIsImF6cCI6ImFjY291bnQiLCJub25jZSI6IjVkMzExNDU3LWUzM2QtNDI4Yy1hZGVhLTUwMWYwYjVhNzZiMCIsImVtbCI6InRlc3RfYmZmQG1haWwuY29tIiwicnFhYyI6WyJWRVJJRllfRU1BSUwiXSwicnFhYyI6WyJWRVJJRllfRU1BSUwiXX0.urxNtY2q1IBikOdaqDkNGRemOWNktB0VTTH_aVtDEh4>Link to account update</a><br>This link will expire within 12 hours. <br>2. Log in at https://floportal.flolive.net <br>If you do not succeed, contact floLIVE Customer Service at this email address: support@flolive.net<br>Thank you.<br>Best Regards,<br>The floLIVE Team</p>",
      "deliveryStatus": "FAILURE",
      "failureReason": "Missing Notification Owner Account Path",
      "customerId": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
      "customerName": "Gualas LTD.",
      "ruleType": "FirstEventAccount",
      "channelNotificationType": "HTTP",
      "creationTime": "2023-10-10T09:06:22",
      "sentTime": "2023-11-09T18:37:07"
    },
    {
      "iccid": "8935711001000031146",
      "message": "<p>Welcome to floLIVE!<br>As a new user, we ask you to define your password, as follows:<br>Note that your username is your email address: test_bff@mail.com<br>To define your password:<br>1. Click this link: <a href=http://flo-keycloak.solid.flolive.int/auth/realms/flo-realm/login-actions/action-token?key=eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI4NzlmN2I0Yy1hZjU3LTQ4Y2ItYTc2Mi1kY2EwOWU0YzQwMDUifQ.eyJleHAiOjE2OTk4NjUzNDIsImlhdCI6MTY5OTgyMjE0MiwianRpIjoiNWQzMTE0NTctZTMzZC00MjhjLWFkZWEtNTAxZjBiNWE3NmIwIiwiaXNzIjoiaHR0cDovL2Zsby1rZXljbG9hay5zb2xpZC5mbG9saXZlLmludC9hdXRoL3JlYWxtcy9mbG8tcmVhbG0iLCJhdWQiOiJodHRwOi8vZmxvLWtleWNsb2FrLnNvbGlkLmZsb2xpdmUuaW50L2F1dGgvcmVhbG1zL2Zsby1yZWFsbSIsInN1YiI6IjFiMDBjMTg3LTVkNTQtNGY2Yy05NDliLTliNDgzOTkyMTczNSIsInR5cCI6ImV4ZWN1dGUtYWN0aW9ucyIsImF6cCI6ImFjY291bnQiLCJub25jZSI6IjVkMzExNDU3LWUzM2QtNDI4Yy1hZGVhLTUwMWYwYjVhNzZiMCIsImVtbCI6InRlc3RfYmZmQG1haWwuY29tIiwicnFhYyI6WyJWRVJJRllfRU1BSUwiXSwicnFhYyI6WyJWRVJJRllfRU1BSUwiXX0.urxNtY2q1IBikOdaqDkNGRemOWNktB0VTTH_aVtDEh4>Link to account update</a><br>This link will expire within 12 hours. <br>2. Log in at https://floportal.flolive.net <br>If you do not succeed, contact floLIVE Customer Service at this email address: support@flolive.net<br>Thank you.<br>Best Regards,<br>The floLIVE Team</p>",
      "deliveryStatus": "FAILURE",
      "failureReason": "Missing Notification Owner Account Path",
      "customerId": "e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
      "customerName": "Niadent LTD.",
      "ruleType": "FirstEventAccount",
      "channelNotificationType": "HTTP",
      "creationTime": "2023-11-05T13:16:48",
      "sentTime": "2023-12-05T13:29:49"
    }
  ],
  "pageable": {
    "page": 1,
    "size": 10,
    "totalPages": 1,
    "totalElements": 2
  }
}

Response Body: Failure NAK

Copy 
{
  "errorCode": "CUSTOMER_1006",
  "errorMessage": "Failed to retrieve customer details",
  "content": "",
  "pageable": ""
}