UCaaS API Routes

The UCaaS API provides the following Collections & Routes:

Provisioning Access API

The Provisioning Access APIs are covers creation of OAUTH2 Access Token and other APIs needed before accessing Portal e.g. Password Reset Options etc.

Supported Authentication Mechanism

The Provisioning Access API supports two types of authentication mechanisms: HTTP Basic Authentication and OAuth2. You can choose a mechanism that best suits your needs.

• HTTP Basic Authentication: For authenticating the server-to-server API calls where each API call is validated through the authentication header. This mechanism suits best to integrate EnableX with the server-side code. The API access credentials must be saved on the server and used for server-to-server calling. For more information, see Authentication.

• OAuth2: For authenticating the client-to-server API calls with limited access token. Applictaion developers must call a "Login" route to obtain the access token that will be used for subsequent API calls. As the access token expires in 20 minutes, developers must call the "Login" route again to obtain a fresh access token for subsequent API access. For more information, see Authentication.

Get Access Token

This API returns an access token and user information for a specified user's access credentials using which other APIs that support OAuth2 can be called. The access token expires in 15 minutes from the time it is created. Therefore, another access token must be created before calling other APIs.

This API call does not require access credentials.

• API Route: https://api.enablex.io/ucaas/v1/login
• HTTP Request: POST

Example Request

POST https://api.enablex.io/ucaas/v1/login
Content-Type: application/json
X-Api-Id: String

{
  "email": "[email protected]",
  "password": "XOXO"
}

Explanation of Headers

• Content-Type: application/json. Indicates that the request body format is JSON.
• X-Api-Id: API Access ID. Get this information from the EnableX portal.

Explanation of Raw Body JSON Payload

Example Response

{
  "result": 1,
  "token": "String",
  "user": {
    "user_id": "",
    "user_type": "",
    "user_type_desc": "",
    "email": "",
    "first_name": "",
    "middle_name": "",
    "last_name": "",
    "profile_pic": "",
    "company": {
      "company_id": "Object ID",
      "company_name": "String",
      "company_legal_name": "String"
    },
    "apps": {
      "vc": {
        "access": "Boolean",
        "status": "String",
        "wef": "Date"
      },
      "wb": {
        "access": "Boolean",
        "status": "String",
        "wef": "Date"
      }
    },
    "timezone": {
      "timezone_id": "",
      "zone_name": "",
      "zone_abbr": "",
      "time_start": "",
      "gmt_offset": "",
      "is_dst": ""
    },
    "last_login_time": "",
    "profile_domain": ""
  }
}

Explanation of Response (for important objects and keys only)

Note: All date and time data in the response are in the UTC format.

Get Password Reset Link

This API provides a Password Reset link. This link is sent to the registered email address of a user if the user has forgotten password. To reset the password, the user must follow the instructions provided in the email.

This API call does not require access credentials.

• API Route: https://api.enablex.io/ucaas/v1/password
• HTTP Request: POST

Example Request

POST `https://api.enablex.io/ucaas/v1/password`
Content-Type: `application/json`
X-Api-Id: String

{	"email": "[email protected]"
}

Explanation of Headers

• Content-Type: application/json. Indicates that the request body format is JSON.
• X-Api-Id: API Access ID. Get this information from the EnableX portal.

Explanation of Raw Body JSON Payload

Example Response

{	"result": 1
	"data": {
		"email": "[email protected]",
		"msg": "An email has been set to user@yourdomain with instructions to reset the password."
	}
}

Validate Password Reset Key

This API validates the Password Reset key and obtains the user information to reset the user's password.

This API call does not require access credentials.

• API Route: https://api.enablex.io/ucaas/v1/password/{{$RESET_KEY}}
• HTTP Request: POST

Example Request

PATCH https://api.enablex.io/ucaas/v1/password/{{$RESET_KEY}}
Content-Type: `application/json` 
X-Api-Id: String

Explanation of Headers

