PerformOptions

The PerformOptions object contains the default options of the Perform call.

NameData TypeDescription
CallsInConversationIntegerIndicates the number of calls that are part of a conversation. Processing of the conversation begins when the specified number of calls has been received. This is an optional property. When you specify this property, you must also specify the ConversationID property.
ClientClientIDSpecifies the account ownership and context of an object.
ConversationIDStringA unique ID for grouping multiple calls into a single conversation. All calls with the same ConversationID are processed as a single unit. This is an optional property.
ExplanationStringSpecifies a reason for pausing a running send.
PriorityStringThis property is deprecated. API calls can specify this property, but we recommend that you use the QueuePriority property in new API calls.
QueuePriorityPriorityDefines the priority for asynchronous sends. Accepted values are High, Medium, and Low. The default value is Medium.
RequestTypeRequestTypeThe type of request. Possible values are synchronous and asynchronous.
SaveOptionsArray of SaveOption objectsSpecifies how information is overwritten.
ScheduledTimeStringThe date and time at which the request must be processed. Specify the value in ISO 8601 format with UTC time or a timezone offset. The specified time can be up to 30 days in the future.
SendResponseToArray of AsyncResponse objectsDefines how responses are returned and under what conditions. Optional.
SequenceCodeIntegerSpecifies the processing sequence of a multi-step conversation. This optional property requires the use of ConversationID.