Scribd
Upload
6 views22 pages

DialTM API Documentation Overview

The DialTM API allows developers to manage user details, meeting reports, and dashboard data, requiring OAuth authentication for access. Key functionalities include user registration, meeting creation, retrieval of meeting details, and organization level management. The API supports various operations such as adding, updating, and deleting users and meetings, with responses structured to indicate success and provide relevant data.

Uploaded by

Tushar Panchal
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
6 views22 pages

DialTM API Documentation Overview

The DialTM API allows developers to manage user details, meeting reports, and dashboard data, requiring OAuth authentication for access. Key functionalities include user registration, meeting creation, retrieval of meeting details, and organization level management. The API supports various operations such as adding, updating, and deleting users and meetings, with responses structured to indicate success and provide relevant data.

Uploaded by

Tushar Panchal
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

API DOCUMENT

DialTM allow developers to request information from the DialTM including but not limited to User
details, Meeting reports, Dashboard data, etc. as well as perform actions on the DialTM platform on
a user’s behalf, such as, creating a new user or deleting meeting recordings.

Authentication

OAUTH_HEADER

OAuth allows applications to obtain access to DialTM user’s profile information that are made
available via the DialTM API.

Authorization : bearer access_token


Sample: Authorization : bearer 02af702a-cd4b-45f4-b810-e573f09dab21

X_USER- logged user_id (it should be admin only )

** all APIs(except login and save Dialtm User) need to be accessed with bearer tokens.

USER/ GUEST USER

Register the user Details on the application


/dialtmUser/saveDialtmUser

POST

For register as an external user who can login to portal and send request for subscription

Request:
{
"email": "string",
"id": "string",
"name": "string",
"phoneNo": "string",
"picture": "string",
"stateragy": "string",
"userName": "string"
}
Response:
{
"code": 0,
"message": "string",
"success": true
}

Confidential Document 1
API DOCUMENT

/oauth/token – Call for get access token for application

URL Header Body Type Response


oauth/token Authorization : Basic password : ”User URL {
b2F1dGgtc2VjdXJlOjlURERGRnNqN3JScXdKRzk= password” "access_token":
username : “User POST "26cd7aa5-1caf-
username” 461b-bd35-
grant_type:password 06aa8233cd24",
"token_type":
"bearer",
"refresh_token":
"cd54793d-ddfe-
4076-a6fc-
34bff9ad2fcc",
"expires_in":
86399,
"scope": "read
write"
}

GET User details for loggedIn user

URL Header Body Type Response

/getUser OAUTH_HEADER URL {


"externalId": "string",
"principal": {
"name": "string"
}
}

FOR GET USER Organization

URL Header Body Type Response


/search/ OAUTH_HEADE NA GET {
orgs/ext R
"access_token": "26cd7aa5-1caf-461b-bd35-
ID/{extI 06aa8233cd24",
D} "token_type": "bearer",
"refresh_token": "cd54793d-ddfe-4076-a6fc-
34bff9ad2fcc",
"expires_in": 86399,
"scope": "read write"
}

FOR GET All Meeting FOR ORGANIZATION

Confidential Document 2
API DOCUMENT

URL Description Type Response


/org/{orgId}/meetings/ To get all meeting GET {
details for
organization
"code": 0,
"data": [
{
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,
"orgMeetingCode": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0
}
],
"message": "string",
"success": true
}

Confidential Document 3
API DOCUMENT

RETREIVE ALL MEETING DETAILS FOR AN ORGANIZATION

URL Description Type Response


/org/{orgId}/meetings/ To get all meeting details for GET {
organization
"code": 0,
"data": [
{
"endDate": "yyyy-MM-dd
HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,
"orgMeetingCode": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd
HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0
}
],
"message": "string",
"success": true
}

Confidential Document 4
API DOCUMENT

RETREIVE ALL MEETING DETAILS FOR A PARTICULAR TOPIC

URL Description Type Response


/org/{orgId}/topics/{topicId}/ To get all meeting GET {
meetings/ details for "code": 0,
particular topic "data": [
{
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,
"orgMeetingCode": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0
}
],
"message": "string",
"success": true
}

Confidential Document 5
API DOCUMENT

RETRIEVE A MEETING Details

To get the details for particular meeting

