Engagement Interaction Create Input

Input representation to create an engagement interaction record.

Root XML tag

<engagementInteraction>

JSON Example

1{
2  "engagementInteraction": {
3    "initiatingAttendeeId": "testattendeeid",
4    "attendeeAuthenticated": true,
5    "attendeeVerified": true,
6    "startDateTime": "2022-04-17T12:00:00.000Z",
7    "endDateTime": "2022-04-17T12:04:00.000Z",
8    "communicationChannel": "Voice Call",
9    "sentiment": "Test",
10    "contextId": "TestContextId",
11    "externalIdentifierId": "external_identifier_id",
12    "type": "Inbound",
13    "mappedState": "New",
14    "status": "New",
15    "attendeeVerificationTime": "2022-04-17T12:02:00.000Z",
16    "reason": "Unknown Charges",
17    "phoneNumber": "9999999999",
18    "customFieldsList": [
19      {
20        "key": "sampleLocation__c",
21        "value": {
22          "latitude": 12,
23          "longitude": 17
24        }
25      },
26      {
27        "key": "sampleCheckbox__c",
28        "value": "true"
29      },
30      {
31        "key": "sampleDate__c",
32        "value": "06/17/2022"
33      },
34      {
35        "key": "sampleDateTime__c",
36        "value": "2022-04-17T12:00:00.000Z"
37      },
38      {
39        "key": "sampleEmail__c",
40        "value": "sample@email.com"
41      },
42      {
43        "key": "samplePercentage__c",
44        "value": 17
45      },
46      {
47        "key": "samplePicklist__c",
48        "value": "pick1"
49      }
50    ]
51  }
52}

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` You can set custom values.	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` The default value is `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` You can set custom values.	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