Org configuration API
Use this object to define configuration of your closer application
defaultStatusAfterLogin- status that is automatically set after agent login. Should be set to one of following values:- available
- away
- unavailable
- unready
POST - /api/orgs/{orgId}/config- Creates new form
- Requires apiKey header of an adviser with
adminpermission - Requires body with org configuration (example below):
Example
curl 'https://spinner.stage.closer.app/api/orgs/{orgID}/config' \
-X 'PUT' \
-H 'authority: spinner.closer.app' \
-H 'accept: */*' \
-H 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
-H 'content-type: application/json' \
-H 'dnt: 1' \
-H 'origin: https://closer.app' \
-H 'sec-ch-ua: "Chromium";v="106", "Google Chrome";v="106", "Not;A=Brand";v="99"' \
-H 'sec-ch-ua-mobile: ?0' \
-H 'sec-ch-ua-platform: "macOS"' \
-H 'sec-fetch-dest: empty' \
-H 'sec-fetch-mode: cors' \
-H 'sec-fetch-site: same-site' \
-H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36' \
-H 'x-api-key: bf4dd784-1277-4e32-b60e-a86a82623147' \
--data-raw $'org configuration object (JSON, see example below)' \
--compressed
{
"profanitiesCheckingEnabled": true,
"showAdviserLastNameEnabled": false,
"cobrowseEnabled": true,
"forgetMeEnabled": true,
"continueConversationOnMobileEnabled": true,
"typingPreviewEnabled": false,
"callsDisabled": false,
"defaultAgentAvatarUrl": "https://wheelhouse.stage.closer.app:443/api/resources/files/a6c50667558f457eaead583ccee2671c",
"color": "#fe7f00",
"agreement": "aaatreść klauzuli RODO?",
"name": "Wody Aqua Polska",
"allowedAttachmentExtensions": [
".jpg",
".jpeg",
".gif",
".png",
".pdf",
".txt",
".doc",
".docx",
".csv",
".xls",
".xlsx",
".ppt",
".pptx",
".key",
".odt",
".ods",
".odp"
],
"maximumAttachmentSizeBytes": 20000000,
"messageMaxAllowedCharactersForClient": 1000,
"phonePrefix": "PL",
"webSpeechApiEnabled": true,
"origin": [
"*"
],
"welcomeMessagePl": "Dzień dobry, witamy w Tutum Insurance!",
"welcomeMessageEn": "Dzień dobry, witamy w Tutum Insurance!",
"headerWelcomeMessagePl": "Wody Aqua Polska",
"headerWelcomeMessageEn": "Wody Aqua Polska",
"agreementEnabled": false,
"baseUrl": "https://piotr-dziedziczs-five-star-project.webflow.io/insurance-plans/life-insurance/",
"autoAssignedLimit": 4,
"workingHours": [
{
"offsetSeconds": -7200,
"durationSeconds": 900
},
{
"offsetSeconds": 108000,
"durationSeconds": 8100
},
{
"offsetSeconds": 165600,
"durationSeconds": 0
},
{
"offsetSeconds": 252000,
"durationSeconds": 900
},
{
"offsetSeconds": 338400,
"durationSeconds": 0
},
{
"offsetSeconds": 490500,
"durationSeconds": 20640
},
{
"offsetSeconds": 511200,
"durationSeconds": 0
}
],
"openedConversationsMetricEnabled": false,
"waitingConversationsMetricEnabled": false,
"averageResponseTimeMetricEnabled": true,
"openedConversationsSlaEnabled": true,
"waitingConversationsSlaEnabled": true,
"averageResponseTimeSlaEnabled": true,
"openedConversationsSlaRangeLowerBound": 1,
"waitingConversationsSlaRangeLowerBound": 10,
"averageResponseTimeSlaRangeLowerBound": 60000,
"openedConversationsSlaRangeUpperBound": 3,
"waitingConversationsSlaRangeUpperBound": 30,
"averageResponseTimeSlaRangeUpperBound": 300000,
"autoreassignEnabled": true,
"reportsEnabled": true,
"oauthEnabled": false,
"autoFollowOnUnassign": true,
"reassignOnLogoutEnabled": true,
"statusChangeOnCloseEnabled": false,
"snoozeOnRoomChange": false,
"autoCloseTimeoutSeconds": 120,
"autoSnoozeTimeoutSeconds": 120,
"messageMaxAllowedCharactersForAgent": 1000,
"contactEnquiryActionEnabled": true,
"meetingActionEnabled": true,
"defaultStatusAfterLogin": "unready",
"autoReassignOnWebsocketUnavailable": true
}
GET - /api/orgs/{orgId}/config- Gets org config
- Requires apiKey header of an adviser
Last modified 4mo ago