UCaaS API v1.0: Data Pool – EnableX Developer Centre

Data Pool API gives you access to different type of master database, which are used in many other API calls, e.g. Time Zones, Country Listing, Billing Plans etc.

Get Time Zones
Get Countries
Get Billing Plans

Get Time Zones

This API is used to get a list of all Time Zones.

API Route: https://api.enablex.io/ucaas/v1/timezones
HTTP Request: GET
Access Mechanism: HTTP Basic Authentication, OAauth2
Role Based Accessibility; All

Request Example (OAuth2):

GET https://api.enablex.io/ucaas/v1/timezones
Content-Type: application/json
Authorization: Token ACCESS_TOTKEN

Headers Explanation:

Content-Type: To have application/json.
Authorization: To have Token Access Information

Response Example:

{
  "result": 1,
  "timezones": [
    {
      "timezone_id": "String",
      "zone_name": "String",
      "zone_abbr": "String",
      "time_start": "String",
      "gmt_offset": "Number",
      "is_dst": "Boolean"
    }
  ]
}

Response Explanation (Only for important Object and Keys) :

Object/Key	Description
`timezones`	Object. Array of Objects. Each Object carries information of a Timezone
`timezones.timezone_id`	String. Timezone ID
`timezones.zone_name`	String. Timezone Name
`timezones.zone_abbr`	String. Timezone Abbreviation
`timezones.time_start`	String. Date/Time from which the GST Offset is applicable
`timezones.gst_offset`	Number. GMT Offset in minutes
`timezones.is_dst`	Object. true if Daylight Saving Time is applied

Note: All Date Time data in response are in UTC

Get Countries

This API is used to get a list of countris.

API Route: https://api.enablex.io/ucaas/v1/countries
HTTP Request: GET
Access Mechanism: HTTP Basic Authentication, OAauth2
Role Based Accessibility; All

Request Example (OAuth2):

GET https://api.enablex.io/ucaas/v1/countries
Content-Type: application/json
Authorization: Token ACCESS_TOTKEN

Headers Explanation:

Content-Type: To have application/json.
Authorization: To have Token Access Information

Response Example:

{
  "result": 1,
  "countries": [
    {
      "country_id": "String",
      "country_name": "String",
      "iso2_code": "String",
      "iso3_code": "String",
      "isd_code": "String"
    }
  ]
}

Response Explanation (Only for important Object and Keys) :

Object/Key	Description
`countries`	Array of Objects. Each object contains a Country information
`countries.country_id`	String. Country ID
`countries.country_name`	String. Country Name
`countries.iso2_code`	String. 2-Character ISO Code
`countries.iso3_code`	String. 3-Character ISO Code
`countries.isd_code`	String. ISD Code

Get Billing Plans

This API is used to get a list of all Billing Plans of available Applications or of given Application.

API Route: https://api.enablex.io/ucaas/v1/plans – For all Billing Plans of all Applications
API Route: https://api.enablex.io/ucaas/v1/plans/{{$APP_TYPE}} – For all Billing Plans of all Applications
HTTP Request: GET
Access Mechanism: HTTP Basic Authentication, OAauth2
Role Based Accessibility;
- Reseller (Access to Plans under the Reseller)
- Admin / Tenant (Access to Plans under the Tenant)

Request Example (OAuth2): For All Billing Plans of all Applications

GET https://api.enablex.io/ucaas/v1/plans
Content-Type: application/json
Authorization: Token ACCESS_TOTKEN

Request Example (OAuth2): For All Billing Plans of given Application

GET https://api.enablex.io/ucaas/v1/plans/wb
Content-Type: application/json
Authorization: Token ACCESS_TOTKEN

Headers Explanation:

Content-Type: To have application/json.
Authorization: To have Token Access Information

URL Placeholder Explanation:

Placeholder	Description
`APP_TYPE`	String. Type of App. Enum: `vc` (Video Conference). `wb` (Webinar)

Response Example:

{
  "result": 1,
  "plans": [
    {
      "plan_id": "String",
      "app": "String",
      "plan_name": "String",
      "currency": [
        "String"
      ],
      "status": "String",
      "settings": {
        "recording": "Boolean",
        "audio_only": "Boolean",
        "audio_video": "Boolean",
        "participants": "Integer",
        "duration": "Integer",
        "stream_qlty": "String",
        "record_qlty": "String"
      },
      "user_license": {
        "price": {
          "currency": "Float"
        },
        "price_qtr": {
          "currency": "Float"
        },
        "price_hfyr": {
          "currency": "Float"
        },
        "price_year": {
          "currency": "Float"
        }
      },
      "connect": {
        "price": {
          "currency": "Float"
        }
      },
      "records": {
        "data_unit": "Integer",
        "price": {
          "currency": "Float"
        }
      },
      "download": {
        "data_unit": "Integer",
        "price": {
          "currency": "Float"
        }
      },
      "storage": {
        "data_unit": "Integer",
        "price": {
          "currency": "Float"
        }
      }
    }
  ]
}

Response Explanation (Only for important Object and Keys) :

Object/Key	Description
`plan_id`	String. Plan ID
`status`	String. Enum: `A` (Active), `S` (Suspended)
`settings`	Object. It contains all features supported by the Plan
`user_license`	Object. It contains single user license price
`connect`	Object. It contains video connect price per minute
`records`	Object. It contains recording price per defined unit (in Minute)
`download`	Object. It contains download price per defined unit (in MB)
`storage`	Object. It contains storage price per defined unit (in MB)

Table of Contents

Get Time Zones

Get Countries

Get Billing Plans