[Index]

Model: relation/CustomerBuild-AddCiscoWebexApp-WFC_REL

CustomerBuild-AddCiscoWebexApp-WFC_REL

Model Details: relation/CustomerBuild-AddCiscoWebexApp-WFC_REL

Title Description Details
Name *
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Relation Spark Customer
  • Field Name: relation_SparkCustomer.[n]
  • Type: Array
  • Cardinality: [0..1]
Customer Name * Name of this customer
  • Field Name: relation_SparkCustomer.[n].name
  • Type: String
  • MaxLength: 1024
Wholesale Customer Select this option if the customer is a wholesale customer.
  • Field Name: relation_SparkCustomer.[n].wholesale_status
  • Type: Boolean
Contact Center Customer Select this option if the customer is a Webex Contact Center customer.
  • Field Name: relation_SparkCustomer.[n].webex_contact_center
  • Type: Boolean
Contact Center Region Select an option in the following list to map the API endpoints for your region.
  • Field Name: relation_SparkCustomer.[n].base_url_setting
  • Type: String
  • MaxLength: 1024
Organization Account Number This can be found when logging into the Webex Control Hub portal under the Account menu. E.g. 000fd0e4-83ef-d398-be23-d06998580fed
  • Field Name: relation_SparkCustomer.[n].account_number_external
  • Type: String
  • MaxLength: 1024
Admin Account Email This is the email address of the account used to generate the access token.
  • Field Name: relation_SparkCustomer.[n].account_email
  • Type: String
  • MaxLength: 1024
Organization Account Number (Internal) This is the internal API id for the organization. This is automatically resolved from the external account number.
  • Field Name: relation_SparkCustomer.[n].account_number
  • Type: String
  • MaxLength: 1024
Default Calling Behaviour This is the default calling behaviour for the organization.
  • Field Name: relation_SparkCustomer.[n].default_calling_behaviour
  • Type: String
  • MaxLength: 1024
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app", "Third-Party app"]
Email Domain for Hybrid Calling in Workspaces This is the email domain that will be used when creating a Unified CM user associated with a Workspace in Webex App Control Hub for hybrid calling.
  • Field Name: relation_SparkCustomer.[n].email_domain
  • Type: String
  • MaxLength: 1024
Directory Synchronization Enabled This setting must be enabled if the Organization has been enabled for Directory Synchronization on the Webex Control Hub side.
  • Field Name: relation_SparkCustomer.[n].dirsync_enabled
  • Type: Boolean
Please Note Field to display notes to the user.
  • Field Name: relation_SparkCustomer.[n].notes
  • Type: String
  • MaxLength: 1024
Authorize Webex This is the link to initiate the Webex OAuth flow to obtain tokens.
  • Field Name: relation_SparkCustomer.[n].token_link
  • Type: String
  • MaxLength: 32768
  • Format: link
Admin Access Token This is the Access Token provided when logging into Webex App Developer portal. This token is valid for 14 days. The Refresh token can be used to generate a new Access Token.
  • Field Name: relation_SparkCustomer.[n].token
  • Type: String
  • Is Password: True
  • MaxLength: 1024
Refresh Token This is the Refresh Token provided when logging into Webex App Developer portal. This token will be used to create a new access token. The refresh token is valid for 90 dyas.
  • Field Name: relation_SparkCustomer.[n].refresh_token
  • Type: String
  • Is Password: True
  • MaxLength: 1024
Access Token Expires At Time when the Access Token will expire.
  • Field Name: relation_SparkCustomer.[n].access_token_expires
  • Type: String
  • MaxLength: 1024
Refresh Token Expires At Time when the Refresh Token will expire.
  • Field Name: relation_SparkCustomer.[n].refresh_token_expires
  • Type: String
  • MaxLength: 1024
HTTP Proxy Specifies an outbound internet proxy server for HTTP traffic to the public Internet. The format should be (http(s)://[user:password]@host:port). Note that this is the location of the proxy and the URL scheme is not necessarily "http" just because the traffic being forwarded to it is HTTP traffic. Please consult the administrator of the proxy server for the correct URL. Special characters in either the user or password must be URL encoded.
  • Field Name: relation_SparkCustomer.[n].http_proxy
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 1024
HTTPS Proxy Specifies an outbound internet proxy server for HTTPS traffic to the public Internet. The format should be (http(s)://[user:password]@host:port). Note that this is the location of the proxy and the URL scheme is not necessarily "https" just because the traffic being forwarded to it is HTTPS traffic. Please consult the administrator of the proxy server for the correct URL. Special characters in either the user or password must be URL encoded.
  • Field Name: relation_SparkCustomer.[n].https_proxy
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 1024
Sync on Create Sync this organization's roles and licenses from Control Hub on creation.
  • Field Name: relation_SparkCustomer.[n].sync
  • Type: Boolean
Wholesalecustomer
  • Field Name: wholesalecustomer.[n]
  • Type: Array
  • Cardinality: [0..1]
Id
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].id
  • Type: String
  • MaxLength: 1024
Org ID
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].orgId
  • Type: String
  • MaxLength: 1024
Org Name
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].orgName
  • Type: String
  • MaxLength: 1024
External Id
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].externalId
  • Type: String
  • MaxLength: 1024
Address
  • Field Name: address
  • Type: Object
Address Line 1
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].address.addressLine1
  • Type: String
  • MaxLength: 1024
Address Line 2
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].address.addressLine2
  • Type: String
  • MaxLength: 1024
City
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].address.city
  • Type: String
  • MaxLength: 1024
State or Province
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].address.stateOrProvince
  • Type: String
  • MaxLength: 1024
ZIP or Postal Code
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].address.zipOrPostalCode
  • Type: String
  • MaxLength: 1024
Country
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].address.country
  • Type: String
  • MaxLength: 1024
Status
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].status
  • Type: String
  • MaxLength: 1024
Packages
  • Field Name: packages.[n]
  • Type: Array
Resource Details
  • Field Name: resourceDetails
  • Type: Object
Packages
  • Field Name: packages.[n]
  • Type: Array
Name
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].resourceDetails.packages.[n].name
  • Type: String
  • MaxLength: 1024
Status
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].resourceDetails.packages.[n].status
  • Type: String
  • MaxLength: 1024
Warnings
  • Field Name: warnings.[n]
  • Type: Array
errorCode
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].resourceDetails.packages.[n].warnings.[n].errorCode
  • Type: Integer
description
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].resourceDetails.packages.[n].warnings.[n].description
  • Type: String
  • MaxLength: 1024
Errors
  • Field Name: errors.[n]
  • Type: Array
errorCode
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].resourceDetails.packages.[n].errors.[n].errorCode
  • Type: Integer
description
  • Field Name: relation_SparkCustomer.[n].wholesalecustomer.[n].resourceDetails.packages.[n].errors.[n].description
  • Type: String
  • MaxLength: 1024