The name of the environment. Possible values are: draft or live.
—file (-f)
string
Yes
The path to channel configuration file.
Note:
The import command creates a new channel or updates an existing one based on the name. If a channel with the same name exists, the command updates it using the new configuration.
Channel-specific fields, such as authentication fields.
Note:
YAML and JSON files support one channel specification per file. Python files support multiple channel instances in one file. You can define only one instance per channel type in each environment. For example, you can define both a Twilio WhatsApp channel and a Slack channel, but not two Twilio WhatsApp channels in the same environment.
The name of the environment. Possible values are: draft or live.
—type (-t)
string
No
The type of the channel.
—id (-i)
string
No
The ID of the channel. Either ID or name is required.
—name (-n)
string
No
The name of the channel. Either ID or name is required.
—verbose (-v)
-
No
Show full JSON output.
Note:
Sensitive credential fields such as authentication tokens, secrets, and passwords appear as null or blank values in the output. This protects your credentials from accidental exposure.
The name of the environment. Possible values are: draft or live.
—type (-t)
string
No
The type of the channel.
—id (-i)
string
No
The ID of the channel. Either ID or name is required.
—name (-n)
string
No
The name of the channel. Either ID or name is required.
—output (-o)
string
No
The path where the channel file will be saved.
Exporting channel configurations helps you:
Back up your channel definitions
Migrate channels between environments
Track changes through version control
Note:
Sensitive credential fields such as authentication tokens, secrets, and passwords appear as null or blank values in the exported file. This protects your credentials from accidental exposure. You need to manually add these values when importing the channel into a new environment.
The name of the environment. Possible values are: draft or live.
—type (-t)
string
Yes
The type of the channel. Possible values are: webchat, twilio_whatsapp, twilio_sms, or byo_slack.
—id (-i)
string
No
The ID of the channel.
—name (-n)
string
No
The name of the channel.
—yes (-y)
-
No
Skip confirmation prompt.
Important:
When you delete a channel, it stops receiving messages from the external platform immediately. You cannot undo this action, so make sure you want to remove the channel before you proceed.
Use webchat to embed a chat widget in your website or web application.
Note:
Webchat uses a dedicated workflow. Unlike other channel types, you manage webchat channels with a specialized command. Standard operations such as create, list-channels, get, export, and delete do not apply. For full integration steps, see Agent Integration Guide.
name: "WhatsApp Support"description: "Customer support via WhatsApp"channel: "twilio_whatsapp"spec_version: "v1"kind: "channel"account_sid: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"twilio_authentication_token: "your_auth_token_here"
Using Python:
Copy
Ask AI
from ibm_watsonx_orchestrate.agent_builder.channels import TwilioWhatsappChannelwhatsapp = TwilioWhatsappChannel( name="WhatsApp Support", description="Customer support via WhatsApp", account_sid="ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", twilio_authentication_token="your_auth_token_here")
name: "SMS Support"description: "Customer support via SMS"channel: "twilio_sms"spec_version: "v1"kind: "channel"account_sid: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"twilio_authentication_token: "your_auth_token_here"phone_number: "+1234567890"
Using Python:
Copy
Ask AI
from ibm_watsonx_orchestrate.agent_builder.channels import TwilioSMSChannelsms = TwilioSMSChannel( name="SMS Support", description="Customer support via SMS", account_sid="ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", twilio_authentication_token="your_auth_token_here", phone_number="+1234567890")