• Content-Type: application/json. Indicates that the request body format is JSON.
• X-Api-Id: API Access ID. Get this information from the EnableX portal.

Explanation of URL Placeholder

Example Response

{	"result": 1
	"data": {
		"email": "[email protected]",
		"user_id": "",
		"first_name": "",
		"middle_name": "",
		"last_name": ""
	}
}

Reset Password

This API resets a user's password with a Reset key. The Reset Key is delivered to the user's registered email address with instructions to reset the password. For more information, see Get Password.

This API call does not require access credentials.

• API Route: https://api.enablex.io/ucaas/v1/password/{{$RESET_KEY}}
• HTTP Request: POST

Example Request

PATCH https://api.enablex.io/ucaas/v1/password/XOXOXO
Content-Type: `application/json` 
X-Api-Id: String

{	"email": "[email protected]",
	"password": "",
	"password_retyped": ""
}

Explanation of Headers

• Content-Type: application/json. Indicates that the request body format is JSON.
• X-Api-Id: API Access ID. Get this information from the EnableX portal.

Explanation of URL Placeholder

Explanantion of Raw Body JSON Payload

Example Response

{	"result": 1
	"data": {
		"email": "[email protected]",
		"msg": "Your account password has been reset."
	}
}

Video Session Access API

Use the Video Session APIs for accessing Video Meeting and Webinar sessions and in-session tools.

Join a Session

Use this API to authenticate a PIN for a meeting room. If the user is authenticated, the API provides the user access to the video meeting. This API call does not require access credentials.

API Accessibility: Any user joining the call as a host or a participant.

• API Route: https://api.enablex.io/ucaas/v1/session/join
• HTTP Request: POST Request Example:

POST https://api.enablex.io/ucaas/v1/sessions/join
Content-Type: application/json
X-Api-Id: String

{
  "pin": "String",
  "name": "string",
  "user_ref": "string"
}

Explanation of Headers

• Content-Type: application/json. Indicates that the request body format is JSON.
• X-Api-Id: API Access ID. Get this information from the EnableX portal.

Explanation of Raw Body JSON Payload

Example Response

{
  "result": 1,
  "token": "String",
  "user": {
    "meeting_id": "String",
    "customer_id": "String",
    "room_id": "String",
    "role": "String",
    "user_id": "String",
    "first_name": "String",
    "middle_name": "String",
    "last_name": "String",
    "email": "String",
    "profile_pic": "String"
  }
}

Explanation of Response (only for important objects and keys)

Error Codes

Invite Others to Join An Ongoing Session

Use this API to invite others by email to join an ongoing session. The email is sent with the Participant PIN and a direct URL to join the session.

API Accessibility: Any user joining the call as a host or a participant.

• API Route: https://api.enablex.io/ucaas/v1/sessions/invite
• HTTP Request: POST

Example Request

POST POST https://api.enablex.io/ucaas/v1/sessions/invite
Content-Type: application/json
X-Api-Id: String

{	"pin": "String",
	"room_id": "String",
	"meeting_id": "String", 
	"invitees": [ "String" ]
}

Explanation of Headers

• Content-Type: application/json. Indicates that the request body format is JSON.
• X-Api-Id: API Access ID. Get this information from the EnableX portal.

Explanation of Raw Body JSON Payload

Note: One of these is required: pin or room_id or meeting_id.

Example Response

{
  "result": 1,
  "desc": "Invitation email has been sent."
}

Error Codes

Get Branding Information

Use this API to get branding information for a domain, customer, and against a meeting setup.

• If the API is called only with the domain name, the domain specific branding information is returned.

• If the API is called with Customer ID, the branding information is overwritten by the customization done at the customer level.

• If the API is called with Meeting ID, then the branding information is overwritten by the customization done at the meeting level.

• API Route: https://api.enablex.io/ucaas/v1/branding

• HTTP Request: GET

Example Request (With Domain)

GET https://api.enablex.io/ucaas/v1/branding/?domain={{$DOMAIN}}
Content-Type: application/json
X-Api-Id: String

