Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter Name

Type

Description

room_code

StringAlready

supportedRoom’s code

start_time

IntegerAlready

supportedUNIX timestamp

end_time

IntegerAlready

supportedUNIX timestamp

fields

String

Comma-separated list of field names that you want to return in the response. Should contain recordings to receive the recording objects for each visit

with_recordings_only

Integer

0 / 1

...

Filter out visits that have no recordings. This will allow to fetch only a list of visits that have recordings.

  1. When fields param includes recordingsfield:

This flag will include the recordingsobject into each visit - an array of recordings.The path in each recording should be fresh and have fresh expiry time.

Code Block
{
  "data": [
    {
      "id": "82828",
      "start": 1631628616,
      "end": 1631628916,
      "actual_start": 1631628211,
      "actual_end": null,
      "hosts": ,
      "type": 2,
      "status": 30,
      "meeting": {
          "recording_auto_start": false,
          "phone_numbers": {
              "US": [
                  "+1.650.758.0255"
              ]
          },
          "hosts": [
              "anton+providersa@vseelab.com",
              "chau+provider@vseelab.com"
          ],
          "expiry": 1633643316,
          "conference_pin": 838759,
          "meeting_id": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
      },
      "recordings": {
          "count": 1,
          "data": [{
              "id": 111,
              "visit_id": "82828",
              "end": 1633966813,
              "participants": [
                {
                  "first_name": "Keven2",
                  "last_name": "Teodoro2",
                  "vseeid": "conciergedev+user575",
                },
                {
                  "first_name": "Keven2",
                  "last_name": "Teodoro2",
                  "vseeid": "provider.w@vclinic.com",
                }
              ],
              "start": 1633966696,
              "version": 3,
              "path": {
     
          "url":"https://vseeserver-recording-prod.s3-us-west-2.amazonaws.com/laxdnbgvetqblvye/1636431607681_0be77640-61a2-4c7d-8ff9-2d0e16505a51__jitsi_2021-11-09-04-22-21.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211112T151817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=AKIAJ644UPRQFLQ3T4PA%2F20211112%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=8a5b6906d8b09bcf425dc98f8164517a45dcc934666e441c4e95bc107e9ab982",
                "expiry": 1634966813
              }
          }, {
              "id": 222,
              "visit_id": "82828",
              "end": 1636432432,
              "start": 1636431741,
              "version": 3,
              "participants": [
                {
                  "first_name": "Keven2",
                  "last_name": "Teodoro2",
                  "vseeid": "conciergedev+user575",
                },
                {
                  "first_name": "Keven2",
                  "last_name": "Teodoro2",
                  "vseeid": "provider.w@vclinic.com",
                }
              ],
              "path": {
                "url":"https://vseeserver-recording-prod.s3-us-west-2.amazonaws.com/laxdnbgvetqblvye/1636431607681_0be77640-61a2-4c7d-8ff9-2d0e16505a51__jitsi_2021-11-09-04-22-21.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211112T151817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=AKIAJ644UPRQFLQ3T4PA%2F20211112%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=8a5b6906d8b09bcf425dc98f8164517a45dcc934666e441c4e95bc107e9ab982",
      
         "expiry": 1634966813
              }
          }]
      }
    },
    {
      "id": "yyy",
      "recordings": {...}
    }
  ]
}

This is same object as from https://scribeemr.vseepreview.com/vc/next/api_v3/visits/record_v3?tag=6189f6f7659c4847bcac16dc64457b1f&begintime=1636431607&endtime=1636432507

with_recordings_only

Filter out visits that have no recordings. This will allow the customer to fetch only a list of visits that have recordings. This is the use case for ScribeEMR.

POST api.vsee.com/recordings

Code Block
https://api.vsee.com/recordings?apikey=...
--data '{"secretkey":"...",ids: [111, 222]}'

Input

...

Parameter Name

...

Type

...

Description

...

api_key

...

String

...

Already supported

...

secretkey

...

Integer

...

Already supported

...

ids

...

Integer

...

Array of internal recording IDs (limit of 100)

...

expiry

...

Integer

...

(optional) Lifetime of the url, sec

Response

Code Block
[
  {
    id: 111, 
    "path": "https://vseeserver-recording-prod.s3-us-west-2.amazonaws.com/laxdnbgvetqblvye/1636431607681_0be77640-61a2-4c7d-8ff9-2d0e16505a51__jitsi_2021-11-09-04-22-21.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211112T151817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=AKIAJ644UPRQFLQ3T4PA%2F20211112%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=8a5b6906d8b09bcf425dc98f8164517a45dcc934666e441c4e95bc107e9ab982"
  },
  {
    id: 222, 
    "path": "https://vseeserver-recording-prod.s3-us-west-2.amazonaws.com/laxdnbgvetqblvye/1636431607681_0be77640-61a2-4c7d-8ff9-2d0e16505a51__jitsi_2021-11-09-04-22-21.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211112T151817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=AKIAJ644UPRQFLQ3T4PA%2F20211112%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=8a5b6906d8b09bcf425dc98f8164517a45dcc934666e441c4e95bc107e9ab982"
  }  
]

GET /visits/:id/recordings/:recording_id

https://api-vclinic.vseepreview.com/vc/next/api_v3/visits/82828/recordings/111

Input

Parameter Name

Type

Description

id

String

Visit ID

recording_id

String

The recording ID from visits.data.recordings.id

Response

Code Block
{
  "id": 111,
  "visit_id": 82828,
  "end": 1633966813,
  "participants": [
    {
      "first_name": "Keven2",
      "last_name": "Teodoro2",
      "vseeid": "conciergedev+user575",
    },
    {
      "first_name": "Keven2",
      "last_name": "Teodoro2",
      "vseeid": "provider.w@vclinic.com",
    }
  ],
  "start": 1633966696,
  "version": 3,
  "path": {
    "url":"https://vseeserver-recording-prod.s3-us-west-2.amazonaws.com/laxdnbgvetqblvye/1636431607681_0be77640-61a2-4c7d-8ff9-2d0e16505a51__jitsi_2021-11-09-04-22-21.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211112T151817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=AKIAJ644UPRQFLQ3T4PA%2F20211112%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=8a5b6906d8b09bcf425dc98f8164517a45dcc934666e441c4e95bc107e9ab982",
    "expiry": 1634966813
  }
}

...