Name | Type | Description | Notes |
---|---|---|---|
uid | string | Unique ID for a message sent or received | [optional] |
account_uid | string | Unique ID of Account which created this message | [optional] |
total_cost | BigDecimal | Total cost deducted from your credits for this message - `total_cost` will reflect refunds for this message. If there was a complete refund, the `total_cost` will be zero. | [optional] |
refund | BigDecimal | If a refund was processed for this message `refund` will be a non-null number | [optional] |
source | string | Sender ID for the message | [optional] |
destination | string | Destination number for the message in E.164 format | [optional] |
country | string | ISO2 code of the country where the destination belongs to | [optional] |
content_type | string | Content type of the message. - Its value will correspond to the key present in the `content`. | [optional] |
content | \Karix\Model\MessageContent | [optional] | |
created_time | \DateTime | Timestamp when the message was created | [optional] |
sent_time | \DateTime | Timestamp when message was sent to the selected channel | [optional] |
delivered_time | \DateTime | Timestamp when the message was delivered to the destination | [optional] |
updated_time | \DateTime | Timestamp when the message status was last updated - If the current status is `read`, then this timestamp also represents read time - If the current status is `undelivered` then this timestamp also represents undelivered time | [optional] |
status | string | Current status of the message. Possible values: - `queued`: Message has been queued in Karix system (for either `inbound` or `outbound` direction) - `sent`: The `outbound` message has been sent to carriers for delivery - `failed`: In case of `outbound` message, this means that Karix failed to send the message to a carrier. In case of `inbound` message, this means that Karix failed to send the message to its webhook, if configured. - `delivered`: The `outbound` message was delivered to its receiver. - `read`: The outbound message was delivered and read by the the receiver. Not supported by `sms` channel. - `undelivered`: The `outbound` message falied to be delivered to its receiver. - `rejected`: The `outbound` message was rejected by the chosen carrier. | [optional] |
direction | string | Direction of the message. - inbound: Message was sent to a number owned by the karix account - outbound: Message was sent to a destination using karix account | [optional] |
error | \Karix\Model\MessageError | [optional] | |
redact | bool | If the message was redacted using redact message API, then `redact` will be `true`. | [optional] |
channel_details | \Karix\Model\MessageChannelDetails | [optional] |