CreateServiceCloudChannelDetails¶

class oci.oda.models.CreateServiceCloudChannelDetails(**kwargs)¶

Bases: oci.oda.models.create_channel_details.CreateChannelDetails

Properties required to create an Service Cloud channel.

Attributes

`CLIENT_TYPE_REST`	A constant which can be used with the client_type property of a CreateServiceCloudChannelDetails.
`CLIENT_TYPE_WSDL`	A constant which can be used with the client_type property of a CreateServiceCloudChannelDetails.
`TYPE_ANDROID`	str(object=’’) -> str
`TYPE_APPEVENT`	str(object=’’) -> str
`TYPE_APPLICATION`	str(object=’’) -> str
`TYPE_CORTANA`	str(object=’’) -> str
`TYPE_FACEBOOK`	str(object=’’) -> str
`TYPE_IOS`	str(object=’’) -> str
`TYPE_MSTEAMS`	str(object=’’) -> str
`TYPE_OSS`	str(object=’’) -> str
`TYPE_OSVC`	str(object=’’) -> str
`TYPE_SERVICECLOUD`	str(object=’’) -> str
`TYPE_SLACK`	str(object=’’) -> str
`TYPE_TEST`	str(object=’’) -> str
`TYPE_TWILIO`	str(object=’’) -> str
`TYPE_WEB`	str(object=’’) -> str
`TYPE_WEBHOOK`	str(object=’’) -> str
`client_type`	[Required] Gets the client_type of this CreateServiceCloudChannelDetails.
`defined_tags`	Gets the defined_tags of this CreateChannelDetails.
`description`	Gets the description of this CreateChannelDetails.
`domain_name`	[Required] Gets the domain_name of this CreateServiceCloudChannelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateChannelDetails.
`host_name_prefix`	[Required] Gets the host_name_prefix of this CreateServiceCloudChannelDetails.
`name`	[Required] Gets the name of this CreateChannelDetails.
`password`	[Required] Gets the password of this CreateServiceCloudChannelDetails.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this CreateChannelDetails.
`type`	[Required] Gets the type of this CreateChannelDetails.
`user_name`	[Required] Gets the user_name of this CreateServiceCloudChannelDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateServiceCloudChannelDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CLIENT_TYPE_REST = 'REST'¶: A constant which can be used with the client_type property of a CreateServiceCloudChannelDetails. This constant has a value of “REST”

CLIENT_TYPE_WSDL = 'WSDL'¶: A constant which can be used with the client_type property of a CreateServiceCloudChannelDetails. This constant has a value of “WSDL”

TYPE_ANDROID = 'ANDROID'¶

TYPE_APPEVENT = 'APPEVENT'¶

TYPE_APPLICATION = 'APPLICATION'¶

TYPE_CORTANA = 'CORTANA'¶

TYPE_FACEBOOK = 'FACEBOOK'¶

TYPE_IOS = 'IOS'¶

TYPE_MSTEAMS = 'MSTEAMS'¶

TYPE_OSS = 'OSS'¶

TYPE_OSVC = 'OSVC'¶

TYPE_SERVICECLOUD = 'SERVICECLOUD'¶

TYPE_SLACK = 'SLACK'¶

TYPE_TEST = 'TEST'¶

TYPE_TWILIO = 'TWILIO'¶

TYPE_WEB = 'WEB'¶

TYPE_WEBHOOK = 'WEBHOOK'¶

__init__(**kwargs)¶

Initializes a new CreateServiceCloudChannelDetails object with values from keyword arguments. The default value of the type attribute of this class is SERVICECLOUD and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this CreateServiceCloudChannelDetails.
description (str) – The value to assign to the description property of this CreateServiceCloudChannelDetails.
type (str) – The value to assign to the type property of this CreateServiceCloudChannelDetails. Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”
session_expiry_duration_in_milliseconds (int) – The value to assign to the session_expiry_duration_in_milliseconds property of this CreateServiceCloudChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateServiceCloudChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateServiceCloudChannelDetails.
domain_name (str) – The value to assign to the domain_name property of this CreateServiceCloudChannelDetails.
host_name_prefix (str) – The value to assign to the host_name_prefix property of this CreateServiceCloudChannelDetails.
user_name (str) – The value to assign to the user_name property of this CreateServiceCloudChannelDetails.
password (str) – The value to assign to the password property of this CreateServiceCloudChannelDetails.
client_type (str) – The value to assign to the client_type property of this CreateServiceCloudChannelDetails. Allowed values for this property are: “WSDL”, “REST”

client_type¶

[Required] Gets the client_type of this CreateServiceCloudChannelDetails. The type of Service Cloud client.

Allowed values for this property are: “WSDL”, “REST”

Returns:	The client_type of this CreateServiceCloudChannelDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateChannelDetails. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateChannelDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateChannelDetails. A short description of the Channel.

Returns:	The description of this CreateChannelDetails.
Return type:	str

domain_name¶

[Required] Gets the domain_name of this CreateServiceCloudChannelDetails. 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.

Returns:	The domain_name of this CreateServiceCloudChannelDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateChannelDetails. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateChannelDetails.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

host_name_prefix¶

[Required] Gets the host_name_prefix of this CreateServiceCloudChannelDetails. 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.

Returns:	The host_name_prefix of this CreateServiceCloudChannelDetails.
Return type:	str

name¶

[Required] Gets the name of this CreateChannelDetails. The Channel’s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

Returns:	The name of this CreateChannelDetails.
Return type:	str

password¶

[Required] Gets the password of this CreateServiceCloudChannelDetails. The password for the Oracle B2C Service staff member who has the necessary profile permissions.

Returns:	The password of this CreateServiceCloudChannelDetails.
Return type:	str

session_expiry_duration_in_milliseconds¶

Gets the session_expiry_duration_in_milliseconds of this CreateChannelDetails. The number of milliseconds before a session expires.

Returns:	The session_expiry_duration_in_milliseconds of this CreateChannelDetails.
Return type:	int

type¶

[Required] Gets the type of this CreateChannelDetails. The Channel type.

Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”

Returns:	The type of this CreateChannelDetails.
Return type:	str

user_name¶

[Required] Gets the user_name of this CreateServiceCloudChannelDetails. The user name for an Oracle B2C Service staff member who has the necessary profile permissions.

Returns:	The user_name of this CreateServiceCloudChannelDetails.
Return type:	str