VidCalls API Documentation

There are two main API usage.

  1. Report
  2. Meeting

In this documentation we’re using an example of Cosmos at https://cosmos.vidcalls.live/ 

Report

The “Report” folder contains APIs related to retrieving meeting reports.

This folder includes APIs for retrieving various data related to meetings, such as meeting reports, attendance records, and summary information.

GET Get Meeting Reports

 

https://cosmos.vidcalls.live/tenant-api/v1/meeting-reports?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA

The “Get Meeting Report” API retrieves detailed meeting reports.

This API allows users to fetch comprehensive meeting reports, including information such as meeting ID, date, topic, participants, and summary.

Query Parameters

  • api_key (required): Your API key for authentication. This key can be obtained from the VidCalls platform as an administrator. You can find this key in the control settings of your VidCalls account.

Authentication

Include your API key in the query parameters to authenticate the request. This key is unique to your VidCalls account and grants access to the meeting report API.

Example Response


{
"data": [
{
"id": 2,
"code": "6SxPZ",
"type": null,
"arrived_at": "2024-04-01T15:11:49.000000Z",
"ended_at": "2024-04-01T15:14:32.000000Z",
"created_at": "2024-04-01T15:11:37.000000Z",
"updated_at": "2024-04-01T15:14:38.000000Z",
"location_id": 1,
"user_id": 7,
"campaign_id": 1,
"zip_code": "",
"languages": "english",
"meeting_id": null,
"meeting_url": null,
"meeting_data": null,
"feedback": "{\"satisfaction\":\"5\",\"recommendation\":\"yes\"}",
"extra": null,
"participant_arrived_at": "2024-04-01T15:12:00.000000Z",
"participant_left_at": "2024-04-01T15:14:38.000000Z",
"customer_waiting": "2024-04-01T15:11:49.000000Z",
"survey": {
"id": 1,
"room_id": 2,
"first_name": "widhy",
"last_name": "new",
"email_address": "widhyarsana@gmail.com",
"state": "teset",
"city": "test",
"zip_code": "123123",
"phone_number": "123123123",
"lead": "This customer is a good lead.",
"customer_is_connected": 1,
"satisfaction": 4,
"feedback": "good sound",
"notes": "good",
"created_at": "2024-04-01T15:14:49.000000Z",
"updated_at": "2024-04-01T15:15:17.000000Z"
}
},
{
"id": 3,
"code": "AXTb0",
"type": null,
"arrived_at": "2024-04-01T15:16:37.000000Z",
"ended_at": "2024-04-01T15:17:21.000000Z",
"created_at": "2024-04-01T15:16:23.000000Z",
"updated_at": "2024-04-01T15:17:21.000000Z",
"location_id": 1,
"user_id": 8,
"campaign_id": 1,
"zip_code": "",
"languages": "english",
"meeting_id": null,
"meeting_url": null,
"meeting_data": null,
"feedback": null,
"extra": null,
"participant_arrived_at": "2024-04-01T15:16:52.000000Z",
"participant_left_at": "2024-04-01T15:17:21.000000Z",
"customer_waiting": "2024-04-01T15:16:35.000000Z",
"survey": {
"id": 2,
"room_id": 3,
"first_name": "test",
"last_name": "test",
"email_address": "dk@cabaretti.com",
"state": null,
"city": null,
"zip_code": null,
"phone_number": "123123123",
"lead": "This customer is a good lead.",
"customer_is_connected": 1,
"satisfaction": 5,
"feedback": "test",
"notes": "test",
"created_at": "2024-04-01T15:17:37.000000Z",
"updated_at": "2024-04-01T15:18:04.000000Z"
}
},
{
"id": 12,
"code": "yTPzd",
"type": null,
"arrived_at": "2024-04-03T06:04:27.000000Z",
"ended_at": "2024-04-03T06:06:10.000000Z",
"created_at": "2024-04-03T06:03:32.000000Z",
"updated_at": "2024-04-03T06:06:15.000000Z",
"location_id": 1,
"user_id": 7,
"campaign_id": 1,
"zip_code": "",
"languages": "english",
"meeting_id": null,
"meeting_url": null,
"meeting_data": null,
"feedback": null,
"extra": null,
"participant_arrived_at": "2024-04-03T06:04:39.000000Z",
"participant_left_at": "2024-04-03T06:06:15.000000Z",
"customer_waiting": null,
"survey": {
"id": 3,
"room_id": 12,
"first_name": null,
"last_name": null,
"email_address": null,
"state": null,
"city": null,
"zip_code": null,
"phone_number": null,
"lead": "",
"customer_is_connected": 0,
"satisfaction": 2,
"feedback": "",
"notes": null,
"created_at": "2024-04-03T06:06:41.000000Z",
"updated_at": "2024-04-03T06:06:41.000000Z"
}
},
{
"id": 14,
"code": "yRUle",
"type": null,
"arrived_at": "2024-04-03T06:47:05.000000Z",
"ended_at": "2024-04-03T06:47:40.000000Z",
"created_at": "2024-04-03T06:46:58.000000Z",
"updated_at": "2024-04-03T06:49:02.000000Z",
"location_id": 1,
"user_id": 7,
"campaign_id": 1,
"zip_code": "",
"languages": "english",
"meeting_id": null,
"meeting_url": null,
"meeting_data": null,
"feedback": "{\"satisfaction\":\"2\",\"recommendation\":\"yes\"}",
"extra": null,
"participant_arrived_at": "2024-04-03T06:47:36.000000Z",
"participant_left_at": "2024-04-03T06:47:46.000000Z",
"customer_waiting": null,
"survey": {
"id": 5,
"room_id": 14,
"first_name": null,
"last_name": null,
"email_address": null,
"state": null,
"city": null,
"zip_code": null,
"phone_number": null,
"lead": "",
"customer_is_connected": 0,
"satisfaction": 3,
"feedback": "",
"notes": null,
"created_at": "2024-04-03T06:47:52.000000Z",
"updated_at": "2024-04-03T06:47:52.000000Z"
}
},
]
}

 

