Create Push Notification Registration

connect_create_push_notification_registration

R Documentation

Creates registration for a device token and a chat contact to receive real-time push notifications¶

Description¶

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.

Usage¶

connect_create_push_notification_registration(InstanceId, ClientToken,
  PinpointAppArn, DeviceToken, DeviceType, ContactConfiguration)

Arguments¶

InstanceId: [required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
PinpointAppArn: [required] The Amazon Resource Name (ARN) of the Pinpoint application.
DeviceToken: [required] The push notification token issued by the Apple or Google gateways.
DeviceType: [required] The device type to use when sending the message.
ContactConfiguration: [required] The contact configuration for push notification registration.

Value¶

A list with the following syntax:

list(
  RegistrationId = "string"
)

Request syntax¶

svc$create_push_notification_registration(
  InstanceId = "string",
  ClientToken = "string",
  PinpointAppArn = "string",
  DeviceToken = "string",
  DeviceType = "GCM"|"APNS"|"APNS_SANDBOX",
  ContactConfiguration = list(
    ContactId = "string",
    ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
    IncludeRawMessage = TRUE|FALSE
  )
)