Fetch Domain Properties by Unique Key
Returns the Domain properties for a given environment.
Endpoint
Method: GET
URL: https://uselfserve-<tenant-name>.uniphore.com/cse/connector/interactDomain/{uniqueKey}
curl -X GET
"http://localhost:9902/connector/interactDomain/U_SS_U_SS_English-US_New_Dev"
-H "accept: application/json"
-H "Authorization: Bearer <token>"Header Parameter
Authorization - Bearer <Token>
Path Parameter
Parameter Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
| String | The Unique identifier of the domain which is generated using Create or Update Domain Properties API. You can obtain the Unique Key by executing Fetch all Domain Properties Configured API. | Required |
Example Response
{
"account": "U_SS",
"applicationKey": "3a884b7e-6c94-4361-80b4-dda2382a2a74",
"defaultAsrContextGroup": "sys_yes_no",
"domain": "U_SS",
"dtmfTimeOut": 1.2,
"environmentName": "Dev",
"languages": {
"English-US_New": {
"onUnknownError": "unexpected error occurred, please try again later",
"onNoinputPrompts": [
"I didn't catch that. Can you say it again?",
"I still didn't get that. Can you speak a little louder?"
],
"onNoinputTermination": "Sorry, I'm having trouble hearing you right now. Please call back a little later. Good bye",
"onReconnect": "I'm sorry, a technical error occurred. Let me reconnect you",
"noInputTimeout": 8,
"enableBargeIn": false,
"useContextAsr": false,
"ssmlsToBeCached": [
"Thank you have a nice day",
"Let me know how can I help you ?"
],
"asrProperties": {
"url": "wss://localhost:o",
"considerOnlyFinal": true,
"bufferMultippliers": 8,
"passThreshold": 0,
"failThreshold": 0,
"worldLevelThreshold": 0,
"wordPassPercentage": 0
}
}
},
"orgId": 1,
"playWaitMessage": false,
"recordOutboundCall": false,
"sendDtmfWithPound": false,
"tenantId": "U_SS",
"virtualAgentName": "VA1",
"waitMessageUrl": "string",
"processFirstMessage": false,
"ttsTemplate": "Uniphore",
"version": "1"
}Response and Error Codes
Response Code | Condition |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
500 | Internal Sample Error |
Note: With the error codes, a summary containing the reason for failure is provided.