PerformOptions
The PerformOptions object contains the default options of the Perform call.
| Name | Data Type | Description |
|---|---|---|
CallsInConversation | Integer | Indicates 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. |
Client | ClientID | Specifies the account ownership and context of an object. |
ConversationID | String | A 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. |
Explanation | String | Specifies a reason for pausing a running send. |
Priority | String | This property is deprecated. API calls can specify this property, but we recommend that you use the QueuePriority property in new API calls. |
QueuePriority | Priority | Defines the priority for asynchronous sends. Accepted values are High, Medium, and Low. The default value is Medium. |
RequestType | RequestType | The type of request. Possible values are synchronous and asynchronous. |
SaveOptions | Array of SaveOption objects | Specifies how information is overwritten. |
ScheduledTime | String | The 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. |
SendResponseTo | Array of AsyncResponse objects | Defines how responses are returned and under what conditions. Optional. |
SequenceCode | Integer | Specifies the processing sequence of a multi-step conversation. This optional property requires the use of ConversationID. |