id |
string |
The unique participant ID. |
[optional] |
name |
string |
The display friendly name of the participant. |
[optional] |
address |
string |
The participant address. |
[optional] |
startTime |
\DateTime |
The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |
[optional] |
connectedTime |
\DateTime |
The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |
[optional] |
endTime |
\DateTime |
The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |
[optional] |
startHoldTime |
\DateTime |
The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |
[optional] |
purpose |
string |
The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr |
[optional] |
state |
string |
The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting |
[optional] |
direction |
string |
The participant's direction. Values can be: 'inbound' or 'outbound' |
[optional] |
disconnectType |
string |
The reason the participant was disconnected from the conversation. |
[optional] |
held |
bool |
Value is true when the participant is on hold. |
[optional] |
wrapupRequired |
bool |
Value is true when the participant requires wrap-up. |
[optional] |
wrapupPrompt |
string |
The wrap-up prompt indicating the type of wrap-up to be performed. |
[optional] |
user |
\PureCloudPlatform\Client\V2\Model\DomainEntityRef |
The PureCloud user for this participant. |
[optional] |
queue |
\PureCloudPlatform\Client\V2\Model\DomainEntityRef |
The PureCloud queue for this participant. |
[optional] |
attributes |
map[string,string] |
A list of ad-hoc attributes for the participant. |
[optional] |
errorInfo |
\PureCloudPlatform\Client\V2\Model\ErrorBody |
If the conversation ends in error, contains additional error details. |
[optional] |
script |
\PureCloudPlatform\Client\V2\Model\DomainEntityRef |
The Engage script that should be used by this participant. |
[optional] |
wrapupTimeoutMs |
int |
The amount of time the participant has to complete wrap-up. |
[optional] |
wrapupSkipped |
bool |
Value is true when the participant has skipped wrap-up. |
[optional] |
alertingTimeoutMs |
int |
Specifies how long the agent has to answer an interaction before being marked as not responding. |
[optional] |
provider |
string |
The source provider for the communication. |
[optional] |
externalContact |
\PureCloudPlatform\Client\V2\Model\DomainEntityRef |
If this participant represents an external contact, then this will be the reference for the external contact. |
[optional] |
externalOrganization |
\PureCloudPlatform\Client\V2\Model\DomainEntityRef |
If this participant represents an external org, then this will be the reference for the external org. |
[optional] |
wrapup |
\PureCloudPlatform\Client\V2\Model\Wrapup |
Wrapup for this participant, if it has been applied. |
[optional] |
peer |
string |
The peer communication corresponding to a matching leg for this communication. |
[optional] |
flaggedReason |
string |
The reason specifying why participant flagged the conversation. |
[optional] |
journeyContext |
\PureCloudPlatform\Client\V2\Model\JourneyContext |
Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. |
[optional] |
conversationRoutingData |
\PureCloudPlatform\Client\V2\Model\ConversationRoutingData |
Information on how a communication should be routed to an agent. |
[optional] |
startAcwTime |
\DateTime |
The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |
[optional] |
endAcwTime |
\DateTime |
The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ |
[optional] |
toAddress |
\PureCloudPlatform\Client\V2\Model\Address |
Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended. |
[optional] |
fromAddress |
\PureCloudPlatform\Client\V2\Model\Address |
Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended. |
[optional] |
messages |
\PureCloudPlatform\Client\V2\Model\MessageDetails[] |
Message instance details on the communication. |
[optional] |
type |
string |
Indicates the type of message platform from which the message originated. |
[optional] |
recipientCountry |
string |
Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. |
[optional] |
recipientType |
string |
The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type. |
[optional] |