Temenos Digital
Updated On 21 October 2022 | Min(s) read

Secure Messaging

Name Description Introduced In
getRequests This API retrieves all the requests of the customer. 2021.01
getUnreadMessageCount This API retrieves all the unread messages count. 2021.10
createRequest This API retrieves all the unread messages count. 2021.10
addAttachment This API adds a new attachment to a new or existing request. 2021.10
getAllMessagesForARequest This API adds a new attachment to a new or existing request. 2021.10
 
Description: This API retrieves all the requests of the customer.
Method: POST
URL: {base_url}/services/data/v1/SecureMessaging/operaetions/Message/getRequests
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

softDeleteFlag (Mandatory)

Specifies the message is soft delete. This is a Boolean Flag.

{
    "softDeleteFlag": "false"
}
Response:

Parameters

customer_id (Mandatory)

Specifies the unique ID for customer.

firstMessage (Mandatory)

Specifies the first message.

ID (Mandatory)

Specifies the unique ID.

msgids (Mandatory)

Specifies the unique message IDs

priority (Mandatory)

Specifies the type of Priority.

priorityCount (Mandatory)

Specifies the total priority count.

readmsgs (Mandatory)

Specifies the count of readmsgs.

recentMsgDate (Mandatory)

Specifies the date of recentmsgs

requestCreatedDate (Mandatory)

Specifies the date of request created.

requestCategorey_id (Mandatory)

Specifies the unique ID for request category.

softdeleteflag (Mandatory)

Specifies if the msg is deleted or not. This is a Boolean.

status_id (Mandatory)

Specifies the unique ID for Status.

totalattachments (Mandatory)

Specifies the total attachments in the message.

totamsgs (Mandatory)

Specifies the count of messages.

errMessage (Mandatory)

Specifies the total error messages.

unreadmsgs (Mandatory)

Specifies the count of unread msgs.

username (Mandatory)

Specifies the unique Username.

{
    "customerrequests_view": [{
        "totalAttachments": "1",
        "firstMessage": "Jm5ic3A7VGVzdCUyME1lc3NhZ2UlMjAx",
        "requestcategory_id": "Credit Cards",
        "recentMsgDate": "2021-10-04T16:20:22Z",
        "priority": "Medium",
        "isPriorityMessage": "0",
        "softdeleteflag": "false",
        "unreadmsgs": "0",
        "priorityCount": "0",
        "msgids": "01394f78-8c33-417d-93ba-186f8396e374,0cc21f49-9465-4db1-ac8a-2e3d81cd0782,20343080-b04d-4839-828a-9fe1c35969d7,47ad0b8a-7c42-4138-ab61-f665e6a7ba62,62fc38f8-00c6-4604-9b49-72efd2857d8a,6c88ac9c-c1d9-4e45-ab8b-776e433996fd,7ad76f02-8544-4bfe-9046-866a807c5d46,9d9d713c-85b8-4665-8217-5f8c5331e87e,a04faa57-ffdb-4ea4-81da-2d773ee8485c,ca42efb2-4e06-475c-ba0e-e1bd4a291099,dc02a851-6988-49db-bb60-b132594bceb6",
        "requestsubject": "Test Message 1 MB",
        "status_id": "Open",
        "totalmsgs": "11",
        "requestCreatedDate": "2021-10-01T10:08:44Z",
        "statusIdentifier": "REQ1741290228",
        "id": "REQ1741290228",
        "customer_id": "5856513691",
        "readmsgs": "2",
        "username": "3027313780"
    }]
}
Error Code(s):

NA
Enterprise Provider: NA
Enterprise API:

NA

Field Mapping

 
Description: This API retrieves all the unread messages count.
Method: POST
URL: {base_url}/services/data/v1/SecureMessaging/operations/Message/getUnreadMessageCount
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

Parameters

unreadMessageCount (Mandatory)

Specifies the count of unread message.

priorityMessageCount (Mandatory)

Specifies the count of priority message.

{
    "unreadMessageCount": 1,
    "opstatus": 0,
    "priorityMessageCount": 0,
    "httpStatusCode": 0
}
Error Code(s):

NA
Enterprise Provider: NA
Enterprise API:

NA

Field Mapping

 
Description: This API retrieves all the unread messages count.
Method: POST
URL: {base_url}/services/data/v1/SecureMessaging/operations/Message/createRequest
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

requestid

Specifies the unique request ID.

messageid (Mandatory)

Specifies the unique message ID.

requestsubject (Mandatory)

Specifies the subject for the request.

requeststatus (Mandatory)

Specifies the status of request.

messagedescription (Mandatory)

Specifies the body/description of message

username (Mandatory)

Specifies the unique Username.

createdby (Mandatory)

Specifies created user ID

priority (Mandatory)

Specifies the type of priority(Normal/Medium/High)

requestcategory_id (Mandatory)

Specifies type unique ID of request category.

mediaIds

Specifies the unique medialD.

