Amazon Pinpoint
REST API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Channels

A channel is a type of platform that you can deliver messages to. For example, use the email channel to send email to newsletter subscribers, use the SMS channel to send SMS text messages to your customers, or use a push notification channel to send push notifications to users of your iOS or Android app.

You can use the Channels resource to retrieve information about the history and status of each channel for a specific application. To retrieve more detailed information about a specific type of channel or to perform other channel-specific operations, use the resource for that type of channel.

URI

/v1/apps/application-id/channels

HTTP Methods

GET

Operation ID: GetChannels

Retrieves information about the history and status of each channel for an application.

Path Parameters

Name Type Required Description
application-id String True

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

Header Parameters

Name Type Required Description
accept String False

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

Responses

Status Code Response Model Description
200 ChannelsResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

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

404 MessageBody

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

405 MessageBody

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

429 MessageBody

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

500 MessageBody

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 Channels resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Response Bodies

Example ChannelsResponse

{ "Channels": { } }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Properties

ChannelResponse

Provides information about the general settings and status of a channel for an application.

Property Type Required Description
ApplicationId

string

False

The unique identifier for the application.

IsArchived

boolean

False

Specifies whether the channel is archived.

Version

integer

False

The current version of the channel.

CreationDate

string

False

The date and time, in ISO 8601 format, when the channel was enabled.

LastModifiedDate

string

False

The date and time, in ISO 8601 format, when the channel was last modified.

LastModifiedBy

string

False

The user who last modified the channel.

Id

string

False

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

Enabled

boolean

False

Specifies whether the channel is enabled for the application.

HasCredential

boolean

False

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

ChannelsResponse

Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.

Property Type Required Description
Channels

object

True

A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

MessageBody

Provides information about an API request or response.

Property Type Required Description
RequestID

string

False

The unique identifier for the request or response.

Message

string

False

The message that's returned from the API.

See Also

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

GetChannels