Corti AssistantEvent Properties
| Field | Value |
|---|---|
event | "embedded.interactionOptionsSet" |
confidential | boolean |
payload | object |
- Public Payload
- Confidential Payload
| Field | Type | Description |
|---|---|---|
mode | { fallback?: "virtual" | "in-person" | null | undefined; options?: ("virtual" | "in-person")[] | null | undefined; } | null | undefined | Allowed interaction modes and fallback selection |
spokenLanguage | { fallback?: string | null | undefined; options?: string[] | null | undefined; } | null | undefined | Spoken language fallback to apply |
templates | { sources?: { personal?: { enabled?: boolean | null | undefined; } | undefined; standard?: { enabled?: boolean | null | undefined; include?: { regions?: string[] | null | undefined; families?: string[] | ... 1 more ... | undefined; } | undefined; } | undefined; project?: { ...; } | undefined; } | undefined; defaultT... | Template options applied by the embedded API |
documents | { actions?: { sync?: boolean | null | undefined; } | undefined; allowedLanguages?: string[] | null | undefined; maxGenerated?: number | "unlimited" | null | undefined; } | undefined | Document action options applied by the embedded API |
mode object properties
mode object properties
| Field | Type | Description |
|---|---|---|
fallback | string | - |
options | array | - |
spokenLanguage object properties
spokenLanguage object properties
| Field | Type | Description |
|---|---|---|
fallback | string | - |
options | array | - |
templates object properties
templates object properties
| Field | Type | Description |
|---|---|---|
sources | object | - |
defaultTemplate | object | - |
documents object properties
documents object properties
| Field | Type | Description |
|---|---|---|
actions | object | - |
allowedLanguages | array | - |
maxGenerated | number | - |
Example
{
"event": "embedded.interactionOptionsSet",
"confidential": false,
"payload": {
"mode": {
"fallback": "virtual",
"options": [
"virtual",
"in-person"
]
},
"spokenLanguage": {
"fallback": "en",
"options": [
"en",
"de"
]
},
"templates": {
"sources": {
"personal": {
"enabled": true
},
"standard": {
"enabled": true,
"include": {
"regions": [
"BE"
],
"families": [
"soap"
]
}
},
"project": {
"enabled": true,
"include": {
"ids": [
"7a0ab5b8-1f62-4f75-86a7-4fcd8fd07b5d"
]
},
"exclude": {
"ids": [
"d7a7fd8c-8892-4475-81d3-3414b7d8e27d"
]
}
}
},
"defaultTemplate": {
"behaviour": "fallback",
"template": {
"source": "standard",
"id": "soap"
},
"allowUserSelection": false
}
},
"documents": {
"actions": {
"sync": true
},
"allowedLanguages": [
"nl",
"fr",
"de-CHE"
],
"maxGenerated": 2
}
}
}
| Field | Type | Description |
|---|---|---|
mode | { fallback?: "virtual" | "in-person" | null | undefined; options?: ("virtual" | "in-person")[] | null | undefined; } | null | undefined | Allowed interaction modes and fallback selection |
spokenLanguage | { fallback?: string | null | undefined; options?: string[] | null | undefined; } | null | undefined | Spoken language fallback to apply |
templates | { sources?: { personal?: { enabled?: boolean | null | undefined; } | undefined; standard?: { enabled?: boolean | null | undefined; include?: { regions?: string[] | null | undefined; families?: string[] | ... 1 more ... | undefined; } | undefined; } | undefined; project?: { ...; } | undefined; } | undefined; defaultT... | Template options applied by the embedded API |
documents | { actions?: { sync?: boolean | null | undefined; } | undefined; allowedLanguages?: string[] | null | undefined; maxGenerated?: number | "unlimited" | null | undefined; } | undefined | Document action options applied by the embedded API |
mode object properties
mode object properties
| Field | Type | Description |
|---|---|---|
fallback | string | - |
options | array | - |
spokenLanguage object properties
spokenLanguage object properties
| Field | Type | Description |
|---|---|---|
fallback | string | - |
options | array | - |
templates object properties
templates object properties
| Field | Type | Description |
|---|---|---|
sources | object | - |
defaultTemplate | object | - |
documents object properties
documents object properties
| Field | Type | Description |
|---|---|---|
actions | object | - |
allowedLanguages | array | - |
maxGenerated | number | - |
Example
{
"event": "embedded.interactionOptionsSet",
"confidential": true,
"payload": {
"mode": {
"fallback": "virtual",
"options": [
"virtual",
"in-person"
]
},
"spokenLanguage": {
"fallback": "en",
"options": [
"en",
"de"
]
},
"templates": {
"sources": {
"personal": {
"enabled": true
},
"standard": {
"enabled": true,
"include": {
"regions": [
"BE"
],
"families": [
"soap"
]
}
},
"project": {
"enabled": true,
"include": {
"ids": [
"7a0ab5b8-1f62-4f75-86a7-4fcd8fd07b5d"
]
},
"exclude": {
"ids": [
"d7a7fd8c-8892-4475-81d3-3414b7d8e27d"
]
}
}
},
"defaultTemplate": {
"behaviour": "fallback",
"template": {
"source": "standard",
"id": "soap"
},
"allowUserSelection": false
}
},
"documents": {
"actions": {
"sync": true
},
"allowedLanguages": [
"nl",
"fr",
"de-CHE"
],
"maxGenerated": 2
}
}
}