Explanation of Headers

• Content-Type: application/json. Indicates that the request body format is JSON.
• X-Api-Id: API Access ID. Get this information from the EnableX portal.

Query String Variables

Note: You can use any variable or all variables in single API call. Ensure that at least one variable is used in Query String.

Example Response for Video Meeting Application

{
  "result": 1,
  "vc": {
    "enabled": true,
    "name": "String",
    "url": "String",
    "logo": "String",
    "logo_inner": "String",
    "logo_icon": "String",
    "favicon": "String",
    "desc": "String",
    "exit_url": "String",
    "copyright": "String",
    "login_page": {
      "heading": "String",
      "content": "String"
    },
    "fields": [
      {
        "label": "String",
        "type": "String",
        "length": "Number",
        "required": "Boolean",
        "id": "Boolean",
        "order": "Number",
        "messages": {
          "required": "String",
          "email": "String"
        }
      }
    ],
    "email": {
      "from_email": "String",
      "from_name": "String",
      "replyto_email": "String",
      "template": "String"
    },
    "tos": {
      "enabled": "Boolean",
      "terms_url": "String",
      "privacy_url": "String"
    },
    "credits": {
      "enabled": "Boolean",
      "name": "String",
      "logo_url": "String",
      "target_url": "String"
    },
    "options": {
      "live_streaming": "Boolean",
      "screenshare": "Boolean",
      "whiteboard": "Boolean"
    },
    "api": {
      "referrer_check": "Boolean",
      "referrer_domain": "String",
      "user_ref_check": "Boolean"
    }
  }
}

Explanation of Response (For important objects and keys only)

Note: Both vc and wb objects are displayed if the same domain is used for webinar and video meeting.

Customer Management API

Use the Customer Management APIs for adding new customers, and for listing, searching, editing, and deleting existing customers.

These APIs support two access mechanisms: HTTP Basic Authentication and OAuth2. Choose the mechanism that best suits your needs. In most cases, codes are shown with the OAuth2 access token.

Get Customer Information

Use this API to obtain customer information for a given Customer Id.

• API Route: https://api.enablex.io/ucaas/v1/customers/{{$CUSTOMER_ID}}
• HTTP Request: GET
• Access Mechanism: HTTP Basic Authentication, OAauth2
• Role Based Accessibility
  • Reseller: Can access customer information under the reseller.
  • Admin/Tenant: Can access information of resellers and customers.

Request Example (OAuth2):

GET https://api.enablex.io/ucaas/v1/customers/{{$CUSTOMER_ID}}
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

Request Example (HTTP Basic Authentication)

GET https://api.enablex.io/ucaas/v1/customers/{{$CUSTOMER_ID}}
Content-Type: `application/json` 
Authorization: Basic BASE64_AUTH_STRING

Explanation of Headers

• Content-Type: application/json : Indicates that the request body format is JSON.
• Authorization: Contains the token access information for authentication.

Explanation of URL Placeholder

Example Response

{
  "result": 1,
  "customer": {
    "customer_id": "String",
    "customer_name": "String",
    "customer_legal_name": "String",
    "customer_code": "String",
    "customer_type": "String",
    "customer_type_ex": "String",
    "individual": "Boolean",
    "contact_name": "String",
    "contact_email": "String",
    "status": "String",
    "status_ex": "String",
    "office_address": {
      "address_1": "String",
      "address_2": "String",
      "address_3": "String",
      "city": "String",
      "state": "String",
      "country": "String",
      "zipcode": "String",
      "country_id": "String"
    },
    "billing_address": {
      "address_1": "String",
      "address_2": "String",
      "address_3": "String",
      "city": "String",
      "state": "String",
      "country": "String",
      "zipcode": "String",
      "country_id": "String"
    },
    "track": {
      "added": "Date",
      "modified": "Date",
      "activated": "Date",
      "suspended": "Date",
      "closed": "Date"
    }
  }
}

Explanation of Response (For important objects and keys)

