GCM Channel - Amazon Pinpoint

GCM Channel

A channel is a type of platform that you can deliver messages to. You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM) service, which replaces the Google Cloud Messaging (GCM) service. Before you can use Amazon Pinpoint to send notification messages to FCM, you must enable the GCM channel for an Amazon Pinpoint application.

The GCM Channel resource represents the status and authentication settings of the GCM channel for a specific application. You can use this resource to enable, retrieve information about, update, or disable (delete) the GCM channel for an application.

URI

/v1/apps/application-id/channels/gcm

HTTP methods

GET

Operation ID: GetGcmChannel

Retrieves information about the status and settings of the GCM channel for an application.

Path parameters
NameTypeRequiredDescription
application-idStringTrue

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
NameTypeRequiredDescription
acceptStringFalse

Indicates which content types, expressed as MIME types, the client understands.

Responses
Status codeResponse modelDescription
200GCMChannelResponse

The request succeeded.

400MessageBody

The request contains a syntax error (BadRequestException).

403MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404MessageBody

The request failed because the specified resource was not found (NotFoundException).

405MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

413MessageBody

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

429MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

PUT

Operation ID: UpdateGcmChannel

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

Path parameters
NameTypeRequiredDescription
application-idStringTrue

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
NameTypeRequiredDescription
acceptStringFalse

Indicates which content types, expressed as MIME types, the client understands.

Responses
Status codeResponse modelDescription
200GCMChannelResponse

The request succeeded.

400MessageBody

The request contains a syntax error (BadRequestException).

403MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404MessageBody

The request failed because the specified resource was not found (NotFoundException).

405MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

413MessageBody

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

429MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

DELETE

Operation ID: DeleteGcmChannel

Disables the GCM channel for an application and deletes any existing settings for the channel.

Path parameters
NameTypeRequiredDescription
application-idStringTrue

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
NameTypeRequiredDescription
acceptStringFalse

Indicates which content types, expressed as MIME types, the client understands.

Responses
Status codeResponse modelDescription
200GCMChannelResponse

The request succeeded.

400MessageBody

The request contains a syntax error (BadRequestException).

403MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404MessageBody

The request failed because the specified resource was not found (NotFoundException).

405MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

413MessageBody

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

429MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the GCM Channel resource.

Path parameters
NameTypeRequiredDescription
application-idStringTrue

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Responses
Status codeResponse modelDescription
200None

The request succeeded.

Schemas

Request bodies

{ "ApiKey": "string", "Enabled": boolean, "ServiceJson": "string", "DefaultAuthenticationMethod": "string" }

Response bodies

{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": boolean, "HasCredential": boolean, "Platform": "string", "Credential": "string", "HasFcmServiceCredentials": boolean, "DefaultAuthenticationMethod": "string" }
{ "RequestID": "string", "Message": "string" }

Properties

GCMChannelRequest

Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

PropertyTypeRequiredDescription
ApiKey

string

False

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

DefaultAuthenticationMethod

string

False

The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

Enabled

boolean

False

Specifies whether to enable the GCM channel for the application.

ServiceJson

string

False

The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.

GCMChannelResponse

Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

PropertyTypeRequiredDescription
ApplicationId

string

False

The unique identifier for the application that the GCM channel applies to.

CreationDate

string

False

The date and time when the GCM channel was enabled.

Credential

string

False

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

DefaultAuthenticationMethod

string

False

The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

Enabled

boolean

False

Specifies whether the GCM channel is enabled for the application.

HasCredential

boolean

False

(Not used) This property is retained only for backward compatibility.

HasFcmServiceCredentials

boolean

False

Returns true if the JSON file provided by Google during registration process was used in the ServiceJson field of the request.

Id

string

False

(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

IsArchived

boolean

False

Specifies whether the GCM channel is archived.

LastModifiedBy

string

False

The user who last modified the GCM channel.

LastModifiedDate

string

False

The date and time when the GCM channel was last modified.

Platform

string

True

The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

Version

integer

False

The current version of the GCM channel.

MessageBody

Provides information about an API request or response.

PropertyTypeRequiredDescription
Message

string

False

The message that's returned from the API.

RequestID

string

False

The unique identifier for the request or response.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetGcmChannel

UpdateGcmChannel

DeleteGcmChannel