oracle.oci.oci_oda_channel – Manage a Channel resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_oda_channel.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to create, update and delete a Channel resource in Oracle Cloud Infrastructure
For state=present, creates a new Channel.
This resource has the following action operations in the oracle.oci.oci_oda_channel_actions module: rotate_channel_keys, start, stop.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
account_sid string		The Account SID for the Twilio number. This parameter is updatable. Applicable when type is 'TWILIO' Required when type is 'TWILIO'
allowed_domains string		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. This parameter is updatable. Applicable when type is 'WEB'
api_user string		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string		Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string		Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string		Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
app_secret string		The app secret for your Facebook app. This parameter is updatable. Applicable when type is 'FACEBOOK' Required when type is 'FACEBOOK'
auth_error_url string		The URL to redirect to when authentication is unsuccessful. This parameter is updatable. Applicable when type is 'SLACK'
auth_purpose string	Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_success_url string		The URL to redirect to when authentication is successful. This parameter is updatable. Applicable when type is 'SLACK'
auth_token string		The authentication token to use when connecting to the Oracle Streaming Service. This parameter is updatable. Applicable when type is one of ['OSS', 'TWILIO'] Required when type is one of ['OSS', 'TWILIO']
auth_type string	Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
authentication_provider_name string		The name of the Authentication Provider to use to authenticate the user. This parameter is updatable. Applicable when type is 'OSVC' Required when type is 'OSVC'
bootstrap_servers string		The Oracle Streaming Service bootstrap servers. This parameter is updatable. Applicable when type is 'OSS' Required when type is 'OSS'
bot_id string		The ID of the Skill or Digital Assistant that the Channel is routed to. This parameter is updatable. Applicable when type is one of ['FACEBOOK', 'MSTEAMS', 'OSVC', 'WEB', 'SLACK', 'WEBHOOK', 'ANDROID', 'IOS', 'CORTANA', 'TWILIO']
cert_bundle string		The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
channel_id string		Unique Channel identifier. Required for update using state=present when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. Required for delete using state=absent when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. aliases: id
channel_service string	Choices: OSVC FUSION	The type of OSVC service. This parameter is updatable. Applicable when type is 'OSVC'
client_id string		The Slack Client Id for the Slack app. This parameter is updatable. Applicable when type is 'SLACK' Required when type is 'SLACK'
client_secret string		The Client Secret for the Slack App. This parameter is updatable. Applicable when type is 'SLACK' Required when type is 'SLACK'
client_type string	Choices: WSDL REST	The type of Service Cloud client. This parameter is updatable. Applicable when type is 'SERVICECLOUD' Required when type is 'SERVICECLOUD'
config_file_location string		Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string		The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
defined_tags dictionary		Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` This parameter is updatable.
description string		A short description of the Channel. This parameter is updatable.
domain_name string		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. This parameter is updatable. Applicable when type is 'SERVICECLOUD' Required when type is 'SERVICECLOUD'
event_sink_bot_ids list / elements=string		The IDs of the Skills and Digital Assistants that the Channel is routed to. This parameter is updatable. Applicable when type is one of ['APPEVENT', 'OSS']
force_create boolean	Choices: no ← yes	Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags dictionary		Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` This parameter is updatable.
host string		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. This parameter is updatable. Applicable when type is 'OSVC' Required when type is 'OSVC'
host_name_prefix string		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. This parameter is updatable. Applicable when type is 'SERVICECLOUD' Required when type is 'SERVICECLOUD'
inbound_message_topic string		The topic inbound messages are received on. This parameter is updatable. Applicable when type is 'OSS' Required when type is 'OSS'
is_authenticated_user_id boolean	Choices: no yes	True if the user id in the AIC message should be treated as an authenticated user id. This parameter is updatable. Applicable when type is 'APPLICATION' Required when type is 'APPLICATION'
is_client_authentication_enabled boolean	Choices: no yes	Whether client authentication is enabled or not. This parameter is updatable. Applicable when type is one of ['WEB', 'ANDROID', 'IOS'] Required when type is one of ['WEB', 'ANDROID', 'IOS']
is_mms_enabled boolean	Choices: no yes	Whether MMS is enabled for this channel or not. This parameter is updatable. Applicable when type is 'TWILIO' Required when type is 'TWILIO'
key_by list / elements=string		The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
max_token_expiration_time_in_minutes integer		The maximum time until the token expires (in minutes). This parameter is updatable. Applicable when type is one of ['WEB', 'ANDROID', 'IOS']
msa_app_id string		The Microsoft App ID that you obtained when you created your bot registration in Azure. This parameter is updatable. Applicable when type is one of ['MSTEAMS', 'CORTANA'] Required when type is one of ['MSTEAMS', 'CORTANA']
msa_app_password string		The client secret that you obtained from your bot registration. This parameter is updatable. Applicable when type is one of ['MSTEAMS', 'CORTANA'] Required when type is one of ['MSTEAMS', 'CORTANA']
name string		The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. Required for create using state=present. Required for update, delete when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set.
oda_instance_id string / required		Unique Digital Assistant instance identifier.
original_connectors_url string		The original connectors URL (used for backward compatibility). This parameter is updatable. Applicable when type is 'TWILIO'
outbound_message_topic string		The topic outbound messages are sent on. This parameter is updatable. Applicable when type is 'OSS' Required when type is 'OSS'
outbound_url string		The URL to send response and error messages to. This parameter is updatable. Applicable when type is one of ['APPLICATION', 'WEBHOOK', 'APPEVENT'] Required when type is 'WEBHOOK'
page_access_token string		The page access token that you generated for your Facebook page. This parameter is updatable. Applicable when type is 'FACEBOOK' Required when type is 'FACEBOOK'
password string		The password for the Oracle B2C Service staff member who has the necessary profile permissions. This parameter is updatable. Applicable when type is one of ['OSVC', 'SERVICECLOUD'] Required when type is one of ['OSVC', 'SERVICECLOUD']
payload_version string	Choices: 1.0 1.1	The version for payloads. This parameter is updatable. Applicable when type is 'WEBHOOK' Required when type is 'WEBHOOK'
phone_number string		The Twilio phone number. This parameter is updatable. Applicable when type is 'TWILIO' Required when type is 'TWILIO'
port string		The port. This parameter is updatable. Applicable when type is 'OSVC' Required when type is 'OSVC'
realm_specific_endpoint_template_enabled boolean	Choices: no yes	Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region string		The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sasl_mechanism string		The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. This parameter is updatable. Applicable when type is 'OSS' Required when type is 'OSS'
security_protocol string		The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. This parameter is updatable. Applicable when type is 'OSS' Required when type is 'OSS'
session_expiry_duration_in_milliseconds integer		The number of milliseconds before a session expires. This parameter is updatable.
signing_secret string		The Signing Secret for the Slack App. This parameter is updatable. Applicable when type is 'SLACK' Required when type is 'SLACK'
state string	Choices: present ← absent	The state of the Channel. Use state=present to create or update a Channel. Use state=absent to delete a Channel.
stream_pool_id string		The stream pool OCI to use when connecting to the Oracle Streaming Service. This parameter is updatable. Applicable when type is 'OSS' Required when type is 'OSS'
tenancy string		OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
tenancy_name string		The tenancy to use when connecting to the Oracle Streaming Service. This parameter is updatable. Applicable when type is 'OSS' Required when type is 'OSS'
total_session_count integer		The total session count. This parameter is updatable. Applicable when type is 'OSVC' Required when type is 'OSVC'
type string	Choices: MSTEAMS WEB FACEBOOK APPLICATION SERVICECLOUD SLACK OSVC APPEVENT OSS CORTANA ANDROID TWILIO WEBHOOK IOS	The Channel type. Required for create using state=present, update using state=present with channel_id present.
user_name string		The user name for an Oracle B2C Service staff member who has the necessary profile permissions. This parameter is updatable. Applicable when type is one of ['OSVC', 'SERVICECLOUD', 'OSS'] Required when type is one of ['OSVC', 'SERVICECLOUD', 'OSS']
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer		Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create channel with type = MSTEAMS
  oci_oda_channel:
    # required
    name: name_example
    type: MSTEAMS

    # optional
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    msa_app_id: "ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx"
    msa_app_password: example-password
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = WEB
  oci_oda_channel:
    # required
    name: name_example
    type: WEB

    # optional
    allowed_domains: allowed_domains_example
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = FACEBOOK
  oci_oda_channel:
    # required
    name: name_example
    type: FACEBOOK

    # optional
    app_secret: app_secret_example
    page_access_token: page_access_token_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = APPLICATION
  oci_oda_channel:
    # required
    name: name_example
    type: APPLICATION

    # optional
    outbound_url: outbound_url_example
    is_authenticated_user_id: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create channel with type = SERVICECLOUD
  oci_oda_channel:
    # required
    name: name_example
    type: SERVICECLOUD

    # optional
    domain_name: domain_name_example
    host_name_prefix: host_name_prefix_example
    user_name: user_name_example
    password: example-password
    client_type: WSDL
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create channel with type = SLACK
  oci_oda_channel:
    # required
    name: name_example
    type: SLACK

    # optional
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    auth_success_url: auth_success_url_example
    auth_error_url: auth_error_url_example
    signing_secret: signing_secret_example
    client_secret: client_secret_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = OSVC
  oci_oda_channel:
    # required
    name: name_example
    type: OSVC

    # optional
    host: host_example
    port: port_example
    total_session_count: 56
    channel_service: OSVC
    authentication_provider_name: authentication_provider_name_example
    user_name: user_name_example
    password: example-password
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = APPEVENT
  oci_oda_channel:
    # required
    name: name_example
    type: APPEVENT

    # optional
    event_sink_bot_ids: [ "event_sink_bot_ids_example" ]
    outbound_url: outbound_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create channel with type = OSS
  oci_oda_channel:
    # required
    name: name_example
    type: OSS

    # optional
    inbound_message_topic: inbound_message_topic_example
    outbound_message_topic: outbound_message_topic_example
    bootstrap_servers: bootstrap_servers_example
    security_protocol: security_protocol_example
    sasl_mechanism: sasl_mechanism_example
    tenancy_name: tenancy_name_example
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"
    event_sink_bot_ids: [ "event_sink_bot_ids_example" ]
    user_name: user_name_example
    auth_token: auth_token_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create channel with type = CORTANA
  oci_oda_channel:
    # required
    name: name_example
    type: CORTANA

    # optional
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    msa_app_id: "ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx"
    msa_app_password: example-password
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = ANDROID
  oci_oda_channel:
    # required
    name: name_example
    type: ANDROID

    # optional
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = TWILIO
  oci_oda_channel:
    # required
    name: name_example
    type: TWILIO

    # optional
    account_sid: account_sid_example
    phone_number: phone_number_example
    auth_token: auth_token_example
    is_mms_enabled: true
    original_connectors_url: original_connectors_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = WEBHOOK
  oci_oda_channel:
    # required
    name: name_example
    type: WEBHOOK

    # optional
    payload_version: 1.0
    outbound_url: outbound_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Create channel with type = IOS
  oci_oda_channel:
    # required
    name: name_example
    type: IOS

    # optional
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = MSTEAMS
  oci_oda_channel:
    # required
    type: MSTEAMS

    # optional
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    msa_app_id: "ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx"
    msa_app_password: example-password
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = WEB
  oci_oda_channel:
    # required
    type: WEB

    # optional
    allowed_domains: allowed_domains_example
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = FACEBOOK
  oci_oda_channel:
    # required
    type: FACEBOOK

    # optional
    app_secret: app_secret_example
    page_access_token: page_access_token_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = APPLICATION
  oci_oda_channel:
    # required
    type: APPLICATION

    # optional
    outbound_url: outbound_url_example
    is_authenticated_user_id: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel with type = SERVICECLOUD
  oci_oda_channel:
    # required
    type: SERVICECLOUD

    # optional
    domain_name: domain_name_example
    host_name_prefix: host_name_prefix_example
    user_name: user_name_example
    password: example-password
    client_type: WSDL
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel with type = SLACK
  oci_oda_channel:
    # required
    type: SLACK

    # optional
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    auth_success_url: auth_success_url_example
    auth_error_url: auth_error_url_example
    signing_secret: signing_secret_example
    client_secret: client_secret_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = OSVC
  oci_oda_channel:
    # required
    type: OSVC

    # optional
    host: host_example
    port: port_example
    total_session_count: 56
    channel_service: OSVC
    authentication_provider_name: authentication_provider_name_example
    user_name: user_name_example
    password: example-password
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = APPEVENT
  oci_oda_channel:
    # required
    type: APPEVENT

    # optional
    event_sink_bot_ids: [ "event_sink_bot_ids_example" ]
    outbound_url: outbound_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel with type = OSS
  oci_oda_channel:
    # required
    type: OSS

    # optional
    inbound_message_topic: inbound_message_topic_example
    outbound_message_topic: outbound_message_topic_example
    bootstrap_servers: bootstrap_servers_example
    security_protocol: security_protocol_example
    sasl_mechanism: sasl_mechanism_example
    tenancy_name: tenancy_name_example
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"
    event_sink_bot_ids: [ "event_sink_bot_ids_example" ]
    user_name: user_name_example
    auth_token: auth_token_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel with type = CORTANA
  oci_oda_channel:
    # required
    type: CORTANA

    # optional
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    msa_app_id: "ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx"
    msa_app_password: example-password
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = ANDROID
  oci_oda_channel:
    # required
    type: ANDROID

    # optional
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = TWILIO
  oci_oda_channel:
    # required
    type: TWILIO

    # optional
    account_sid: account_sid_example
    phone_number: phone_number_example
    auth_token: auth_token_example
    is_mms_enabled: true
    original_connectors_url: original_connectors_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = WEBHOOK
  oci_oda_channel:
    # required
    type: WEBHOOK

    # optional
    payload_version: 1.0
    outbound_url: outbound_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel with type = IOS
  oci_oda_channel:
    # required
    type: IOS

    # optional
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = MSTEAMS
  oci_oda_channel:
    # required
    name: name_example
    type: MSTEAMS

    # optional
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    msa_app_id: "ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx"
    msa_app_password: example-password
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = WEB
  oci_oda_channel:
    # required
    name: name_example
    type: WEB

    # optional
    allowed_domains: allowed_domains_example
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = FACEBOOK
  oci_oda_channel:
    # required
    name: name_example
    type: FACEBOOK

    # optional
    app_secret: app_secret_example
    page_access_token: page_access_token_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = APPLICATION
  oci_oda_channel:
    # required
    name: name_example
    type: APPLICATION

    # optional
    outbound_url: outbound_url_example
    is_authenticated_user_id: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = SERVICECLOUD
  oci_oda_channel:
    # required
    name: name_example
    type: SERVICECLOUD

    # optional
    domain_name: domain_name_example
    host_name_prefix: host_name_prefix_example
    user_name: user_name_example
    password: example-password
    client_type: WSDL
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = SLACK
  oci_oda_channel:
    # required
    name: name_example
    type: SLACK

    # optional
    client_id: "ocid1.client.oc1..xxxxxxEXAMPLExxxxxx"
    auth_success_url: auth_success_url_example
    auth_error_url: auth_error_url_example
    signing_secret: signing_secret_example
    client_secret: client_secret_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = OSVC
  oci_oda_channel:
    # required
    name: name_example
    type: OSVC

    # optional
    host: host_example
    port: port_example
    total_session_count: 56
    channel_service: OSVC
    authentication_provider_name: authentication_provider_name_example
    user_name: user_name_example
    password: example-password
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = APPEVENT
  oci_oda_channel:
    # required
    name: name_example
    type: APPEVENT

    # optional
    event_sink_bot_ids: [ "event_sink_bot_ids_example" ]
    outbound_url: outbound_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = OSS
  oci_oda_channel:
    # required
    name: name_example
    type: OSS

    # optional
    inbound_message_topic: inbound_message_topic_example
    outbound_message_topic: outbound_message_topic_example
    bootstrap_servers: bootstrap_servers_example
    security_protocol: security_protocol_example
    sasl_mechanism: sasl_mechanism_example
    tenancy_name: tenancy_name_example
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"
    event_sink_bot_ids: [ "event_sink_bot_ids_example" ]
    user_name: user_name_example
    auth_token: auth_token_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = CORTANA
  oci_oda_channel:
    # required
    name: name_example
    type: CORTANA

    # optional
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    msa_app_id: "ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx"
    msa_app_password: example-password
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = ANDROID
  oci_oda_channel:
    # required
    name: name_example
    type: ANDROID

    # optional
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = TWILIO
  oci_oda_channel:
    # required
    name: name_example
    type: TWILIO

    # optional
    account_sid: account_sid_example
    phone_number: phone_number_example
    auth_token: auth_token_example
    is_mms_enabled: true
    original_connectors_url: original_connectors_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = WEBHOOK
  oci_oda_channel:
    # required
    name: name_example
    type: WEBHOOK

    # optional
    payload_version: 1.0
    outbound_url: outbound_url_example
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = IOS
  oci_oda_channel:
    # required
    name: name_example
    type: IOS

    # optional
    max_token_expiration_time_in_minutes: 56
    is_client_authentication_enabled: true
    description: description_example
    session_expiry_duration_in_milliseconds: 56
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    bot_id: "ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete channel
  oci_oda_channel:
    # required
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
    channel_id: "ocid1.channel.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete channel using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_oda_channel:
    # required
    name: name_example
    oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