{
    "requestid": "REQ1423554234",
    "messageid": "4b181fa7-65b2-487d-9fae-239c23b06693",
    "requestsubject": "Test",
    "requeststatus": "SID_OPEN",
    "messagedescription": "VGVzdA==",
    "username": "3027313780",
    "createdby": "3027313780",
    "priority": "Medium",
    "requestcategory_id": "RCID_ACCOUNTS",
    "mediaIds": ["27859eed-11eb-49cb-868a-203f2038506b"]
}
Response:

Parameters

attachmentId

Specifies the unique attachment ID.

mediaId

Specifies the unique medialD.

messageId (Mandatory)

Specifies unique message ID.

statusCode (Mandatory)

Specifies type of status. This is a Boolean.

requestId (Mandatory)

Specifies the unique request ID.

requestMessage (Mandatory)

Specifies the message in the unique ID.

{
    "3027313780": {
        "requestMessage": {
            "attachments": {
                "uploadAttachments": [{
                    "attachmentId": "818b1453-bd99-432a-bdd4-7ec8136d394c",
                    "mediaId": "27859eed-11eb-49cb-868a-203f2038506b"
                }]
            },
            "messageId": "4b181fa7-65b2-487d-9fae-239c23b06693",
            "statusCode": 0
        },
        "customerRequest": {
            "requestId": "REQ1423554234",
            "statusCode": 0
        }
    },
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

NA
Enterprise Provider: NA
Enterprise API:

NA

Field Mapping

 
Description: This API adds a new attachment to a new or existing request.
Method: POST
URL: {base_url}/services/data/v1/SecureMessaging/operations/Message/createRequest
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

documentName (Mandatory)

Specifies the name of document.

version (Mandatory)

Specifies the version of document

userId (Mandatory)

Specifies the unique User ID.

messageId (Mandatory)

Specifies the unique message ID.

content (Mandatory)

Specifies the content.

{
    "documentName": "testImage.jpg",
    "version": "1.0",
    "userId": "5856513691",
    "messageId": "6176b10f-812e-4c2a-a089-c72ebceb7937",
    "content": "LzlqLzRBQV"
}
Response:

Parameters

id (Mandatory)

Specifies the unique ID.

{
    "opstatus": 0,
    "id": "bf459f2e-f13c-4578-92e2-08ebdb31e0ac",
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code:
    Error Message:
  • Error Code:
    Error Message:
Enterprise Provider: NA
Enterprise API:

NA

Field Mapping

 
Description: This API adds a new attachment to a new or existing request.
Method: POST
URL: {base_url}/services/data/v1/SecureMessaging/operations/Message/getAllMessagesForARequest
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

request_id (Mandatory)

Specifies the unique request_id.

{
    "request_id": "REQ1423554234"
}
Response:

Parameters

Status (Mandatory)

Specifies status of the request(Success/Failure).

lastmodifiedts (Mandatory)

Specifies time stamp of the last modified date.

totalAttachments (Mandatory)

Specifies the total number of attachments in the request.

Size (Mandatory)

Specifies the size of the attachment.

media_Id (Mandatory)

Specifies the unique media_Id.

type (Mandatory)

Specifies the type of media.

Name (Mandatory)

Specifies the name of the attachment.

CustomerRequest_id (Mandatory)

Specifies the unique customerRequest_id.

MessageDescription (Mandatory)

Specifies the message description.

createdby_name (Mandatory)

Specifies the name of the person created it.

IsRead (Mandatory)

Specifies whether the message is read or not read. This is a Boolean.

createdts (Mandatory)

Specifies the time stamp of created date.

RepliedBy (Mandatory)

Specifies whether Admin or CSR replied to that message.

Message_id (Mandatory)

Specifies the unique message ID.

id (Mandatory)

Specifies the unique ID.

{
    "Status": "Success",
    "opstatus": 0,
    "messages": [{
        "lastmodifiedts": "2021-10-10T15:43:52Z",
        "totalAttachments": "1",
        "attachments": [{
            "Size": "156450",
            "media_Id": "27859eed-11eb-49cb-868a-203f2038506b",
            "type": "ATTACH_TYPE_JPG",
            "Name": "testImage.jpg"
        }],
        "CustomerRequest_id": "REQ1423554234",
        "MessageDescription": "VGVzdA==",
        "createdby_name": "  ",
        "IsRead": "TRUE",
        "createdts": "2021-10-10T15:43:25Z",
        "RepliedBy": "ADMIN|CSR",
        "softdeleteflag": "false",
        "ReplySequence": "2",
        "createdby": "",
        "Message_id": "4b181fa7-65b2-487d-9fae-239c23b06693",
        "modifiedby": "3027313780",
        "id": "4b181fa7-65b2-487d-9fae-239c23b06693",
        "synctimestamp": "2021-10-10T15:43:25Z"
    }],
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code:
    Error Message:
  • Error Code:
    Error Message:
Enterprise Provider: NA
Enterprise API:

NA

Field Mapping

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Sunday, March 23, 2025 3:09:02 PM IST