create-channel-create-webhook-channel-details

Description

Creates a new Channel.

Usage

oci oda management channel create-channel-create-webhook-channel-details [OPTIONS]

Required Parameters

--name [text]

The Channel’s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

--oda-instance-id [text]

Unique Digital Assistant instance identifier.

--outbound-url [text]

The URL to send responses to.

--payload-version [text]

The version for payloads.

Accepted values are:

1.0, 1.1

Optional Parameters

--bot-id [text]

The ID of the Skill or Digital Assistant that the Channel is routed to.

--defined-tags [complex type]

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--description [text]

A short description of the Channel.

--freeform-tags [complex type]

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--session-expiry-duration-in-milliseconds [integer]

The number of milliseconds before a session expires.

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/oda/management/channel/create-channel-create-webhook-channel-details.html#cmdoption-name
    export oda_instance_id=<substitute-value-of-oda_instance_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/oda/management/channel/create-channel-create-webhook-channel-details.html#cmdoption-oda-instance-id
    export outbound_url=<substitute-value-of-outbound_url> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/oda/management/channel/create-channel-create-webhook-channel-details.html#cmdoption-outbound-url
    export payload_version=<substitute-value-of-payload_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/oda/management/channel/create-channel-create-webhook-channel-details.html#cmdoption-payload-version

    oci oda management channel create-channel-create-webhook-channel-details --name $name --oda-instance-id $oda_instance_id --outbound-url $outbound_url --payload-version $payload_version