Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreatePushNotificationRegistration

Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.

Request Syntax


PUT /push-notification/InstanceId/registrations HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactConfiguration": { 
      "ContactId": "string",
      "IncludeRawMessage": boolean,
      "ParticipantRole": "string"
   },
   "DeviceToken": "string",
   "DeviceType": "string",
   "PinpointAppArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

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: No

ContactConfiguration

The contact configuration for push notification registration.

Type: ContactConfiguration object

Required: Yes

DeviceToken

The push notification token issued by the Apple or Google gateways.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

DeviceType

The device type to use when sending the message.

Type: String

Valid Values: GCM | APNS | APNS_SANDBOX

Required: Yes

PinpointAppArn

The Amazon Resource Name (ARN) of the Pinpoint application.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RegistrationId": "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.

RegistrationId

The identifier for the registration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429