CreateServiceCloudChannelResult

class oci.oda.models.CreateServiceCloudChannelResult(**kwargs)

Bases: oci.oda.models.create_channel_result.CreateChannelResult

The configuration for a Service Cloud agent channel.

Attributes

CATEGORY_AGENT str(object=’’) -> str
CATEGORY_APPLICATION str(object=’’) -> str
CATEGORY_BOT str(object=’’) -> str
CATEGORY_BOT_AS_AGENT str(object=’’) -> str
CATEGORY_EVENT str(object=’’) -> str
CATEGORY_SYSTEM str(object=’’) -> str
CLIENT_TYPE_REST A constant which can be used with the client_type property of a CreateServiceCloudChannelResult.
CLIENT_TYPE_WSDL A constant which can be used with the client_type property of a CreateServiceCloudChannelResult.
LIFECYCLE_STATE_ACTIVE str(object=’’) -> str
LIFECYCLE_STATE_CREATING str(object=’’) -> str
LIFECYCLE_STATE_DELETED str(object=’’) -> str
LIFECYCLE_STATE_DELETING str(object=’’) -> str
LIFECYCLE_STATE_FAILED str(object=’’) -> str
LIFECYCLE_STATE_INACTIVE str(object=’’) -> str
LIFECYCLE_STATE_UPDATING str(object=’’) -> str
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
category [Required] Gets the category of this CreateChannelResult.
client_type [Required] Gets the client_type of this CreateServiceCloudChannelResult.
defined_tags Gets the defined_tags of this CreateChannelResult.
description Gets the description of this CreateChannelResult.
domain_name [Required] Gets the domain_name of this CreateServiceCloudChannelResult.
freeform_tags Gets the freeform_tags of this CreateChannelResult.
host_name_prefix [Required] Gets the host_name_prefix of this CreateServiceCloudChannelResult.
id [Required] Gets the id of this CreateChannelResult.
lifecycle_state [Required] Gets the lifecycle_state of this CreateChannelResult.
name [Required] Gets the name of this CreateChannelResult.
session_expiry_duration_in_milliseconds Gets the session_expiry_duration_in_milliseconds of this CreateChannelResult.
time_created [Required] Gets the time_created of this CreateChannelResult.
time_updated [Required] Gets the time_updated of this CreateChannelResult.
type [Required] Gets the type of this CreateChannelResult.
user_name [Required] Gets the user_name of this CreateServiceCloudChannelResult.

Methods

__init__(**kwargs) Initializes a new CreateServiceCloudChannelResult 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.
CATEGORY_AGENT = 'AGENT'
CATEGORY_APPLICATION = 'APPLICATION'
CATEGORY_BOT = 'BOT'
CATEGORY_BOT_AS_AGENT = 'BOT_AS_AGENT'
CATEGORY_EVENT = 'EVENT'
CATEGORY_SYSTEM = 'SYSTEM'
CLIENT_TYPE_REST = 'REST'

A constant which can be used with the client_type property of a CreateServiceCloudChannelResult. This constant has a value of “REST”

CLIENT_TYPE_WSDL = 'WSDL'

A constant which can be used with the client_type property of a CreateServiceCloudChannelResult. This constant has a value of “WSDL”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'
LIFECYCLE_STATE_CREATING = 'CREATING'
LIFECYCLE_STATE_DELETED = 'DELETED'
LIFECYCLE_STATE_DELETING = 'DELETING'
LIFECYCLE_STATE_FAILED = 'FAILED'
LIFECYCLE_STATE_INACTIVE = 'INACTIVE'
LIFECYCLE_STATE_UPDATING = 'UPDATING'
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 CreateServiceCloudChannelResult 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:
  • id (str) – The value to assign to the id property of this CreateServiceCloudChannelResult.
  • name (str) – The value to assign to the name property of this CreateServiceCloudChannelResult.
  • description (str) – The value to assign to the description property of this CreateServiceCloudChannelResult.
  • category (str) – The value to assign to the category property of this CreateServiceCloudChannelResult. Allowed values for this property are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • type (str) – The value to assign to the type property of this CreateServiceCloudChannelResult. Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • session_expiry_duration_in_milliseconds (int) – The value to assign to the session_expiry_duration_in_milliseconds property of this CreateServiceCloudChannelResult.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateServiceCloudChannelResult. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_created (datetime) – The value to assign to the time_created property of this CreateServiceCloudChannelResult.
  • time_updated (datetime) – The value to assign to the time_updated property of this CreateServiceCloudChannelResult.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateServiceCloudChannelResult.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateServiceCloudChannelResult.
  • domain_name (str) – The value to assign to the domain_name property of this CreateServiceCloudChannelResult.
  • host_name_prefix (str) – The value to assign to the host_name_prefix property of this CreateServiceCloudChannelResult.
  • user_name (str) – The value to assign to the user_name property of this CreateServiceCloudChannelResult.
  • client_type (str) – The value to assign to the client_type property of this CreateServiceCloudChannelResult. Allowed values for this property are: “WSDL”, “REST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
category

[Required] Gets the category of this CreateChannelResult. The category of the Channel.

Allowed values for this property are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The category of this CreateChannelResult.
Return type:str
client_type

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

Allowed values for this property are: “WSDL”, “REST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The client_type of this CreateServiceCloudChannelResult.
Return type:str
defined_tags

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

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

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

Returns:The description of this CreateChannelResult.
Return type:str
domain_name

[Required] Gets the domain_name of this CreateServiceCloudChannelResult. 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 CreateServiceCloudChannelResult.
Return type:str
freeform_tags

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

Returns:The freeform_tags of this CreateChannelResult.
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 CreateServiceCloudChannelResult. 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 CreateServiceCloudChannelResult.
Return type:str
id

[Required] Gets the id of this CreateChannelResult. Unique immutable identifier that was assigned when the Channel was created.

Returns:The id of this CreateChannelResult.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this CreateChannelResult. The Channel’s current state.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this CreateChannelResult.
Return type:str
name

[Required] Gets the name of this CreateChannelResult. 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 CreateChannelResult.
Return type:str
session_expiry_duration_in_milliseconds

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

Returns:The session_expiry_duration_in_milliseconds of this CreateChannelResult.
Return type:int
time_created

[Required] Gets the time_created of this CreateChannelResult. When the resource was created. A date-time string as described in RFC 3339, section 14.29.

Returns:The time_created of this CreateChannelResult.
Return type:datetime
time_updated

[Required] Gets the time_updated of this CreateChannelResult. When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Returns:The time_updated of this CreateChannelResult.
Return type:datetime
type

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

Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

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