Amazon Pinpoint
REST API Reference

Baidu Channel

A channel is a type of platform that you can deliver messages to. You can use the Baidu channel to send push notification messages to the Baidu Cloud Push service, which is a Chinese cloud service. Before you can use Amazon Pinpoint to send notification messages to the Baidu Cloud Push service, you must enable the Baidu channel for an Amazon Pinpoint application.

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

URI

/v1/apps/application-id/channels/baidu

HTTP Methods

GET

Operation ID: GetBaiduChannel

Retrieves information about the status and settings of the Baidu Cloud Push channel for an application.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application.

Header Parameters

Name Type Required Description
accept String False

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

x-amz-user-agent String False

Identifies the client that's sending the request.

Responses

Status Code Response Model Description
200 BaiduChannelResponse

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).

PUT

Operation ID: UpdateBaiduChannel

Updates the settings of the Baidu Cloud Push channel for an application.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application.

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 BaiduChannelResponse

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).

DELETE

Operation ID: DeleteBaiduChannel

Disables the Baidu Cloud Push channel for an application and deletes any existing settings for the channel.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application.

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 BaiduChannelResponse

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 Baidu Channel resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example PUT

{ "ApiKey": "string", "SecretKey": "string", "Enabled": boolean }

Response Bodies

Example BaiduChannelResponse

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

Example MessageBody

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

Properties

BaiduChannelRequest

Property Type Required Description
ApiKey

string

True

The API key that you received from the Baidu Cloud Push service to communicate with the service.

SecretKey

string

True

The secret key that you received from the Baidu Cloud Push service to communicate with the service.

Enabled

boolean

True

Specifies whether to enable the Baidu channel for the application.

BaiduChannelResponse

Property Type Required Description
ApplicationId

string

False

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

IsArchived

boolean

False

Specifies whether the Baidu channel is archived.

Version

integer

False

The current version of the Baidu channel.

CreationDate

string

False

The date and time when the Baidu channel was created.

LastModifiedDate

string

False

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

LastModifiedBy

string

False

The user who last modified the Baidu channel.

Id

string

False

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

Enabled

boolean

False

Specifies whether the Baidu channel is enabled for the application.

HasCredential

boolean

False

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

Platform

string

True

The type of messaging or notification platform for the channel. For the Baidu channel, the value is BAIDU.

Credential

string

True

The API key that you received from the Baidu Cloud Push service to communicate with the service.

MessageBody

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:

GetBaiduChannel

UpdateBaiduChannel

DeleteBaiduChannel