| AllowExistingSessionStatus |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- Indicates whether the message can be sent only at certain
times.
- Possible values are:
-
Any—Send the message
regardless of whether the messaging user is engaged in an
active messaging session with the business.
-
Closed—Send the message
unless the messaging user is engaged in a messaging session
with a status other than Error or Ended, in which case it’s
never sent.
-
NonActive—Send
the message unless the messaging user is engaged in a
messaging session with a status of Active, in which case it’s
never sent.
|
| CommSubscriptionId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the related communication subscription, if applicable.
This field is a relationship field that refers to
CommSubscription.
|
| CompletedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- Date and time when the request completes and all messages
associated with the request are sent or failed to be sent.
|
| FailedMessageCount |
- Type
- int
- Properties
- Defaulted on create, Filter, Group, Nillable, Sort
- Description
- The number of messages that failed to be delivered to a messaging
user. For example, if a flow sends the message to 50 messaging
users and 4 don’t receive the message, this value is 4.
|
| FailedMessageErrorReasons |
- Type
- textarea
- Properties
- Nillable
- Description
- The error reason for each of the failed messages. For example, if
4 messages fail to send, this field shows the error reason for each
failed message.
|
| FailedMessageIdentifiers |
- Type
- textarea
- Properties
- Nillable
- Description
- The IDs of the messages that failed to send. For example, if 4
messages fail to send, this field shows 4 message IDs.
|
| FailedMeuPlatformKeys |
- Type
- textarea
- Properties
- Filter, Group, Nillable, Sort
- Description
- A list of platform keys for messaging end users with messages that
failed to send. Available in API version 65.0 and later.
|
| InProgressMessageCount |
- Type
- int
- Properties
- Defaulted on Create, Filter, Group, Sort
- Description
- The number of messages in the process of being sent.
|
| InProgressMessageIdentifiers |
- Type
- textarea
- Properties
- Filter, Group, Nillable, Sort
- Description
- A list of IDs of the messages being sent.
|
| InProgressMessagingEndUserIds |
- Type
- textarea
- Properties
- Filter, Group, Nillable, Sort
- Description
- A list of IDs of messaging end users with messages that are being
sent. Available in API version 65.0 and later.
|
| InProgressMessagingSessionIds |
- Type
- textarea
- Properties
- Filter, Group, Nillable, Sort
- Description
- A list of IDs of messaging sessions with messages that are being
sent. Available in API version 65.0 and later.
|
| InProgressMeuPlatformKeys |
- Type
- textarea
- Properties
- Filter, Group, Nillable, Sort
- Description
- A list of platform keys for messaging end users with messages that
are being sent. Available in API version 65.0 and later.
|
| MessageDefinition |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- The name of the messaging component being sent. Only active
messaging components can be sent.
|
| MessageDefinitionParameters |
- Type
- textarea
- Properties
- Nillable
- Description
- A list of parameters used to dynamically construct the message
that is being sent. Available in API version 65.0 and later.
|
| Name |
- Type
- string
- Properties
- Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description
- An auto-generated ID for the request that uses the format
MSJ-{00000000}.
|
| PendingMessageCount |
- Type
- int
- Properties
- Filter, Group, Sort
- Description
- The number of messages that haven’t yet been sent.
|
| PendingMessageEndUserIds |
- Type
- textarea
- Properties
- Nillable
- Description
- A list of IDs of the messaging end users with pending messages.
Available in API version 65.0 and later.
|
| PendingMeuPlatformKeys |
- Type
- textarea
- Properties
- Nillable
- Description
- A list of platform keys of the messaging end users with pending
messages. Available in API version 65.0 and later.
|
| PendingMessageIdentifiers |
- Type
- textarea
- Properties
- Nillable
- Description
- A list of IDs of the pending messages.
|
| RequestConsentType |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Indicates whether the flow applies the consent settings of the
messaging end user or the communication subscription.
- Possible values are:
- CommunicationSubscription
- MessagingEndUser
|
| RequestStatus |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- The status of the request.
- Possible values are:
- Completed
- Pending
-
In Progress—The system
is actively trying to send the message. If a message can’t be
sent, the RequestStatus returns to Pending and sending is
tried again later.
|
| RequestType |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- The type of request.
- Possible values are:
|
| SessionLongevityPreference |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Indicates whether to end the session after the message is sent.
- Possible values are:
-
KeepSessionOpen—After
the flow sends the message, keep the messaging session in a
New state. If the end user doesn’t respond within 48 hours,
the session ends. Use this option if you expect customers to
respond to automated messages and want service reps to see
their response in context.
-
EndSession—After the
flow sends the message, end the messaging session. If the
customer responds, a new messaging session is created and
routed to your support team.
-
KeepSessionOpenOrAppend—If there’s an existing
session with the messaging end user in the New state, use
that session to send the message. Otherwise, follow the
behavior documented for the KeepSessionOpen option. Available in API version
65.0 and later.
|
| ShouldEnforceChannelConsent |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the existing Messaging channel consent
preferences are applied when determining who receives the message.
Setting this value to true is
the most common approach. The default value, false, allows you to add custom
consent logic—for example, to customize a flow to send the message
to both implicitly opted-in users and explicitly opted-in
users.
|
| SuccessMessageCount |
- Type
- int
- Properties
- Defaulted on create, Filter, Group, Nillable, Sort
- Description
- The number of messages that were successfully sent to messaging
users. Delivery can occur much later than sending, depending on
factors such as the connectivity status of the recipient. Delivery
is reflected in the messaging session transcript.
|
| SuccessMessageIdentifiers |
- Type
- textarea
- Properties
- Nillable
- Description
- A list of IDs of the messages that were sent.
|
| SuccessMeuPlatformKeys |
- Type
- textarea
- Properties
- Filter, Group, Nillable, Sort
- Description
- A list of platform keys for messaging end users with messages that
were sent. Available in API version 65.0 and later.
|
| TotalMessageCount |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- The number of messages that the related flow attempted to
send.
- This field is a calculated field.
|
j