Fetch Tenant Details

This API is based on Unified Contact Analytics Processor (UCAP) module which returns the list of organizations and categories created for the tenant. This API requires an additional instance of the application components c5.2xlarge. This means that if N number of machines are in use, then one additional machine is required. For e.g., if four machines are in use, then 4+1 (5) machines are required.

The details are as follows:

Organization (orgid and orgname)
Categories (catid and catname)

Endpoint

Method: GET

URL: /v1/tenant/info

Header Parameter

Authorization - Bearer <Token>
Authorization - X-USER-ID

Sample Request

curl --location --request GET 
'http://localhost:3130/v1/tenant/info' \
--header'X-User-Id: 1' \
--header 'Authorization: Bearer 1234567890'

Sample Response

{
    "tenant-id": 1,
    "tenant-name": "japanese_org",
    "organizations": [
        {
            "organization-id": 3,
            "organization-name": "Transcript_process",
            "categories": [
                {
                    "category-id": 3,
                    "category-name": "tbr_stereo"
                },
                {
                    "category-id": 47,
                    "category-name": "mono_sd_on"
                }
            ]
        },
        {
            "organization-id": 4,
            "organization-name": "test_demo",
            "categories": [
                {
                    "category-id": 9,
                    "category-name": "stereotest"
                }
            ]
        }
    ]
}

Response and Error Codes

Code	Response
200	OK
401	{“reason”: "Authorization failed"}
500	Internal Server Error

In this section:

Uniphore Customer Portal