URL Description Type Response


/org/{orgId}/topics/ To get details for particular GET {
{topicId}/meetings/{ meeting
"code": 0,
meetingsId} "data": [
{
"endDate": "yyyy-MM-dd
HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,
"orgMeetingCode": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd
HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0
}
],
"message": "string",
"success": true
}

Confidential Document 6
API DOCUMENT

SHOW ALL LEVELS IN AN ORGANISATION

/org/{orgId}/levels
Type: GET

Des.: get all levels define for an organization

Response:
{
"code": 0,
"data": [
{
"levelDisplayName": "string",
"levelId": 0,
"levelIdx": 0
}
],
"message": "string",
"success": true
}

ADD NEW LEVEL IN THE ORGANSATION


/org/{orgId}/levels

Type: POST

Des: add new level for an organization

Request:
{
"levelDisplayName": "string",
"x_user": "string"
}

Response:
{
"code": 0,
"data": {
"levelDisplayName": "string",
"levelId": 0,
"levelIdx": 0
},
"message": "string",
"success": true
}

GET THE LEVEL DETAILS


/org/{orgId}/levels/{levelsId}

GET

Get details for a particular level id

Confidential Document 7
API DOCUMENT

Response:
{
"code": 0,
"data": {
"levelDisplayName": "string",
"levelId": 0,
"levelIdx": 0
},
"message": "string",
"success": true
}

DELETE A LEVEL
/org/{orgId}/levels/{levelsId}

DELETE

Delete al particular level from organization

Body: {x_user:id}

Response:
{
"code": 0,
"data": {
"levelDisplayName": "string",
"levelId": 0,
"levelIdx": 0
},
"message": "string",
"success": true
}

UPDATE A LEVEL
/org/{orgId}/levels/{levelsId}

PATCH

Update description of level id

Request:
{
"levelDisplayName": "string",
"x_user": "string"
}

Response:
{
"code": 0,
"data": {
"levelDisplayName": "string",
"levelId": 0,
"levelIdx": 0
},

Confidential Document 8
API DOCUMENT

"message": "string",
"success": true
}

CREATE NEW MEETING


/org/{orgId}/topics/{topicId}/meetings/

Add new meeting for organization

Type: POST (JSON)

Request:
{
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"scheduleType": "string",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"x_user": "string"
}

Response:
{
"code": 0,
"data": {
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,

Confidential Document 9
API DOCUMENT

"orgMeetingCode": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0
},
"message": "string",
"success": true
}

DELETE A MEETING

A meeting host or a user with admin privileges can delete a scheduled meeting. Users can delete a
meeting manually using the Delete feature for a meeting.
/org/{orgId}/topics/{topicId}/meetings/{meetingsId}

Delete a meeting

Type: DELETE (JSON)

Body: {x_user:id}

Response:
{
"code": 0,
"data": {
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,
"orgMeetingCode": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,

Confidential Document 10
API DOCUMENT

"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0
},
"message": "string",
"success": true
}

RETRIEVE THE DETAILS OF A MEETING


/org/{orgId}/topics/{topicId}/meetings/{meetingsId}

Type: PATCH

Desc: To update any meeting information

Request:
{
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"scheduleType": "string",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"x_user": "string"
}

Response:
{
"code": 0,
"data": {
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,

Confidential Document 11
API DOCUMENT

"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,
"orgMeetingCode": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",
"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0
},
"message": "string",
"success": true
}

RETRIEVE THE DETAILS OF ALL MEETING FOR THE PARTICULAR USER


/org/{orgId}/users/{userId}/meetings/

Type: GET

Description : to get all meetings for particular user

Response:
{
"code": 0,
"data": [
{
"endDate": "yyyy-MM-dd HH:mm:ss",
"endTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"meetingId": 0,
"orgId": 0,
"orgMeetingCode": "string",
"orgMeetingId": "string",
"orgName": "string",
"roleId": 0,
"roleName": "string",
"scheduleType": "onetime",
"scheduleVal": "string",
"startDate": "yyyy-MM-dd HH:mm:ss",

Confidential Document 12
API DOCUMENT

"startTime": {
"date": 0,
"day": 0,
"hours": 0,
"minutes": 0,
"month": 0,
"seconds": 0,
"time": 0,
"timezoneOffset": 0,
"year": 0
},
"topicId": 0,
"topicName": "string",
"userUid": 0
}
],
"message": "string",
"success": true
}

