Amazon Connect Service

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.

See also: AWS API Documentation

Request Syntax

client.create_push_notification_registration(
    InstanceId='string',
    ClientToken='string',
    PinpointAppArn='string',
    DeviceToken='string',
    DeviceType='GCM'|'APNS'|'APNS_SANDBOX',
    ContactConfiguration={
        'ContactId': 'string',
        'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR',
        'IncludeRawMessage': True|False
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

type PinpointAppArn:

string

param PinpointAppArn:

[REQUIRED]

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

type DeviceToken:

string

param DeviceToken:

[REQUIRED]

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

type DeviceType:

string

param DeviceType:

[REQUIRED]

The device type to use when sending the message.

type ContactConfiguration:

dict

param ContactConfiguration:

[REQUIRED]

The contact configuration for push notification registration.

• ContactId (string) -- [REQUIRED]

  The identifier of the contact within the Amazon Connect instance.

• ParticipantRole (string) --

  The role of the participant in the chat conversation.

• IncludeRawMessage (boolean) --

  Whether to include raw connect message in the push notification payload. Default is False.

rtype:

dict

returns:

Response Syntax

{
    'RegistrationId': 'string'
}

Response Structure

• (dict) --

  • RegistrationId (string) --

    The identifier for the registration.

Deletes registration for a device token and a chat contact.

See also: AWS API Documentation

Request Syntax

client.delete_push_notification_registration(
    InstanceId='string',
    RegistrationId='string',
    ContactId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type RegistrationId:

string

param RegistrationId:

[REQUIRED]

The identifier for the registration.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact within the Amazon Connect instance.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --