Menu
Amazon Pinpoint
REST API Reference

Baidu Channel

Use the Baidu channel to send notifications through the Baidu Cloud Push service. Baidu is a Chinese cloud service.

URI

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

HTTP Methods

DELETE

Delete a BAIDU GCM channel

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

BaiduChannelResponse

GET

Get a BAIDU GCM channel

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

BaiduChannelResponse

PUT

Update a BAIDU GCM channel

Body

Name Required Type

BaiduChannelRequest

true

BaiduChannelRequest

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

BaiduChannelResponse

Errors

Errors

Status Code Schema Error Type

400

MessageBody

BadRequestException

403

MessageBody

ForbiddenException

404

MessageBody

NotFoundException

405

MessageBody

MethodNotAllowedException

429

MessageBody

TooManyRequestsException

500

MessageBody

InternalServerErrorException

Schemas

Request Schemas

Example BaiduChannelRequest

Copy
{ "ApiKey": "string", "SecretKey": "string", "Enabled": true }

Response Schemas

Example BaiduChannelResponse

Copy
{ "ApplicationId": "string", "IsArchived": true, "Version": 0, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": true, "Platform": "string", "Credential": "string" }

Example MessageBody

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

Attributes

BaiduChannelRequest

Attribute Type Description

ApiKey

string

Platform credential API key from Baidu.

Enabled

boolean

If the channel is enabled for sending messages.

SecretKey

string

Platform credential Secret key from Baidu.

BaiduChannelResponse

Attribute Type Description

ApplicationId

string

Application id

CreationDate

string

When was this segment created

Credential

string

The Baidu API key from Baidu.

Enabled

boolean

If the channel is enabled for sending messages.

Id

string

Channel ID. Not used, only for backwards compatibility.

IsArchived

boolean

Is this channel archived

LastModifiedBy

string

Who made the last change

LastModifiedDate

string

Last date this was updated

Platform

string

The platform type. Will be BAIDU

Version

integer

Version of channel

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.