Note: All date and time data in the response are in the UTC format.

Search and get a list of Customers

Use this API to get a paginated list of customers. The API provides various filtering and sorting options.

• API Route: https://api.enablex.io/ucaas/v1/customers
• HTTP Request: GET
• Access Mechanism: HTTP Basic Authentication, OAauth2
• Filters & Sorting: Options passed as a query string to the API route.
• Role Based Accessibility
  • Reseller: Can access customer information under the reseller.
  • Admin/Tenant: Can access information of resellers and customers.

Example Request (OAuth2) A simple call to get the first page of the customer list.

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

Request Example (OAuth2): Request with Paging, Filter and Sorting Options as Query String

GET https://api.enablex.io/ucaas/v1/customers?page={{$PAGE_NUM}}&search_by=status&search_string=A
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

Explanation of URL Query String Variable

Example Response

{
  "result": 1,
  "search": {
    "page": "Number",
    "page_length": "Number",
    "from_join_dt": "Date",
    "to_join_dt": "Date",
    "search_by": "String",
    "search_string": "String",
    "order_by": "String",
    "order_qualify": "String"
  },
  "customers": [
    {
      "customer_id": "String",
      "customer_name": "String",
      "customer_legal_name": "String",
      "customer_code": "String",
      "customer_type": "String",
      "customer_type_ex": "String",
      "individual": "Boolean",
      "contact_name": "String",
      "contact_email": "String",
      "status": "String",
      "status_ex": "String",
      "office_address": {
        "address_1": "String",
        "address_2": "String",
        "address_3": "String",
        "city": "String",
        "state": "String",
        "country": "String",
        "zipcode": "String",
        "country_id": "String"
      },
      "billing_address": {
        "address_1": "String",
        "address_2": "String",
        "address_3": "String",
        "city": "String",
        "state": "String",
        "country": "String",
        "zipcode": "String",
        "country_id": "String"
      },
      "track": {
        "added": "Date",
        "modified": "Date",
        "activated": "Date",
        "suspended": "Date",
        "closed": "Date"
      }
    }
  ]
}

Explanation of Response (For important objects and keys)

Note: All date and time data in the response is in the UTC format.

Add a New Customer

Use this API to add a new customer.

• API Route: https://api.enablex.io/ucaas/v1/customers

• HTTP Request: POST

• Access Mechanism: HTTP Basic Authentication, OAauth2

• Role Based Accessibility

  • Reseller: Has access to add new customers under the reseller.
  • Admin/Tenant: Has access to add new customers or resellers under the tenant.

Request Example (OAuth2):

POST https://api.enablex.io/ucaas/v1/customers
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

{
  "customer_name": "String",
  "customer_legal_name": "String",
  "customer_code": "String",
  "individual": "Boolean",
  "contact_name": "String",
  "contact_email": "String",
  "office_address": {
    "address_1": "String",
    "address_2": "String",
    "address_3": "String",
    "city": "String",
    "state": "String",
    "country": "String",
    "zipcode": "String",
    "country_id": "String"
  },
  "billing_address": {
    "address_1": "String",
    "address_2": "String",
    "address_3": "String",
    "city": "String",
    "state": "String",
    "country": "String",
    "zipcode": "String",
    "country_id": "String"
  }
}

Explanation of JSON Payload

Example Response

{
  "result": 1,
  "msg": "$customer_name has been added.",
  "customer": {
    "customer_id": "String",
    "customer_name": "String"
  },
  "portal_access": {
    "url": "String",
    "username": "String",
    "password": "String"
  }
}

Explanation of Response (only for important objects and keys)

Edit Customer Information

Use this API to edit customer information. All keys in the JSON payload are optional. Use only the key that you want to edit.

• API Route: https://api.enablex.io/ucaas/v1/customers/{{$CUSTOMER_ID}}
• HTTP Request: PATCH
• Access Mechanism: HTTP Basic Authentication, OAauth2
• Role Based Accessibility
  • Reseller: Has access to add new customers under the reseller.
  • Admin/Tenant: Has access to add new customers or resellers under the tenant.