PARAM

api_key       OAppN39j8CsApanHyjas0XIcOD3s3sjA

 

Example Request

curl --location 'https://cosmos.vidcalls.live/tenant-api/v1/meeting-reports?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA' 

Meeting

The “Meeting” folder contains APIs related to video meeting functionalities.

This folder includes APIs for various purposes related to video meetings, such as retrieving segments by campaign, managing participants, and accessing meeting analytics.

GET Get Departments by Campaign

https://cosmos.vidcalls.live/tenant-api/sales/segment?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA

PARAMS

api_key        OAppN39j8CsApanHyjas0XIcOD3s3sjA

Example Request:

curl --location 'https://cosmos.vidcalls.live/tenant-api/sales/segment?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA'

GET Find Advisor by Department

https://cosmos.vidcalls.live/tenant-api/tests/create-room?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA

The “Get Segment by Campaign” API retrieves segments related to a specific campaign.

This API allows users to fetch segments associated with a particular campaign identified by its slug parameter.

Query Parameters

  • api_key (required): Your API key for authentication.
  • campaign (required): The slug parameter identifying the campaign.

Authentication

Include your API key in the query parameters to authenticate the request.

Example Response


{
"data": [
{
"id": 1,
"global_id": "67f15264-9f82-4c7f-8132-6659c3203ae2",
"campaign_id": 1,
"name": "Tests",
"code": "tests",
"city": "",
"state": "",
"zip_code": "",
"street_address": "",
"created_at": "2024-04-01T15:01:32.000000Z",
"updated_at": "2024-04-03T06:19:00.000000Z"
},
{
"id": 3,
"global_id": "b2a0af53-74d7-4e1f-b7c7-ec4e2c38d4c5",
"campaign_id": 1,
"name": "Marrketing",
"code": "marketing",
"city": null,
"state": null,
"zip_code": null,
"street_address": null,
"created_at": "2024-04-24T04:11:05.000000Z",
"updated_at": "2024-04-24T04:11:05.000000Z"
},
{
"id": 4,
"global_id": "ca056efb-3cd4-4b5b-ba2f-cccc87f0dd4f",
"campaign_id": 1,
"name": "North USA",
"code": "north",
"city": null,
"state": null,
"zip_code": null,
"street_address": null,
"created_at": "2024-04-24T04:11:35.000000Z",
"updated_at": "2024-04-24T04:11:35.000000Z"
},
{
"id": 5,
"global_id": "d9bd9ad6-aada-4eaa-9b8a-30487093cdd6",
"campaign_id": 1,
"name": "South USA",
"code": "south",
"city": null,
"state": null,
"zip_code": null,
"street_address": null,
"created_at": "2024-04-24T04:11:57.000000Z",
"updated_at": "2024-04-24T04:11:57.000000Z"
}
]
}

PARAM

api_key          OAppN39j8CsApanHyjas0XIcOD3s3sjA

Example Request

curl --location 'https://cosmos.vidcalls.live/tenant-api/tests/create-room?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA' 

GET Send URL Meeting Room

https://cosmos.vidcalls.live/tenant-api/30/room?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA

PARAMS

api_key       OAppN39j8CsApanHyjas0XIcOD3s3sjA

Example Request

curl --location 'https://cosmos.vidcalls.live/tenant-api/30/room?api_key=OAppN39j8CsApanHyjas0XIcOD3s3sjA'