Skip to content

Get company support config

Request

Security
Bearer
Path
companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947
Headers
x-application-idstring, (uuid)
Example:4974a66b-7493-4f41-908c-58ba81093947
curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/support-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-application-id: 4974a66b-7493-4f41-908c-58ba81093947'

Responses

OK

Bodyapplication/json
contactNumbersArray of objects(PhoneNumber)

List of support phone numbers.

emailAddressesArray of strings, unique

List of the support email addresses.

Example:
[ "support@spotnana.com" ]
freshdeskConfigobject(FreshdeskConfig)

Configuration for freshdesk.

tierstring(Tier)

Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP. Display names for other tiers are driven by the company tier configuration.

Default:"BASIC"
Enum:"BASIC""SEAT1A""TIER_2""TIER_3""TIER_4""TIER_5""TIER_6""TIER_7""TIER_8""TIER_9"
Example:"SEAT1A"
genesysConfigobject(GenesysConfig)

Configuration for genesys.

portalUrlsArray of strings, unique

List of the support portal urls.

Example:
[ "www.support.spotnana.com" ]
zendeskConfigobject(ZendeskConfig)

Configuration for zendesk.

genesysCloudConfigobject(GenesysCloudConfig)

Configuration for Genesys cloud.

twilioChatConfigobject(TwilioChatConfig)

Configuration for Twilio Chat.

cognigyChatConfigobject(CognigyChatConfig)

Cognigy Chat Config.

Response
{ "contactNumbers": [ { … } ], "emailAddresses": [ "support@spotnana.com" ], "freshdeskConfig": { "enabled": true, "hasCredentials": false, "credentials": { … } }, "tier": "SEAT1A", "genesysConfig": { "enabled": true, "dataUrl": "string" }, "portalUrls": [ "www.support.spotnana.com" ], "zendeskConfig": { "enabled": true, "integrationId": "1234567890", "androidIntegrationId": "1234567890", "iosIntegrationId": "1234567890" }, "genesysCloudConfig": { "enabled": true, "deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7", "environment": "usa-1", "genesysScriptUrl": "https://test.test.com", "clientId": "1ab2cd3efghijklmnop4qr5s6t" }, "twilioChatConfig": { "enabled": true }, "cognigyChatConfig": { "enabled": true, "scriptUrl": "https://your-cognigy-instance.com/script/abcdef123456", "initWebchatEndpoint": "https://your-cognigy-instance.com/initWebchat", "sessionTimeout": 30, "cssUrl": "https://your-server.com/css/chat.css" } }