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.
URI
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
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 BaiduChannelResponse (p. 90)The request succeeded.
400 MessageBody (p. 90) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 90) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 90) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 90) The request failed because
the method is not allowed
HTTP methods
Status code Response model Description
for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 90) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 90) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 90) 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
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 BaiduChannelResponse (p. 90)The request succeeded.
400 MessageBody (p. 90) The request contains a syntax
error (BadRequestException).
HTTP methods
Status code Response model Description
403 MessageBody (p. 90) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 90) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 90) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 90) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 90) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 90) 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
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.
HTTP methods
Responses
Status code Response model Description
200 BaiduChannelResponse (p. 90)The request succeeded.
400 MessageBody (p. 90) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 90) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 90) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 90) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 90) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 90) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 90) 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
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.
Schemas
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Request bodies
PUT schema
{ "ApiKey": "string", "SecretKey": "string", "Enabled": boolean }
Response bodies
BaiduChannelResponse schema
{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string",
"Enabled": boolean, "HasCredential": boolean, "Platform": "string", "Credential": "string"
}
MessageBody schema
{
"RequestID": "string", "Message": "string"
}
Properties
BaiduChannelRequest
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
ApiKey
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Type: string
Properties
Required: True
SecretKey
The secret key that you received from the Baidu Cloud Push service to communicate with the service.
Type: string Required: True
Enabled
Specifies whether to enable the Baidu channel for the application.
Type: boolean Required: False
BaiduChannelResponse
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
ApplicationId
The unique identifier for the application that the Baidu channel applies to.
Type: string Required: False
IsArchived
Specifies whether the Baidu channel is archived.
Type: boolean Required: False
Version
The current version of the Baidu channel.
Type: integer Required: False
CreationDate
The date and time when the Baidu channel was enabled.
Type: string Required: False
LastModifiedDate
The date and time when the Baidu channel was last modified.
Type: string Required: False
Properties
LastModifiedBy
The user who last modified the Baidu channel.
Type: string Required: False
Id
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
Type: string Required: False
Enabled
Specifies whether the Baidu channel is enabled for the application.
Type: boolean Required: False
HasCredential
(Not used) This property is retained only for backward compatibility.
Type: boolean Required: False
Platform
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
Type: string Required: True
Credential
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Type: string Required: True
MessageBody
Provides information about an API request or response.
RequestID
The unique identifier for the request or response.
Type: string Required: False
See also
Message
The message that's returned from the API.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetBaiduChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateBaiduChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteBaiduChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Campaign
Campaign
A campaign is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application. The information represented by this resource includes the segment of users that a campaign sends messages to, the message that a campaign delivers, and the schedule on which a campaign runs.
You can use the Campaign resource to retrieve information about, update, or delete a specific campaign.
To create a campaign, use the Campaigns (p. 217) resource and send a POST request to the / apps/application-id/campaigns URI.
URI
/v1/apps/application-id/campaigns/campaign-id
HTTP methods
GET
Operation ID: GetCampaign
Retrieves information about the status, configuration, and other settings for a campaign.
Path parameters
Name Type Required Description
campaign-id String True The unique identifier
for the campaign.
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 CampaignResponse (p. 105) The request succeeded.
400 MessageBody (p. 112) The request contains a syntax
error (BadRequestException).
HTTP methods
Status code Response model Description
403 MessageBody (p. 112) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 112) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 112) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 112) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 112) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 112) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
PUT
Operation ID: UpdateCampaign
Updates the configuration and other settings for a campaign.
Path parameters
Name Type Required Description
campaign-id String True The unique identifier
for the campaign.
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
HTTP methods
Name Type Required Description
MIME types, the client understands.
Responses
Status code Response model Description
200 CampaignResponse (p. 105) The request succeeded.
400 MessageBody (p. 112) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 112) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 112) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 112) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 112) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 112) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 112) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
DELETE
Operation ID: DeleteCampaign Deletes a campaign from an application.
Path parameters
Name Type Required Description
campaign-id String True The unique identifier
for the campaign.
application-id String True The unique identifier
for the application. This
HTTP methods
Name Type Required Description
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 CampaignResponse (p. 105) The request succeeded.
400 MessageBody (p. 112) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 112) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 112) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 112) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 112) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 112) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 112) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
Schemas
OPTIONS
Retrieves information about the communication requirements and options that are available for the Campaign resource.
Path parameters
Name Type Required Description
campaign-id String True The unique identifier
for the campaign.
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Request bodies
PUT schema
{
"TreatmentName": "string", "TreatmentDescription": "string", "MessageConfiguration": {
"DefaultMessage": { "Body": "string", "Title": "string", "ImageUrl": "string", "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum,
Schemas
"Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "FromAddress": "string"
},
"SMSMessage": { "Body": "string", "MessageType": enum, "SenderId": "string",
"OriginationNumber": "string", "EntityId": "string",
"TemplateId": "string"
},
"CustomMessage": { "Data": "string"
},
"InAppMessage": {
Schemas
Schemas
"Schedule": {
"StartTime": "string", "EndTime": "string", "Frequency": enum, "IsLocalTime": boolean, "Timezone": "string", "QuietTime": {
"TemplateConfiguration": { "SMSTemplate": {
"CustomDeliveryConfiguration": { "EndpointTypes": [
enum ],
"DeliveryUri": "string"
}, "SegmentId": "string", "SegmentVersion": integer, "IsPaused": boolean, "AdditionalTreatments": [ {
"TreatmentName": "string", "TreatmentDescription": "string", "MessageConfiguration": {
"DefaultMessage": {
Schemas
Schemas
Schemas
"TemplateConfiguration": { "SMSTemplate": {
"CustomDeliveryConfiguration": { "EndpointTypes": [
Schemas
],
"HoldoutPercent": integer, "Limits": {
"Daily": integer, "Total": integer, "Session": integer,
"MessagesPerSecond": integer, "MaximumDuration": integer },
"Name": "string", "Hook": {
"LambdaFunctionName": "string", "WebUrl": "string",
"Mode": enum
}, "Description": "string", "tags": {
}, "Priority": integer }
Response bodies
CampaignResponse schema
{ "TreatmentName": "string", "TreatmentDescription": "string", "MessageConfiguration": {
"DefaultMessage": { "Body": "string", "Title": "string", "ImageUrl": "string", "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
Schemas
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "ImageIconUrl": "string", "ImageSmallIconUrl": "string", "MediaUrl": "string",
"Action": enum, "Url": "string", "SilentPush": boolean, "JsonBody": "string", "RawContent": "string", "TimeToLive": integer "FromAddress": "string"
},
"SMSMessage": { "Body": "string", "MessageType": enum, "SenderId": "string",
"OriginationNumber": "string", "EntityId": "string",
"TemplateId": "string"
},
Schemas
"StartTime": "string", "EndTime": "string", "Frequency": enum, "IsLocalTime": boolean, "Timezone": "string", "QuietTime": {
Schemas
}, "TemplateConfiguration": { "SMSTemplate": {
"CustomDeliveryConfiguration": { "EndpointTypes": [
enum ],
"DeliveryUri": "string"
}, "Id": "string",
"ApplicationId": "string", "CreationDate": "string", "LastModifiedDate": "string", "SegmentId": "string",
"SegmentVersion": integer, "AdditionalTreatments": [ {
"TreatmentName": "string", "TreatmentDescription": "string", "MessageConfiguration": {
"DefaultMessage": {
Schemas
Schemas
Schemas
"TemplateConfiguration": { "SMSTemplate": {
"CustomDeliveryConfiguration": { "EndpointTypes": [
"HoldoutPercent": integer, "Name": "string",
"Limits": {
"Daily": integer, "Total": integer,
Properties
"Session": integer,
"MessagesPerSecond": integer, "MaximumDuration": integer },
"Description": "string", "Hook": {
"LambdaFunctionName": "string", "WebUrl": "string",
"Mode": enum }, "State": {
"CampaignStatus": enum }, "DefaultState": { "CampaignStatus": enum },
"Version": integer, "IsPaused": boolean, "Arn": "string", "tags": { },
"Priority": integer }
MessageBody schema
{
"RequestID": "string", "Message": "string"
}
Properties
AttributeDimension
Specifies attribute-based criteria for including or excluding endpoints from a segment.
AttributeType
The type of segment dimension to use. Valid values are:
• INCLUSIVE – endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE – endpoints that have attributes matching the values are excluded from the segment.
• CONTAINS – endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE – endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER – endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• BETWEEN – endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
• ON – endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment.
Time is ignored in this comparison.
Type: string Required: False
Properties
Values: INCLUSIVE | EXCLUSIVE | CONTAINS | BEFORE | AFTER | BETWEEN | ON
Values
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
Type: Array of type string Required: True
CampaignCustomMessage
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
Data
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
Type: string Required: False
CampaignEmailMessage
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
Body
The body of the email for recipients whose email clients don't render HTML content.
Type: string Required: False
Title
The subject line, or title, of the email.
Type: string Required: False
HtmlBody
The body of the email, in HTML format, for recipients whose email clients render HTML content.
Type: string Required: False
FromAddress
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
Type: string
Properties
Required: False
CampaignEventFilter
Specifies the settings for events that cause a campaign to be sent.
Dimensions
The dimension settings of the event filter for the campaign.
Type: EventDimensions (p. 123) Required: True
FilterType
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the
campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events (p. 329) resource) occurs.
Type: string Required: True
Values: SYSTEM | ENDPOINT
CampaignHook
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
LambdaFunctionName
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Type: string Required: False
WebUrl
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Type: string Required: False
Mode
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
• FILTER – Invoke the function to customize the segment that's used by a campaign.
• DELIVERY – (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
Type: string
Properties
Required: False
Values: DELIVERY | FILTER
CampaignInAppMessage
Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message.
Body
The body text of the in-app notification.
Type: string Required: False
Layout
A string that describes how the in-app message will appear. You can specify one of the following:
• BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
• TOP_BANNER – a message that appears as a banner at the top of the page.
• OVERLAYS – a message that covers entire screen.
• MOBILE_FEED – a message that appears in a window in front of the page.
• MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
• CAROUSEL – a scrollable layout of up to five unique messages.
Type: string Required: False
Values: BOTTOM_BANNER | TOP_BANNER | OVERLAYS | MOBILE_FEED | MIDDLE_BANNER | CAROUSEL
Content
An array that contains configurtion information about the in-app message for the campaign, including title and body text, text colors, background colors, image URLs, and button configurations.
Type: Array of type InAppMessageContent (p. 124) Required: False
CustomConfig
An object that contains custom data (in the form of key-value pairs) that is included in the in-app messaging payload.
Type: object Required: False
CampaignLimits
For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.
Properties
Daily
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is