.svg)
miniApps
Get list of miniApps
Return the list of miniApps (the user has access to).
GET /api/miniapps/?name__iexact=<miniapp name>&group__iexact=<group name>
Query params
Request a miniApp which applies to these filters.
Name | Type | Description |
|---|---|---|
| string | The miniApp's name |
| string | The miniApp's group |
Successful status: 200 OK
Return list of miniApps.
Example:
[
{
"id": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus2.CorpusCollection.MiniApps.71a09bff46324414bdcd0377a0428ac4",
"name": "corpus2",
"type": "CorpusCollection",
"diamantAppName": "MiniApps",
"group": "ocp",
"numbers": []
},
{
"id": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus3.CorpusCollection.MiniApps.e92b6e81c15c448e9972b0e4669e18bb",
"name": "corpus3",
"type": "CorpusCollection",
"diamantAppName": "MiniApps",
"group": "ocp",
"numbers": [
{
"number": "+12244781692",
"country": "US",
"groupId": "ocp",
"miniAppId": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus3.CorpusCollection.MiniApps.e92b6e81c15c448e9972b0e4669e18bb",
"locale": "en-US"
}
]
}
]Get list of miniApps' custom properties
Return the list of miniApps' custom properties. The properties have been grouped up accordingly.
GET /api/miniapps/custom_properties/
Successful status: 200 OK
A dictionary which has as a key the property the UI sends back to the API and as a value the property attributes.
name | type | description |
|---|---|---|
| string | The property full name |
| array[string] | The DiaManT related properties, which the given key refers to |
Example:
{
"continuous_agent_requests": {
"full_name": "Continuous agent requests",
"custom_properties": [
"continuousAgentRequestsMax"
]
},
"continuous_no_responses_allowed": {
"full_name": "Continuous no responses allowed",
"custom_properties": [
"continuousNoInputsMax"
]
},
"continuous_no_interpretation_errors": {
"full_name": "Continuous no interpretation errors",
"custom_properties": [
"continuousNoMatchesMax",
"continuousSameStateEventsMax",
"continuousLowConfRejectionsMax"
]
},
"continuous_mixed_errors": {
"full_name": "Continuous mixed errors",
"custom_properties": [
"continuousErrorsMax"
]
}
}