Request Example (OAuth2)

PATCH https://api.enablex.io/ucaas/v1/customers/{{$CUSTOMER_ID}}
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

{
  "customer_name": "String",
  "customer_legal_name": "String",
  "customer_code": "String",
  "individual": "Boolean",
  "contact_name": "String",
  "contact_email": "String",
  "office_address": {
    "address_1": "String",
    "address_2": "String",
    "address_3": "String",
    "city": "String",
    "state": "String",
    "country": "String",
    "zipcode": "String",
    "country_id": "String"
  },
  "billing_address": {
    "address_1": "String",
    "address_2": "String",
    "address_3": "String",
    "city": "String",
    "state": "String",
    "country": "String",
    "zipcode": "String",
    "country_id": "String"
  },
  "timezone_id": "String"
}

Explanation of JSON Payload

Example Response

{
  "result": 1,
  "msg": "$customer_name has been updated.",
  "customer": {
    "customer_id": "String",
    "customer_name": "String"
  }
}

Response Explanation (only for important objects and keys)

Error Codes

Subscription Management API

Use this API for adding new subscriptions, and for listing and updating existing subscriptions.

Get Subscription Information

Use this API to get information about a specific Subscription ID.

• API Route: https://api.enablex.io/ucaas/v1/subscriptions/{{$SUBSCRIPTION_ID}}
• HTTP Request: GET
• Role Based Accessibility:
  • Reseller Admin: Can access the subscription of any customer under the reseller.
  • EnableX Admin: Can access the subscription of any customer under EnableX.

Request Example (OAuth2):

GET https://api.enablex.io/ucaas/v1/subscriptions/{{$SUBSCRIPTION_ID}}
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

Example Response

{
  "result": 1,
  "subscription": {
    "subscription_id": "String",
    "customer_id": "String",
    "plan_id": "String",
    "app_const": "String",
    "plan_name": "String",
    "settings": {
      "recording": "Boolean",
      "audio_only": "Boolean",
      "audio_video": "Boolean",
      "participants": "Integer",
      "duration": "Integer",
      "stream_qlty": "String",
      "record_qlty": "String"
    },
    "subscription": {
      "base": "String",
      "base_ex": "String",
      "trial": "Boolean",
      "allow_meeting_overlap": "Boolean",
      "prepaid": "Boolean",
      "postpaid": "Boolean",
      "subsxn_date": "Date",
      "expiry_date": "String",
      "currency": "String",
      "status": "String",
      "status_ex": "String"
    },
    "features": {
      "screenshare": "Boolean",
      "whiteboard": "Boolean",
      "livestreaming": "Boolean"
    },
    "user_license": {
      "qty": "Number",
      "unit_price": {
        "currency": "Float"
      },
      "total_price": {
        "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"
      }
    }
  }
}

Get the Subscription List

Use this API to get a list of all the subscriptions.

• API Route: https://api.enablex.io/ucaas/v1/subscriptions?page={{$PAGE_NUM}}
• HTTP Request: GET
• Role Based Accessibility:
• Reseller Admin: Can access the subscription of any customer under reseller.
• EnableX Admin: Can access the subscription of any customer under EnableX.
• Reseller Customer, EnableX Direct Customer: Can access own subscription information only.

Request Example (OAuth2):

GET https://api.enablex.io/ucaas/v1/subscriptions?page={{$PAGE_NUM}}
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

Explanation of Query String Parameters

Example Response

