Amazon Connect · Schema
StartChatContactRequest
ChatContact CenterCustomer ServiceVoiceAIOmnichannel
Properties
| Name | Type | Description |
|---|---|---|
| InstanceId | string | The identifier of the Amazon Connect instance. |
| ContactFlowId | string | The identifier of the contact flow for initiating the chat. |
| Attributes | object | A custom key-value pair using an attribute map. |
| ParticipantDetails | object | |
| InitialMessage | object | |
| ClientToken | string | Idempotency token. |
| ChatDurationInMinutes | integer | The total duration of the newly started chat session. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/StartChatContactRequest",
"title": "StartChatContactRequest",
"type": "object",
"required": [
"ContactFlowId",
"InstanceId",
"ParticipantDetails"
],
"properties": {
"InstanceId": {
"type": "string",
"description": "The identifier of the Amazon Connect instance.",
"example": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
},
"ContactFlowId": {
"type": "string",
"description": "The identifier of the contact flow for initiating the chat.",
"example": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
},
"Attributes": {
"type": "object",
"description": "A custom key-value pair using an attribute map.",
"additionalProperties": {
"type": "string"
}
},
"ParticipantDetails": {
"type": "object",
"required": [
"DisplayName"
],
"properties": {
"DisplayName": {
"type": "string",
"description": "Display name of the participant.",
"example": "Jane Smith"
}
}
},
"InitialMessage": {
"type": "object",
"properties": {
"ContentType": {
"type": "string",
"example": "text/plain"
},
"Content": {
"type": "string",
"example": "Hello, I need help with my order."
}
}
},
"ClientToken": {
"type": "string",
"description": "Idempotency token."
},
"ChatDurationInMinutes": {
"type": "integer",
"description": "The total duration of the newly started chat session.",
"example": 60
}
}
}