# CommunicationMessage

Represents a communication message.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **string** | The contents of the message. | [optional] [default to undefined]
**clientKey** | **string** | The client the message was sent to. | [optional] [default to undefined]
**creationDate** | **string** | The date the communication message was created in UTC. | [optional] [default to undefined]
**depositAccountKey** | **string** | The deposit account that triggered this message. | [optional] [default to undefined]
**destination** | **string** | The destination (phone number or email address) this message was sent to. | [optional] [default to undefined]
**encodedKey** | **string** | The encoded key of the communication message, which is generated automatically, and must be unique. | [optional] [default to undefined]
**event** | **string** | The event that triggered this message. | [optional] [default to undefined]
**failureCause** | **string** | The failure code if the message failed to send. | [optional] [default to undefined]
**failureReason** | **string** | The reason for the communication message failure. | [optional] [default to undefined]
**groupKey** | **string** | The group the message was sent to. | [optional] [default to undefined]
**loanAccountKey** | **string** | The loan account that triggered this message. | [optional] [default to undefined]
**numRetries** | **number** | The number of retries to send the message. | [optional] [default to undefined]
**referenceId** | **string** | The reference ID of the communication message, generated by the SMS dispatcher. | [optional] [default to undefined]
**repaymentKey** | **string** | The repayment that triggered this message. | [optional] [default to undefined]
**sendDate** | **string** | The date the communication message was sent in UTC. | [optional] [default to undefined]
**senderKey** | **string** | The encoded key of the sender. If specified, it should be the encoded key of the current user. | [optional] [default to undefined]
**state** | **string** | The state of the message. | [optional] [default to undefined]
**subject** | **string** | The subject of the message. | [optional] [default to undefined]
**templateKey** | **string** | The communication message template key. | [optional] [default to undefined]
**type** | **string** | The type of communication message. | [optional] [default to undefined]
**userKey** | **string** | The user the message was sent to. | [optional] [default to undefined]

## Example

```typescript
import { CommunicationMessage } from './api';

const instance: CommunicationMessage = {
    body,
    clientKey,
    creationDate,
    depositAccountKey,
    destination,
    encodedKey,
    event,
    failureCause,
    failureReason,
    groupKey,
    loanAccountKey,
    numRetries,
    referenceId,
    repaymentKey,
    sendDate,
    senderKey,
    state,
    subject,
    templateKey,
    type,
    userKey,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)