HooT-API (1.0.0)

HooT's WebLogin API allows you to record or register login event of a user. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. The API returns a JSON object with two parameters: user id as user_id and user_uuid as unique user id. This unique user id is used to identify the user across the conferencing system

Use HooT's CheckConferenceByID API to check if a conference is alive. The API takes Conference ID coined conf_id as a path parameter. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. The API returns a 200 response code in case a conference with the given Conference ID is alive, else it returns a 404 reponse code.

Use HooT's UserLastJoinedConferences API to fetch list of conferences recently joined by the user within a valid range of values (to,from). Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. Unique user id as user_uuid is passed as a path parameter to identify the user for whom the list of last joined conferences is to be retrieved. If from is greater than maximum number of conferences joined by the user, then 204 is returned as the response code with no reponse body. If to is greater than the maximum number of conferences joined, then conferences are returned within index range of (from,maximum number of conferences joined).

Use HooT's UserInvitedToConferences API to fetch list of conferences a user has been invited to, within a valid range of values (to,from). Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. Unique user id as user_uuid is passed as a path parameter to identify the user for whom the list of invited conferences is to be retrieved. If from is greater than maximum number of conferences the user has been invited to, then 204 is returned as the response code with no reponse body. If to is greater than the maximum number of conferences the user has been invited to, then conferences are returned within index range of (from,maximum number of conferences user has been invited to).

HooT's UserFavouriteConference API fetches the list of conferences a user has marked as favourite. The API returns the list of all the conferences user has marked as favourite in the form of a JSON object. Unique user id as user_uuid is passed as a path parameter to identify the user for whom the favoruite conferences are to be retrieved. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers.

You can leverage HooT's UserSetFavouriteConference API to mark a conference as favourite for a particular user. On successful addition to the Favourites list, the API will return a 202 response code. Conference Id as conf_id and Unique user id as user_uuid are passed as path parameters to identify the conference and user respectively. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers.

You can leverage HooT's UserUnsetFavouriteConference API to remove a conference from favourites for a particular user. On successful removal from Favourites, the API will return a 202 response code. Conference Id as conf_id and Unique user id as user_uuid are passed as path parameters to identify the conference and user respectively. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers.

Leverage HooT's SearchConferences API to fetch list of conferences that include the search string coined search_string, passed a path parameter. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. count is passed as a query parameter that signifies the limit to number of search results.By default, it's -1 which means returns all the search results. Conferences found that includes the search term in conference name, will be returned as elements of a list object with a 200 response code, as shown in example-1.

Use HooT's CreateConference API to seamlessly create new conferences. The API returns a JSON object containing the conference details, in case the conference has been successfully created, with a 200 reponse code. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. Conference name as conference_name is passed a path parameter.

readiness & liveness probe

HooT's Get Base64 URL API takes Base64 encoded conference URL coined b64_URL as a path parameter and returns the actual join URL as a JSON String with 302 response code. If the encoded URL is not valid, the API returns a 404 response code.

Use the DeleteConference API to delete any conference. The API returns a 200 response code when a conference has been successfully deleted, else it will return a 404 response code if no conference is found with the given conference id. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. Conference ID as conf_id is passed as a path parameter to uniquely identify the conference.

Use HooT's AddUserSearchString API to add a search term to user's search history. The API takes the user's unique user id as user_id and search term as search_string,as path parameters. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. On successfully adding the search term, the API will return a 200 response code.

Use HooT's UserSearchStrings API to get a list of user's search history. The API takes the user's unique user id as user_id as a path parameter. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. On successful execution, the API will return a JSON object as shown in example-1,with a 200 response code.

Leverage HooT's EditConference API to add/remove participants from an existing conference. Additionally you can use this API to add existing participants or new participants as moderators to the conference. The API takes Conference ID as conf_id as a path parameter to uniquely identify the conference. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. On successfully edit, the API returns a 200 reponse code with a JSON object as shown in example-1.

Use HooT's AllUsersofConference API to fetch the list of all participants and moderators of a conference. The API takes conference ID as conf_id as a path param to identify the conference. If a conference is found with the given conference ID, the API will return a JSON object with two parameters moderators and participants containing the list of moderators and participants in the conference respectively. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. Conference ID as conf_id is passed as a path parameter to uniquely identify the conference

Use HooT's AllConferenceUsers API to fetch the list of all participants of a conference. The API takes conference ID as conf_id as a path param to identify the conference. If a conference is found with the given conference ID, the API will return an Array of JSON objects containing the name and email of participants in the conference respectively. Authorization-Token and x-hoot-instance that signifies the instance name are passed as headers. Conference ID as conf_id is passed as a path parameter to uniquely identify the conference

Get URL conference as query param.

DeepLink is an internal API which will activate the rails for joining a call and for relocating the coreMX if needed.

Deep Link Bypass is to break the cyclic loop against iOS universal links.

Bypass links are to break iOS universal link loop but to exactly same as the non bypass equivalent.

Request to subscribe to a conference's events. Provide the subscription