{
  "result": 1,
  "search": {
    "page": "Number",
    "page_length": "Number",
    "customer_id": "Number",
    "from_subxn_dt": "Date",
    "to_subxn_dt": "Date",
    "from_ex[oru_dt": "Date",
    "to_expiry_dt": "Date",
    "search_by": "String",
    "search_string": "String",
    "order_by": "String",
    "order_qualify": "String"
  },
  "subscriptions": [
    {
      "subscription_id": "String",
      "customer_id": "String",
      "plan_id": "String",
      "app_const": "String",
      "plan_name": "String",
      "settings": {
        "recording": "Boolean",
        "audio_only": "Boolean",
        "audio_video": "Boolean",
        "participants": "Integer",
        "duration": "Integer",
        "stream_qlty": "String",
        "record_qlty": "String"
      },
      "subscription": {
        "base": "String",
        "base_ex": "String",
        "trial": "Boolean",
        "allow_meeting_overlap": "Boolean",
        "prepaid": "Boolean",
        "postpaid": "Boolean",
        "subsxn_date": "Date",
        "expiry_date": "String",
        "currency": "String",
        "status": "String",
        "status_ex": "String"
      },
      "features": {
        "screenshare": "Boolean",
        "whiteboard": "Boolean",
        "livestreaming": "Boolean"
      },
      "user_license": {
        "qty": "Number",
        "unit_price": {
          "currency": "Float"
        },
        "total_price": {
          "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"
        }
      }
    }
  ]
}

Add a New Subscription

Use this API to add a new customer.

• API Route: https://api.enablex.io/ucaas/v1/subscriptions

• HTTP Request: POST

• Role Based Accessibility:

  • EnableX Admin: Can access the subscription of any customer under EnableX.

Request Example (OAuth2):

POST https://api.enablex.io/ucaas/v1/subscriptions
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

{
  "customer_id": "String",
  "plan_id": "String",
  "room_type": "String",
  "title": "String",
  "subscription": {
    "unit_price": "float",
    "no_of_license": "Number",
    "allow_meeting_overlap": "Boolean",
    "payment_cycle": "String",
    "payment_mode": "String",
    "po": "String",
    "prepaid": "Boolean",
    "subsxn_date": "Date"
  }
}

Explanation of Raw Body JSON Payload

Example Response

{
  "result": 1,
  "msg": "#customer_name has subscribed to plan: #plan_name (For #app). User license: #qty.",
  "subscription": {
    "subscription_id": "String",
    "customer_id": "String",
    "customer_name": "String",
    "plan_id": "String",
    "plan_name": "String",
    "qty": "Number"
  }
}

Update a Subscription

Use this API to update the Plan Subscription information. All keys in the JSON payload are optional. Use only the key that you want to edit.

• API Route: https://api.enablex.io/ucaas/v1/subscriptions/{{$SUBSCRIPTION_ID}}
• HTTP Request: PATCH
• Role Based Accessibility:
  • EnableX Admin: Can access the subscription of any customer under EnableX.

Request Example (OAuth2):

PATCH https://api.enablex.io/ucaas/v1/subscriptions/{{$SUBSCRIPTION_ID}}
Content-Type: `application/json` 
Authorization: Token ACCESS_TOTKEN

{
      "subscription": {
			"status": "String"
      }
}

Explanation of Raw Body JSON Payload

Example Response

{
	"result": 1,
	"msg": "Subscription information for #customer_name is updated for plan: #plan_name (For #app).",
	"subscription": {
		"subscription_id": "String",
		"customer_id": "String",
		"customer_name": "String",
		"plan_id": "String",
		"plan_name": "String",
		"qty": "Number"
	}
}

Error Codes

User Management API

Use the User Management APIs for the performing user management tasks such as adding users, listing users, updating user information, and revoking application licenses from users.

Add a User

Use this API to add a new user.

• API Route: https://api.enablex.io/ucaas/v1/users
• HTTP Request: POST
• Role Based Accessibility:
  • Reseller Admin: Can access users under the reseller and all customers under it.
  • EnableX Admin: Can access users of any reseller/customer under EnableX.
  • Customer: Can access own user base.

Example Request (OAuth2)

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

{
  "user_type": "String",
  "first_name": "String",
  "middle_name": "String",
  "last_name": "String",
  "email": "String",
  "password": "String",
  "status": "String",
  "department": "String",
  "designation": "String",
  "send_welcome_mail": "Boolean"
}

