Data Structure for Channel Provider

Attribute Name

Base Type

Restrictions

Description

type

string

minOccurs = 1

maxOccurs = 1

nillable = false

Enumeration = email

Type of contact channel.

fqdn

string

minOccurs = 1

maxOccurs = 1

nillable = false

Regex = (?=^.{1,255}$)
(^(((?!-)[a-zA-Z0-9-]{1,63}
(?<!-))|((?!-)[a-zA-Z0-9-]
{1,63}(?<!-)\.)+[a-zA-Z]{2,63})$)

Fully qualified domain name (FQDN) of the channel provider. FQDN is a combination of the channel server hostname and domain name. Do not enter the IP address.

Example:

host.example.com

protocol

string

minOccurs = 1

maxOccurs = 1

nillable = false

Enumeration

  • IMAP for receiving

  • SMTP for sending

Protocol that is used to communicate with the channel provider.

port

int

minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1

maxInclusive = 65535

Valid 16-bit port number on the channel provider to establish communication.

description

string

minOccurs = 0

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 100

Description can contain up to 100 UTF-8 characters.

Description of the channel provider. This field is optional .

proxyType

string

socks or none

default = none

Regex = [Ss][Oo]
[Cc][Kk][Ss]|[Nn][Oo][Nn][Ee]

Determines if socks proxy should be used to connect to the channel provider server.

useHttpProxy

boolean

default = false

Determines if http proxy should be used to connect to OAuth service provider of the configured channel provider server.

mailserverType

string

minOccurs = 0

maxOccurs = 1

default = microsoft

Regex = gmail|microsoft|microsoftO365

Determines the type of the mail server.

Note

To configure IMAP folder values, see imapFolderConfig in the Cisco Customer Collaboration Platform Developer Guide available at, https://developer.cisco.com/site/socialminer/documentation/.