RETRIEVE THE TOPICS DETAILS


/org/{orgId}/topics

Type: GET

Description: get all topics for an organization

Response:
{
"code": 0,
"data": [
{
"topicGenerateName": "string",
"topicId": 0
}
],
"message": "string",
"success": true
}

ADD NEW TOPIC IN AN ORGANISATION


/org/{orgId}/topics

Type: POST

Desc: Add new topic to an organization

Request:
{
"topicGenerateName": "string",
"topicId": 0,
"x_user": "string"
}

Reponse:
{

Confidential Document 13
API DOCUMENT

"code": 0,
"data": {
"topicGenerateName": "string",
"topicId": 0
},
"message": "string",
"success": true
}

RETRIEVE THE PARTICULAR TOPIC DETAILS


/org/{orgId}/topics/{topicId}

Type: GET

Desc: to get details about any topic information

Response:
{
"code": 0,
"data": {
"topicGenerateName": "string",
"topicId": 0
},
"message": "string",
"success": true
}

DELETE THE PARTICULAR TOPIC


/org/{orgId}/topics/{topicId}

TYPE: Delete

Desc: for delete a topic from organization

Request:

{x_user:”admin_id”}
Response:
{
"code": 0,
"data": {
"topicGenerateName": "string",
"topicId": 0
},
"message": "string",
"success": true
}

RETRIEVE THE USER DETAILS IN THE ORGANISATION


/org/{orgId}/users

Type: GET

Confidential Document 14
API DOCUMENT

Desc: get all user for organization

Response:
{
"code": 0,
"data": [
{
"isVerified": "string",
"orgId": 0,
"orgUserId": 0,
"orgUserRefid": "string",
"roleId": 0,
"roleName": "string",
"userContact": "string",
"userEmail": "string",
"userFirstName": "string",
"userLastName": "string",
"userMiddleName": "string"
}
],
"message": "string",
"success": true
}

ADD THE USER DETAIL IN THE ORGANISATION


/org/{orgId}/users

Type: POST

Desc: to add new user for organization

Request:
{
"orgUserRefid": "string",
"roleId": 0,
"userContact": "string",
"userEmail": "string",
"userFirstName": "string",
"userLastName": "string",
"userMiddleName": "string",
"x_user": "string"
}

Response:
{
"code": 0,
"data": {
"isVerified": "string",
"orgId": 0,
"orgUserId": 0,
"orgUserRefid": "string",
"roleId": 0,
"roleName": "string",
"userContact": "string",
"userEmail": "string",
"userFirstName": "string",
"userLastName": "string",
"userMiddleName": "string"

Confidential Document 15
API DOCUMENT

},
"message": "string",
"success": true
}

RETRIEVE THE PARTICULAR USER DETAILS


/org/{orgId}/users/{userId}
Type: GET

Desc: get user information

Response:
{
"code": 0,
"data": {
"isVerified": "string",
"orgId": 0,
"orgUserId": 0,
"orgUserRefid": "string",
"roleId": 0,
"roleName": "string",
"userContact": "string",
"userEmail": "string",
"userFirstName": "string",
"userLastName": "string",
"userMiddleName": "string"
},
"message": "string",
"success": true
}

DELETE THE USER DETAILS IN THE ORGANISATION


/org/{orgId}/users/{userId}

Type: DELETE

Desc: delete a user from organization

Request

body: {x_user:id}

Reponse:
{
"code": 0,
"data": {
"isVerified": "string",
"orgId": 0,
"orgUserId": 0,
"orgUserRefid": "string",
"roleId": 0,
"roleName": "string",
"userContact": "string",
"userEmail": "string",
"userFirstName": "string",
"userLastName": "string",
"userMiddleName": "string"

Confidential Document 16
API DOCUMENT

},
"message": "string",
"success": true
}

UPDATE THE USER DETAILS


/org/{orgId}/users/{userId}

Type: PATCH

Desc: To update a user information

Request:
{
"orgUserRefid": "string",
"roleId": 0,
"userContact": "string",
"userEmail": "string",
"userFirstName": "string",
"userLastName": "string",
"userMiddleName": "string",
"x_user": "string"
}

