Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
Request Syntax
POST /contact/start-streaming HTTP/1.1
Content-type: application/json
{
"ChatStreamingConfiguration": {
"StreamingEndpointArn": "string"
},
"ClientToken": "string",
"ContactId": "string",
"InstanceId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ChatStreamingConfiguration
-
The streaming configuration, such as the Amazon SNS streaming endpoint.
Type: ChatStreamingConfiguration object
Required: Yes
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs
. Type: String
Length Constraints: Maximum length of 500.
Required: Yes
- ContactId
-
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"StreamingId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- StreamingId
-
The identifier of the streaming configuration enabled.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- LimitExceededException
-
The allowed limit for the resource has been exceeded.
HTTP Status Code: 429
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