Explanation of Raw Body JSON Payload

Example Response (Success)

{
  "result": "Number",
  "user": {
    "user_id": "Number",
    "name": "String"
  }
}

Edit a User

Use this API to update the contact information of users. All keys in the JSON payload are optional. Use only the key that you want to edit.

• API Route: https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}
• HTTP Request: PATCH
• Role Based Accessibility:
  • Reseller Admin: Can access users under the reseller and all customers under it.
  • EnableX Admin: Can access users of any reseller/customer under EnableX.
  • Customer: Can access own user base.

Example Request (OAuth2)

PATCH https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}
Content-Type: application/json
Authorization: Token ACCESS_TOTKEN

{
  "user_type": "String",
  "first_name": "String",
  "middle_name": "String",
  "last_name": "String",
  "status": "String",
  "designation": "String"
}

Explanation of Raw Body JSON Payload

Example Response

{
  "result": "Number",
  "msg": "User $first_name $middle_name $last_name has been updated",
  "user": {
    "user_id": "Number",
    "name": "Sting"
  }
}

Get User Information

Use this API to get information for a specific User ID.

• API Route: https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}
• HTTP Request: GET
• Role Based Accessibility:
• Reseller Admin: Can access users under the reseller and all customers under it.
• EnableX Admin: Can access users of any reseller/customer under EnableX. -Customer: Can access own user base.

Example Response

GET https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}
Content-Type: application/json
Authorization: Token ACCESS_TOTKEN

Example Response

{
  "result": 1,
  "user": {
    "user_id": "String",
    "user_type": "String",
    "first_name": "String",
    "middle_name": "String",
    "last_name": "String",
    "email": "String",
    "status": "String",
    "designation": "String",
    "department": "String",
    "vc": {
      "access": "Boolean",
      "status": "String",
      "wef": "Date"
    },
    "wb": {
      "access": "Boolean",
      "status": "String",
      "wef": "Date"
    },
    "created_at": "Date",
    "updated_at": "Date",
    "activated_at": "Date",
    "suspended_at": "Date"
  }
}

Get User List

Use this API to search or get a list of all the users.

• API Route: https://api.enablex.io/ucaas/v1/users, https://api.enablex.io/ucaas/v1/users?page={{$PAGE_NUM}}
• HTTP Request: GET
• Role Based Accessibility:
• Reseller Admin: Can access users under the reseller and all customers under it.
• EnableX Admin: Can access users of any reseller/customer under EnableX.
• Customer: Can access own user base.

Example Request (HTTP Basic Authentication)

GET https://api.enablex.io/ucaas/v1/users, https://api.enablex.io/ucaas/v1/users?page={{$PAGE_NUM}}
Content-Type: application/json
Authorization: Basic BASE64_AUTH_STRING

URL Placeholder Explanation:

Example Response

{
  "result": 1,
  "search": {
    "page": "Number",
    "page_length": "Number",
    "from_create_dt": "Date",
    "to_create_dt": "Date",
    "search_by": "String",
    "search_string": "String",
    "order_by": "String",
    "order_qualify": "String"
  },
  "users": [
    {
      "user_id": "String",
      "user_type": "String",
      "first_name": "String",
      "middle_name": "String",
      "last_name": "String",
      "email": "String",
      "status": "String",
      "designation": "String",
      "department": "String",
      "vc": {
        "access": "Boolean",
        "status": "String",
        "wef": "Date"
      },
      "wb": {
        "access": "Boolean",
        "status": "String",
        "wef": "Date"
      },
      "created_at": "Date",
      "updated_at": "Date",
      "activated_at": "Date",
      "suspended_at": "Date"
    }
  ]
}

Assign an Application License to a User

Use this API to assign an application license, that is, a Subscription ID to a user to allow the user to access the application.

• API Route: https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}

• HTTP Request: PATCH

• Role Based Accessibility:

• Reseller Admin: Can access users under the reseller and all customers under it.

