Engagement Interaction Create Input
- Root XML tag
- <engagementInteraction>
- JSON example
-
{ "engagementInteraction": { "initiatingAttendeeId": "testattendeeid", "attendeeAuthenticated": true, "attendeeVerified": true, "startDateTime": "2022-04-17T12:00:00.000Z", "endDateTime": "2022-04-17T12:04:00.000Z", "communicationChannel": "Voice Call", "sentiment": "Test", "contextId": "TestContextId", "externalIdentifierId": "external_identifier_id", "type": "Inbound", "mappedState": "New", "status": "New", "attendeeVerificationTime": "2022-04-17T12:02:00.000Z", "reason": "Unknown Charges", "phoneNumber": "9999999999", "customFieldsList": [ { "key": "sampleLocation__c", "value": { "latitude": 12, "longitude": 17 } }, { "key": "sampleCheckbox__c", "value": "true" }, { "key": "sampleDate__c", "value": "06/17/2022" }, { "key": "sampleDateTime__c", "value": "2022-04-17T12:00:00.000Z" }, { "key": "sampleEmail__c", "value": "sample@email.com" }, { "key": "samplePercentage__c", "value": 17 }, { "key": "samplePicklist__c", "value": "pick1" } ] } }
- Properties
-
Name Type Description Required or Optional Available Version attendeeAuthenticated Boolean Indicates whether the initiating attendee of an engagement interaction was authenticated through interactive voice response (IVR) or Web channel (true) or not (false). The default value is false.
Optional 55.0 attendeeVerificationTime String The time when the attendee was verified for an engagement interaction. You can manually set this time. If isAttendeeVerified is set to true, then if you don’t manually set this time, it is set based on the current system date and time. Optional 55.0 attendeeVerified Boolean Indicates whether the initiating attendee of an engagement interaction was verified (true) or not (false). Required 55.0 communicationChannel String The communication channel through which an engagement interaction occurred. Possible values are: - In-Person
- Video Call
- Voice Call
- Web Chat
Required 55.0 contextId String The ID of the record that’s considered as the context for an engagement interaction. For example, when a customer initiates an engagement interaction by booking a service appointment for an inquiry, the service appointment is the context for that engagement interaction. Optional 55.0 customFieldsList Engagement Custom Fields Input[] The custom fields and their values for engagement interactions. Optional 56.0 endDateTime String The date and time when an engagement interaction ended. Optional 55.0 engagementAttendees Engagement Attendee Create Input[] Create engagement attendee records. Optional 55.0 engagementTopics Engagement Topic Create Input[] Create engagement topic records. Optional 55.0 externalIdentifierId String The unique external identifier of an engagement interaction. Optional 55.0 id String The ID of an engagement interaction. Required 55.0 initiatingAttendeeId String The attendee who has initiated the engagement interaction. Optional 55.0 mappedState String The state of an engagement interaction that changes when the status of the interaction gets updated. Possible values are: - Completed
- In Progress
- New
Optional 55.0 phoneNumber Phone The phone number of the caller which is used to determine the context during a subsequent call. Optional 57.0 reason String The reason for an engagement as stated by a customer during the engagement interaction. Optional 55.0 sentiment String The sentiment of an engagement interaction attendee about the engagement interaction. Possible values are: - Negative
- Neutral
- Positive
Optional 55.0 startDateTime String The date and time when an engagement interaction started. Required 55.0 status String The current status of an engagement interaction, which also impacts the interaction state. Optional 55.0 type String The type of interaction that was initiated by the attendee. Possible values are: - Inbound Interaction
- Outbound Interaction
You can set custom values.
Optional 55.0