channel complex		on success	Details of the Channel resource acted upon by the current operation Sample: {'account_sid': 'account_sid_example', 'allowed_domains': 'allowed_domains_example', 'auth_error_url': 'auth_error_url_example', 'auth_success_url': 'auth_success_url_example', 'authentication_provider_name': 'authentication_provider_name_example', 'bootstrap_servers': 'bootstrap_servers_example', 'bot_id': 'ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx', 'category': 'AGENT', 'channel_service': 'OSVC', 'client_id': 'ocid1.client.oc1..xxxxxxEXAMPLExxxxxx', 'client_type': 'WSDL', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'domain_name': 'domain_name_example', 'event_sink_bot_ids': [], 'freeform_tags': {'Department': 'Finance'}, 'host': 'host_example', 'host_name_prefix': 'host_name_prefix_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'inbound_message_topic': 'inbound_message_topic_example', 'is_authenticated_user_id': True, 'is_client_authentication_enabled': True, 'is_mms_enabled': True, 'lifecycle_state': 'CREATING', 'max_token_expiration_time_in_minutes': 56, 'msa_app_id': 'ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'original_connectors_url': 'original_connectors_url_example', 'outbound_message_topic': 'outbound_message_topic_example', 'outbound_url': 'outbound_url_example', 'payload_version': '1.0', 'phone_number': 'phone_number_example', 'port': 'port_example', 'sasl_mechanism': 'sasl_mechanism_example', 'security_protocol': 'security_protocol_example', 'session_expiry_duration_in_milliseconds': 56, 'stream_pool_id': 'ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx', 'tenancy_name': 'tenancy_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'total_session_count': 56, 'type': 'ANDROID', 'user_name': 'user_name_example', 'webhook_url': 'webhook_url_example'}
	account_sid string	on success	The Account SID for the Twilio number. Sample: account_sid_example
	allowed_domains string	on success	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. Sample:* allowed_domains_example
	auth_error_url string	on success	The URL to redirect to when authentication is unsuccessful. Sample: auth_error_url_example
	auth_success_url string	on success	The URL to redirect to when authentication is successful. Sample: auth_success_url_example
	authentication_provider_name string	on success	The name of the Authentication Provider to use to authenticate the user. Sample: authentication_provider_name_example
	bootstrap_servers string	on success	The Oracle Streaming Service bootstrap servers. Sample: bootstrap_servers_example
	bot_id string	on success	The ID of the Skill or Digital Assistant that the Channel is routed to. Sample: ocid1.bot.oc1..xxxxxxEXAMPLExxxxxx
	category string	on success	The category of the Channel. Sample: AGENT
	channel_service string	on success	The type of OSVC service. Sample: OSVC
	client_id string	on success	The Slack Client Id for the Slack app. Sample: ocid1.client.oc1..xxxxxxEXAMPLExxxxxx
	client_type string	on success	The type of Service Cloud client. Sample: WSDL
	defined_tags dictionary	on success	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	description string	on success	A short description of the Channel. Sample: description_example
	domain_name string	on success	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. Sample: domain_name_example
	event_sink_bot_ids list / elements=string	on success	The IDs of the Skills and Digital Assistants that the Channel is routed to.
	freeform_tags dictionary	on success	Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` Sample: {'Department': 'Finance'}
	host string	on success	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. Sample: host_example
	host_name_prefix string	on success	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. Sample: host_name_prefix_example
	id string	on success	Unique immutable identifier that was assigned when the Channel was created. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	inbound_message_topic string	on success	The topic inbound messages are received on. Sample: inbound_message_topic_example
	is_authenticated_user_id boolean	on success	True if the user id in the AIC message should be treated as an authenticated user id. Sample: True
	is_client_authentication_enabled boolean	on success	Whether client authentication is enabled or not. Sample: True
	is_mms_enabled boolean	on success	Whether MMS is enabled for this channel or not. Sample: True
	lifecycle_state string	on success	The Channel's current state. Sample: CREATING
	max_token_expiration_time_in_minutes integer	on success	The maximum time until the token expires (in minutes). Sample: 56
	msa_app_id string	on success	The Microsoft App ID that you obtained when you created your bot registration in Azure. Sample: ocid1.msaapp.oc1..xxxxxxEXAMPLExxxxxx
	name string	on success	The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter. Sample: name_example
	original_connectors_url string	on success	The original connectors URL (used for backward compatibility). Sample: original_connectors_url_example
	outbound_message_topic string	on success	The topic outbound messages are sent on. Sample: outbound_message_topic_example
	outbound_url string	on success	The URL for sending errors and responses to. Sample: outbound_url_example
	payload_version string	on success	The version for payloads. Sample: 1.0
	phone_number string	on success	The Twilio phone number. Sample: phone_number_example
	port string	on success	The port. Sample: port_example
	sasl_mechanism string	on success	The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. Sample: sasl_mechanism_example
	security_protocol string	on success	The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values. Sample: security_protocol_example
	session_expiry_duration_in_milliseconds integer	on success	The number of milliseconds before a session expires. Sample: 56
	stream_pool_id string	on success	The stream pool OCI to use when connecting to the Oracle Streaming Service. Sample: ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx
	tenancy_name string	on success	The tenancy to use when connecting to the Oracle Streaming Service. Sample: tenancy_name_example
	time_created string	on success	When the resource was created. A date-time string as described in RFC 3339, section 14.29. Sample: 2013-10-20T19:20:30+01:00
	time_updated string	on success	When the resource was last updated. A date-time string as described in RFC 3339, section 14.29. Sample: 2013-10-20T19:20:30+01:00
	total_session_count integer	on success	The total session count. Sample: 56
	type string	on success	The Channel type. Sample: ANDROID
	user_name string	on success	The user name to use when connecting to the Oracle Streaming Service. Sample: user_name_example
	webhook_url string	on success	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. Sample: webhook_url_example

Authors¶

Oracle (@oracle)

oracle.oci.oci_oda_channel – Manage a Channel resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