Communicationmessage
Represents a communication message.
The contents of the message.
The client the message was sent to.
The date the communication message was created in UTC.
2016-09-06T13:37:50+03:00The deposit account that triggered this message.
The destination (phone number or email address) this message was sent to.
The encoded key of the communication message, which is generated automatically, and must be unique.
The event that triggered this message.
Possible values: [MANUAL, DO_NOTHING, CLIENT_CREATED, CLIENT_APPROVED, GROUP_ACTIVITY, GROUP_CREATED, LOAN_CREATED, INTEREST_RATE_CHANGED, CLIENT_REJECTED, CLIENT_ACTIVITY, LOAN_REPAYMENT, LOAN_REPAYMENT_REVERSAL, FEE_APPLIED, FEE_ADJUSTED, FEE_CHARGED, PENALTY_APPLIED, PENALTY_ADJUSTMENT, FEES_DUE_REDUCED, FEE_REDUCTION_ADJUSTMENT, LOAN_APPROVAL, LOAN_ACCOUNT_CLOSURE, LOAN_ACCOUNT_WRITE_OFF, LOAN_ACCOUNT_REJECTION, LOAN_ACCOUNT_RESCHEDULED, LOAN_ACCOUNT_REFINANCED, REPAYMENT_REMINDER, ACCOUNT_IN_ARREARS, LOAN_DISBURSEMENT, LOAN_DISBURSEMENT_REVERSAL, LOAN_ACCOUNT_ACTIVITY, LOAN_ANTICIPATED_DISBURSEMENT, SAVINGS_CREATED, SAVINGS_DEPOSIT, SAVINGS_DEPOSIT_REVERSAL, REAPPLIED_SAVINGS_DEPOSIT, SAVINGS_APPROVAL, SAVINGS_ACCOUNT_ACTIVATED, SAVINGS_ACCOUNT_CLOSURE, SAVINGS_ACCOUNT_REJECTION, SAVINGS_WITHDRAWAL, SAVINGS_WITHDRAWAL_REVERSAL, REAPPLIED_SAVINGS_WITHDRAWAL, SAVINGS_ACCOUNT_ACTIVITY, DEPOSIT_INTEREST_APPLIED, DEPOSIT_INTEREST_APPLIED_ADJUSTMENT, ACCOUNT_AUTHORISATION_HOLD_CREATED, ACCOUNT_AUTHORISATION_HOLD_REVERSED, ACCOUNT_AUTHORISATION_HOLD_SETTLED, CARDS_AUTHORISATION_HOLD_CREATED, CARDS_AUTHORISATION_HOLD_IN_BULK_CREATED, CARDS_AUTHORISATION_HOLD_SETTLED, CARDS_AUTHORISATION_HOLD_AMOUNT_DECREASED, CARDS_AUTHORISATION_HOLD_AMOUNT_INCREASED, CARDS_AUTHORISATION_HOLD_EXPIRED, CARDS_AUTHORISATION_HOLD_REVERSED, PORTAL_ACTIVATED, PORTAL_PASSWORD_RESET, END_OF_DAY_PROCESSING_COMPLETED, DATA_ACCESS_STATE_CHANGED, CREDIT_ARRANGEMENT_CREATED, CREDIT_ARRANGEMENT_CLOSED, CREDIT_ARRANGEMENT_APPROVED, CREDIT_ARRANGEMENT_REJECTED, CREDIT_ARRANGEMENT_WITHDRAWN, CREDIT_ARRANGEMENT_DELETED, CREDIT_ARRANGEMENT_ACCOUNT_ADDED, CREDIT_ARRANGEMENT_ACCOUNT_REMOVED, CREDIT_ARRANGEMENT_EDITED, PAYMENT_ORDER_ACTIVITY, COLLECTION_ORDER_ACTIVITY, JOURNAL_ENTRY_ADDED, JOURNAL_ENTRY_ADJUSTED, SAVINGS_TRANSACTION_EDITED, CARD_WITHDRAWAL_REVERSAL, CARD_DEPOSIT_REVERSAL]
The failure code if the message failed to send.
The reason for the communication message failure.
Possible values: [MESSAGING_EXCEPTION, INVALID_SMTP_CREDENTIALS, UNSUPPORTED_ENCODING_EXCEPTION, EMAIL_SERVICE_NOT_ENABLED, SMS_TOO_LONG, SMS_SERVICE_NOT_ENABLED, SMS_NOT_SENT, SMS_SERVICE_ERROR, SMS_CONNECTION_EXCEPTION, WEBHOOK_NOTIFICATIONS_DISABLED, INVALID_HTTP_RESPONSE, HTTP_ERROR_WHILE_SENDING, INVALID_JSON_BODY_SYNTAX, MISSING_TEMPLATE_KEY, MAX_MESSAGE_SIZE_LIMIT_EXCEEDED, UNDEFINED_DESTINATION, INVALID_HTTP_PROTOCOL, BLACKLISTED_URL, INVALID_SMS_GATEWAY_CREDENTIALS, MISSING_SMS_RECIPIENT, SMS_GATEWAY_ERROR, MISSING_EMAIL_RECIPIENT_ADDRESS, OTHER]
The group the message was sent to.
The loan account that triggered this message.
The number of retries to send the message.
The reference ID of the communication message, generated by the SMS dispatcher.
The repayment that triggered this message.
The date the communication message was sent in UTC.
2016-09-06T13:37:50+03:00The encoded key of the sender. If specified, it should be the encoded key of the current user.
The state of the message.
Possible values: [SENT, QUEUED, QUEUED_FOR_STREAM, WAITING, SENDING_ASYNC, FAILED]
The subject of the message.
The communication message template key.
The type of communication message.
Possible values: [EMAIL, SMS, WEB_HOOK, EVENT_STREAM, TASK]
The user the message was sent to.
{
"body": "string",
"clientKey": "string",
"creationDate": "2016-09-06T13:37:50+03:00",
"depositAccountKey": "string",
"destination": "string",
"encodedKey": "string",
"event": "MANUAL",
"failureCause": "string",
"failureReason": "MESSAGING_EXCEPTION",
"groupKey": "string",
"loanAccountKey": "string",
"numRetries": 0,
"referenceId": "string",
"repaymentKey": "string",
"sendDate": "2016-09-06T13:37:50+03:00",
"senderKey": "string",
"state": "SENT",
"subject": "string",
"templateKey": "string",
"type": "EMAIL",
"userKey": "string"
}