Baidu Channel - Amazon Pinpoint

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 enable, 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 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
200BaiduChannelResponse

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: UpdateBaiduChannel

Enables the Baidu channel for an application or updates the status and settings of the Baidu 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
200BaiduChannelResponse

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: DeleteBaiduChannel

Disables the Baidu 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
200BaiduChannelResponse

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 Baidu 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", "SecretKey": "string", "Enabled": boolean }

Response bodies

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

Properties

BaiduChannelRequest

Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

PropertyTypeRequiredDescription
ApiKey

string

True

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

Enabled

boolean

False

Specifies whether to enable the Baidu channel for the application.

SecretKey

string

True

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

BaiduChannelResponse

Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

PropertyTypeRequiredDescription
ApplicationId

string

False

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

CreationDate

string

False

The date and time when the Baidu channel was enabled.

Credential

string

True

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

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.

Id

string

False

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

IsArchived

boolean

False

Specifies whether the Baidu channel is archived.

LastModifiedBy

string

False

The user who last modified the Baidu channel.

LastModifiedDate

string

False

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

Platform

string

True

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

Version

integer

False

The current version of the Baidu 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:

GetBaiduChannel

UpdateBaiduChannel

DeleteBaiduChannel