• EnableX Admin: Can access users of any reseller/customer under EnableX.

• Customer: Can access own user base.

Example Request (HTTP Basic Authentication)

PATCH https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}
Content-Type: application/json
Authorization: Basic BASE64_AUTH_STRING
X-License: assign

{
  "app": "String",
  "subscription_id": "String",
  "send_access_mail": "Boolean"
}

Explanation of Headers

• X-License: assign

Explanation of Raw Body JSON Payload

Example Response

{
  "result": "Number",
  "msg": "The user $first_name $middle_name $last_name has been provided access to the meeting application.",
  "user": {
    "user_id": "Number",
    "name": "Sting",
    "access": {
      "app": "String",
      "url": "String",
      "ppin": "String",
      "mpin": "String"
    }
  }
}

Revoke Application License From Users

Use this API to remove an application license from a user to restrict the user from using the application.

• API Route: https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}
• HTTP Request: PATCH
• Role Based Accessibility:
• Reseller Admin: Can access users under the reseller and all customers under it.
• EnableX Admin: Can access users of any reseller/customer under EnableX.
• Customer: Can access own user base.

Example Request (HTTP Basic Authentication)

PATCH https://api.enablex.io/ucaas/v1/users/{{$USER_ID}}
Content-Type: application/json
Authorization: Basic BASE64_AUTH_STRING
X-License: revoke

{
  "app": "String"
}

Explanation of Headers

• X-License: revoke

Explanation of Raw Body JSON Payload

Example Response

{
  "result": "Number",
  "msg": "The user $first_name $middle_name $last_name has been revoked access to the meeting application.",
  "user": {
    "user_id": "Number",
    "name": "Sting",
    "access": {
      "app": "String"
    }
  }
}

Error Codes

Meeting Management API

Use this API for for fetching different details about meeting rooms and managing meeting rooms.

Get Permanent Room Information

Use this API to get information about a permanent meeting room.

• API Routes
  • https://api.enablex.io/ucaas/v1/meeting/permanent - To get own permanent meeting room information
  • https://api.enablex.io/ucaas/v1/meeting/permanent/{{$USER_ID}} - To get permanent meeting room information for the specified user
• HTTP Request: GET

Example Request (HTTP Basic Authentication)

GET https://api.enablex.io/ucaas/v1/meeting/permanent
Content-Type: application/json
Authorization: Basic BASE64_AUTH_STRING
X-App-Type: vc

{
  "app": "String"
}

Headers Explanation

• X-App-Type: vc, wb

Example Response

{
  "result": 1,
  "permanent_room": {
    "room_id": "String",
    "user_id": "String",
    "room_name": "String",
    "desc": "String",
    "mpin": "String",
    "ppin": "String",
    "direct_url": "String",
    "moderators": "Number",
    "participants": "Number",
    "duration": "String",
    "wait_for_moderator": "Boolean",
    "knock": "Boolean",
    "auto_recording": "Boolean"
  }
}

Update Permanent Room Information

Use this API to update information for a permanent meeting room. The API updates the information if room-id specified in the URL is for self or any user under it.

• API Route: https://api.enablex.io/ucaas/v1/meetings/permanent/{{$ROOM_ID}}
• HTTP Request: PATCH

Example Request (HTTP Basic Authentication)

PATCH https://api.enablex.io/ucaas/v1/meeting/permanent/{{$ROOM_ID}}
Content-Type: application/json
Authorization: Basic BASE64_AUTH_STRING
X-App-Type: vc

{
  "room_name": "String",
  "desc": "String",
  "moderators": "Number",
  "participants": "Number",
  "wait_for_moderator": "Boolean",
  "knock": "Boolean",
  "auto_recording": "Boolean"
}

Explanation of Headers

• X-App-Type: vc, wb

Explanation of dynamic URL

• ROOM_ID: Room ID to update

Explanation of Raw Body JSON Payload

All data fields are optional while updating. Use only those fields which you look to update.