DFS v26.1
Loading
API docs by Redocly

DFS Communication services API (latest)

Download OpenAPI specification:

Contains functionality around conversations.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

Communication

Get conversation type Deprecated

Retrieves all conversation types.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get conversation type

Retrieves all conversation types.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "types": [
    ]
}

Count unread conversation threads and messages

Retrieves the number of unread conversation thread and messages.

Authorizations:
Bearer
query Parameters
includeUnreadMessageCount
boolean

Read receipt unread count parameter

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "unreadConversation": 0,
  • "unreadMessageCount": [
    ]
}

Create a new conversation

Creates a new conversation. If the person is a member, they should be able to initiate a conversation with a contact if member have hierarchy access to the contact. They can message another member if they are part of same participant. If the person is a contact, they can initiate a conversation with a member if the member is their direct advisor.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Request body

senderUId
string or null <uuid>

Target persons to start the conversation with

personUIds
Array of strings or null <uuid> [ items <uuid > ]

Sender of the message in the conversation. Nullable

subject
string or null

Subject line of the conversation

body
string or null

Content of the initial message

conversationTypeId
integer <int32>

Id representing the message type

customAttributes
string or null

Optional metadata filters

Array of objects or null (MessageAttachmentRequest)

The list of the message attachments (file name and content of the file).

Responses

Request samples

Content type
{
  • "senderUId": "472d1a74-3f87-48f7-a58b-d1fd6ac105d7",
  • "personUIds": [
    ],
  • "subject": "Lost Credit Card",
  • "body": "Dear Relationship Manager, I lost my credit card today! Can you please block it and order a new one?",
  • "conversationTypeId": 1,
  • "customAttributes": "{\"RecipientClientFilters\" : [19, 20]}",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "conversationId": 1,
  • "messageId": 1
}

Send a new message in existing conversation thread or reply to specific message in the thread

Sends a new message in existing conversation thread or reply to specific message in the thread. A person should be able to reply to a message if they are part of hierarchy access of at least one person in the conversation.

Authorizations:
Bearer
path Parameters
conversationId
required
integer <int32>

Id of the conversation

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Request body

senderUId
string or null <uuid>

Sender of the message in the conversation (nullable)

replyMessageId
integer or null <int64>

Id of the message being replied to (nullable)

body
string or null

Content of the message

customAttributes
string or null

Optional metadata filters

Array of objects or null (MessageAttachmentRequest)

The list of the message attachments (file name and content of the file).

Responses

Request samples

Content type
{
  • "senderUId": "ad1a1578-0b2d-4a6f-ae7b-741e823d209a",
  • "replyMessageId": 1,
  • "body": "Dear Relationship Manager, I lost my credit card today! Can you please block it and order a new one?",
  • "customAttributes": "{\"RecipientClientFilters\" : [19, 20]}",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "messageId": 1
}

Marks the message as read

Set status of the message in conversation as read

Authorizations:
Bearer
path Parameters
conversationId
required
integer <int32>

Id of the conversation

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Request body

messageId
integer <int64>

Id of the Message to be marked read

Responses

Request samples

Content type
{
  • "messageId": 1
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}