Response:
{
"code": 0,
"data": {
"isVerified": "string",
"orgId": 0,
"orgUserId": 0,
"orgUserRefid": "string",
"roleId": 0,
"roleName": "string",
"userContact": "string",
"userEmail": "string",
"userFirstName": "string",
"userLastName": "string",
"userMiddleName": "string"
},
"message": "string",
"success": true
}

RETRIEVE THE COUNTRY DETAIL


/master/countries/

Type: GET

Response:
{
"code": 0,
"data": [
{
"countryCode": "string",
"countryId": 0,

Confidential Document 17
API DOCUMENT

"countryName": "string"
}
],
"message": "string",
"success": true
}

RETRIEVE THE STATE DETAIL


/master/countries/{countryId}/states

Type: GET
{
"code": 0,
"data": [
{
"countryId": 0,
"stateCode": "string",
"stateId": 0,
"stateName": "string"
}
],
"message": "string",
"success": true
}

RETRIEVE THE INDUSTRY DETAIL

/master/industries

Type: GET
{
"code": 0,
"data": [
{
"industryDesc": "string",
"industryId": 0,
"industryType": "string"
}
],
"message": "string",
"success": true
}

RETRIEVE THE ROLES


/master/roles

Type: GET

Response:
{
"code": 0,
"data": [
{
"roleDesc": "string",
"roleId": 0,
"roleName": "string"

Confidential Document 18
API DOCUMENT

}
],
"message": "string",
"success": true
}

RETRIEVE THE CITIES

/master/states/{stateId}/cities
Type: GET
{
"code": 0,
"data": [
{
"cityCode": "string",
"cityId": 0,
"cityName": "string",
"stateId": 0
}
],
"message": "string",
"success": true
}

RETRIEVE THE SUBSCRIPTION REQUEST FOR AN ORGANISATION


/subscription/org/{orgId}/

Type: get subscription request for an organization

Response
{
"code": 0,
"data": [
{
"extUserId": 0,
"orgId": 0,
"orgUserRefId": "string",
"roleId": 0,
"roleName": "string",
"status": "string",
"subReqId": 0,
"userContact": "string",
"userEmail": "string"
}
],
"message": "string",
"success": true
}

SENT THE SUBSCRIPTION REQUEST FOR AN ORGANISATION

/subscription/org/{orgCode}/user/{orgUserRefId}
Type: Post

Confidential Document 19
API DOCUMENT

Des: send subscription request for an organization

Body:
{
"extUserId": 0
}

Response:
{
"code": 0,
"message": "string",
"success": true
}

UPDATE THE SUBSCRIPTION REQUEST FOR AN ORGANISATION

/subscription/{subReqId}
Type: PATCH

Desc: update status for subscription request

Body:
{
"status": "string",
"x_user": "string"
}

Response:
{
"code": 0,
"message": "string",
"success": true
}

GENERATE THE TOKEN FOR THE MEETING ROOM


/issue-token/

POST

Desc: generate a token for making a call

Request:
{
"aud": "string",
"group": "string",
"room": "string",
"user": {
"avatar": "string",
"email": "string",
"id": "string",
"name": "string"

Confidential Document 20
API DOCUMENT

}
}

Response:
{
"code": 0,
"message": "string",
"success": true,
"token": "string"
}

CREATE THE MEETING


/search/meeting/{meetingId}

GET

Get meeting information if present

Response:
{
"code": 0,
"data": {
"avatar": "string",
"email": "string",
"ext_id": "string",
"groupName": "string",
"name": "string",
"room": "string",
"startTime": "yyyy-MM-dd HH:mm:ss"
},
"message": "string",
"success": true
}

RETRIEVE THE MEETING PARTICIPANT DETAILS


/user/{userId}/meetings/

GET

Get meeting logs for particular user

Response:
{
"code": 0,
"data": [
{
"room": "string",
"startTime": "yyyy-MM-dd HH:mm:ss"
}
],
"message": "string",
"success": true
}

Confidential Document 21
API DOCUMENT

Standard Code:

Code Description
200 OK

Example Value
Model
{
"code": 0,
"message": "string",
"success": true
}
}
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

Confidential Document 22

You might also like