Google Cloud RCS SendCarousel

Google Cloud RCS SendCarousel
Certified
Send a carousel of Rich Cards to a recipient's phone number

Sends a horizontal scrolling list of 2 to 10 rich media cards.

yaml
type: io.kestra.plugin.gcp.rcs.SendCarousel

Examples

Send a carousel of rich cards

yaml
id: rcs_send_carousel
namespace: company.team

tasks:
  - id: send_carousel
    type: io.kestra.plugin.gcp.rcs.SendCarousel
    serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT') }}"
    agentId: "{{ secret('RBM_AGENT_ID') }}"
    msisdn: "+33612345678"
    cards:
      - title: "Item 1"
        description: "First option description"
        imageUrl: "https://example.com/item1.jpg"
        suggestions:
          - type: REPLY
            text: "Select Item 1"
            postbackData: "select_1"
      - title: "Item 2"
        description: "Second option description"
        imageUrl: "https://example.com/item2.jpg"
        suggestions:
          - type: REPLY
            text: "Select Item 2"
            postbackData: "select_2"

Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-gcp --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

agentId *string

The unique agent ID of the Brand Agent configured on the RBM platform

cards *array

The list of rich cards in the carousel (between 2 and 10 cards)

Definitions

io.kestra.plugin.gcp.rcs.Card

descriptionstring

The card description

imageUrlstring

The card media/image URL

suggestionsarray

The list of suggested actions/replies (max 4 per card)

io.kestra.plugin.gcp.rcs.Suggestion

text*string

The label text displayed on the suggestion button

type*object

latitudenumberstring

The latitude for the location coordinates (required if type is MAP)

locationLabelstring

The label description for the location (optional if type is MAP)

longitudenumberstring

The longitude for the location coordinates (required if type is MAP)

phoneNumberstring

The phone number to dial in E.164 format (required if type is DIAL)

postbackDatastring

The postback data payload returned to the agent when clicked

urlstring

The destination URL (required if type is URL)

titlestring

The card title

msisdn *string

The recipient's phone number (MSISDN) in E.164 format (e.g. +33612345678)

assets

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions

io.kestra.core.models.assets.AssetsDeclaration

assetFailureBehaviorstring

Possible Values

IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

io.kestra.core.models.assets.AssetIdentifier

id*string

Min length1

typestring

outputs

The assets produced as outputs.

io.kestra.plugin.ee.assets.Dataset

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.File

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.Table

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.VM

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.External

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.Custom

id*string

Min length1

Max length150

type*string

Min length1

Custom asset type

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

impersonatedServiceAccount string

The GCP service account to impersonate

projectId string

The GCP project ID

scopes array

SubTypestring

Default["https://www.googleapis.com/auth/rcsbusinessmessaging"]

The GCP scopes to be used

serviceAccount string

The GCP service account

When unset or rendered to an empty value, Application Default Credentials are used (e.g. GOOGLE_APPLICATION_CREDENTIALS or the runtime's attached identity).

workloadIdentityAudience string

Audience of the Workload Identity Federation provider

The full resource name of the workload identity pool provider, //iam.googleapis.com/projects/<number>/locations/global/workloadIdentityPools/<pool>/providers/<provider>. Required with workloadIdentityToken, and must match the aud claim of the token.

workloadIdentityToken string

OIDC token for Workload Identity Federation

When set together with workloadIdentityAudience, the token is exchanged at Google STS for federated credentials and no service account key is needed: Google verifies it against the identity provider that issued it. Use {{ oidcToken(audience='…') }} to have Kestra Enterprise mint one for the running execution. Combine with impersonatedServiceAccount to act as a service account the pool may impersonate, and set projectId explicitly since no key file carries it. Cannot be combined with serviceAccount.

Outputs

messageId string

The unique message ID assigned by the RBM platform

sendTime string

Formatdate-time

The timestamp when the message was sent