Oracle Digital Assistant: Channel¶
Manage OCI Digital Assistant resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | oda |
| Resource | Channel |
| API Version | oda.oracle.com/v1beta1 |
| Package | Oracle Digital Assistant |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-oda-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/oda_v1beta1_channel.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
accountSID |
The Account SID for the Twilio number. | string |
No |
allowedDomains |
A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, .corp.example.com, .hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. | string |
No |
appSecret |
The app secret for your Facebook app. | string |
No |
authErrorUrl |
The URL to redirect to when authentication is unsuccessful. | string |
No |
authSuccessUrl |
The URL to redirect to when authentication is successful. | string |
No |
authToken |
The authentication token to use when connecting to the Oracle Streaming Service. | string |
No |
authenticationProviderName |
The name of the Authentication Provider to use to authenticate the user. | string |
No |
bootstrapServers |
The Oracle Streaming Service bootstrap servers. | string |
No |
botId |
The ID of the Skill or Digital Assistant that the Channel is routed to. | string |
No |
channelService |
The type of OSVC service. | string |
No |
clientId |
The Slack Client Id for the Slack app. | string |
No |
clientSecret |
The Client Secret for the Slack App. | string |
No |
clientType |
The type of Service Cloud client. | string |
No |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
description |
A short description of the Channel. | string |
No |
domainName |
The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. | string |
No |
eventSinkBotIds |
The IDs of the Skills and Digital Assistants that the Channel is routed to. | list[string] |
No |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} |
map[string, string] |
No |
host |
The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. | string |
No |
hostNamePrefix |
The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. | string |
No |
inboundMessageTopic |
The topic inbound messages are received on. | string |
No |
isAuthenticatedUserId |
True if the user id in the AIC message should be treated as an authenticated user id. | boolean |
No |
isClientAuthenticationEnabled |
Whether client authentication is enabled or not. | boolean |
No |
isMmsEnabled |
Whether MMS is enabled for this channel or not. | boolean |
No |
jsonData |
- | string |
No |
maxTokenExpirationTimeInMinutes |
The maximum time until the token expires (in minutes). | integer (int64) |
No |
msaAppId |
The Microsoft App ID that you obtained when you created your bot registration in Azure. | string |
No |
msaAppPassword |
The client secret that you obtained from your bot registration. | string |
No |
name |
The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. | string |
Yes |
odaInstanceId |
Unique Digital Assistant instance identifier. | string |
Yes |
originalConnectorsUrl |
The original connectors URL (used for backward compatibility). | string |
No |
outboundMessageTopic |
The topic outbound messages are sent on. | string |
No |
outboundUrl |
The URL to send response and error messages to. | string |
No |
pageAccessToken |
The page access token that you generated for your Facebook page. | string |
No |
password |
The password for the Oracle B2C Service staff member who has the necessary profile permissions. | string |
No |
payloadVersion |
The version for payloads. | string |
No |
phoneNumber |
The Twilio phone number. | string |
No |
port |
The port. | string |
No |
saslMechanism |
The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. | string |
No |
securityProtocol |
The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. | string |
No |
sessionExpiryDurationInMilliseconds |
The number of milliseconds before a session expires. | integer (int64) |
No |
signingSecret |
The Signing Secret for the Slack App. | string |
No |
streamPoolId |
The stream pool OCI to use when connecting to the Oracle Streaming Service. | string |
No |
tenancyName |
The tenancy to use when connecting to the Oracle Streaming Service. | string |
No |
totalSessionCount |
The total session count. | integer |
No |
type |
- | string |
No |
userName |
The user name for an Oracle B2C Service staff member who has the necessary profile permissions. | string |
No |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
accountSID |
The Account SID for the Twilio number. | string |
No |
allowedDomains |
A comma-delimited whitelist of allowed domains. The channel will only communicate with the sites from the domains that you add to this list. For example, .corp.example.com, .hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain. Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains. | string |
No |
authErrorUrl |
The URL to redirect to when authentication is unsuccessful. | string |
No |
authSuccessUrl |
The URL to redirect to when authentication is successful. | string |
No |
authenticationProviderName |
The name of the Authentication Provider to use to authenticate the user. | string |
No |
bootstrapServers |
The Oracle Streaming Service bootstrap servers. | string |
No |
botId |
The ID of the Skill or Digital Assistant that the Channel is routed to. | string |
No |
category |
The category of the Channel. | string |
No |
channelService |
The type of OSVC service. | string |
No |
clientId |
The Slack Client Id for the Slack app. | string |
No |
clientType |
The type of Service Cloud client. | string |
No |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
description |
A short description of the Channel. | string |
No |
domainName |
The domain name. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. | string |
No |
eventSinkBotIds |
The IDs of the Skills and Digital Assistants that the Channel is routed to. | list[string] |
No |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"} |
map[string, string] |
No |
host |
The host. For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com. For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com. | string |
No |
hostNamePrefix |
The host prefix. If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix is sitename and the domain name is exampledomain.com. If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces, then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com. | string |
No |
id |
Unique immutable identifier that was assigned when the Channel was created. | string |
No |
inboundMessageTopic |
The topic inbound messages are received on. | string |
No |
isAuthenticatedUserId |
True if the user id in the AIC message should be treated as an authenticated user id. | boolean |
No |
isClientAuthenticationEnabled |
Whether client authentication is enabled or not. | boolean |
No |
isMmsEnabled |
Whether MMS is enabled for this channel or not. | boolean |
No |
jsonData |
- | string |
No |
lifecycleState |
The Channel's current state. | string |
No |
maxTokenExpirationTimeInMinutes |
The maximum time until the token expires (in minutes). | integer (int64) |
No |
msaAppId |
The Microsoft App ID that you obtained when you created your bot registration in Azure. | string |
No |
name |
The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. | string |
No |
originalConnectorsUrl |
The original connectors URL (used for backward compatibility). | string |
No |
outboundMessageTopic |
The topic outbound messages are sent on. | string |
No |
outboundUrl |
The URL for sending errors and responses to. | string |
No |
payloadVersion |
The version for payloads. | string |
No |
phoneNumber |
The Twilio phone number. | string |
No |
port |
The port. | string |
No |
saslMechanism |
The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. | string |
No |
securityProtocol |
The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. | string |
No |
sessionExpiryDurationInMilliseconds |
The number of milliseconds before a session expires. | integer (int64) |
No |
status |
- | object |
Yes |
streamPoolId |
The stream pool OCI to use when connecting to the Oracle Streaming Service. | string |
No |
tenancyName |
The tenancy to use when connecting to the Oracle Streaming Service. | string |
No |
timeCreated |
When the resource was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. | string |
No |
timeUpdated |
When the resource was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. | string |
No |
totalSessionCount |
The total session count. | integer |
No |
type |
- | string |
No |
userName |
The user name for the digital-assistant agent. | string |
No |
webhookUrl |
The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel. | string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/oda_v1beta1_channel.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
apiVersion: oda.oracle.com/v1beta1
kind: Channel
metadata:
name: channel-sample
spec: {}