Page Comparison

POST /files

Parameters

...

GET /visits

https://api-vclinic.vseepreview.com/vc/next/api_v3/visits?room_code=ck1zs&start_time=1635721200&end_time=1637708400

Input

Parameter Name

Type

Description

file

Binary

File content

meta.category

String

File category. This is to mark the usage of the attachments. For now the possible reasons are 'intake_attachment', 'user_consent', 'user_avatar', 'user_document'

Response

...

`room_code`	`String`	Room’s code
`start_time`	`Integer`	UNIX timestamp
`end_time`	`Integer`	UNIX 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.

When fields param includes recordingsfield:

This flag will include the recordingsobject into each visit - an array of recordings.

Code Block

{
  "data": [
    {
      "id": "82828",
      "start": 1631628616,
      "end": 1631628916,
      "actual_start": 1631628211,
      "actual_end": null,
      "idhosts": "5e15d150-19b4-4cbd-b217-332fc71b6977",
 
      "nametype": "p878984.jpg"2,
        "sizestatus": 4067930,
 
      "extmeeting": "jpg", {
          "fullpathrecording_auto_start": "https://api.vsee.io/cc/ligeng/files/view/5e15d150-19b4-4cbd-b217-332fc71b6977?auth_code=e86ceb8b57c91e4db41611f08311a125e2df0b09&time=1578488144"false,
          "metaphone_numbers": {
              "categoryUS": "user_document", [
                  "target": {+1.650.758.0255"
              ]
   "id": "350936",      },
          "typehosts": [
 "user"             }"anton+providersa@vseelab.com",
            "account": {  "chau+provider@vseelab.com"
          ],
          "codeexpiry": 1633643316,
          "5c47c63907c44f0486a16e1dc71b6977conference_pin": 838759,
           }ß"meeting_id": "1633627695040_2cc263f4-3d07-49fa-97b1-b2955ff40dfa__jitsi"
        },
 
      "creatorrecordings": {
 
          "idcount": "350936"1,
            "usernamedata": "ligeng+trial14+member01@vseelab.com", [{
              "emailid": "ligeng+trial14+member01@vseelab.com"111,
              "fullvisit_nameid": "82828"Ligeng,
Long Long Long Long Long Long Long Long Long Long Long Long Long Long Long Name""end": 1633966813,
        }     }
}

POST /files/:id

Modify the document information. For now, only 'name' is allowed to be modified.

Parameters

...

Parameter

...

Type

...

Description

...

name

...

String

...

File name

Response

Code Block

curl -X POST \
  https://api.vsee.io/cc/ligeng/api_v3/files/5e1598e7-4118-47ca-84da-0923c71b6977 \
  -H 'X-ApiToken: 466c809667919d34d371d4c7d389392b' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -F name=test2.jpg

{ "participants": [
                {
                  "datafirst_name": {"Keven2",
        "id": "5e1598e7-4118-47ca-84da-0923c71b6977",         "last_name": "test2.jpgTeodoro2",
        "size": 184259,         "extvseeid": "jpgconciergedev+user575",
              "fullpath": "https:\/\/api.vsee.io\/cc\/ligeng\/files\/view\/5e1598e7-4118-47ca-84da-0923c71b6977?auth_code=ed7e17f29a56cc8c4b2fec812a07e7d30f322b85&time=1579496452",  },
          "meta":      {
            "target": {      "first_name": "Keven2",
                  "idlast_name": "350936Teodoro2",
                  "typevseeid": "user"provider.w@vclinic.com",
                },
             "category": "user_document", ],
              "accountstart": {
 1633966696,
              "codeversion": "5c47c63907c44f0486a16e1dc71b6977"3
          }, {
 }         },    "id": 222,
   "created": 1578473704     } }

DELETE /files/:id

Parameters

...

Parameter

...

Type

...

Description

...

id

...

String

...

File id

Response

Code Block

curl -X DELETE -H "X-ApiToken"visit_id": c18e9874dccd26482e191f3d7b57d3d8"82828",
-H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "file=@" "https://api.vsee.me/api_v3/files/57aa6ede-bf6c-4a88-81e1-6bcdac1f0144" -k  {     "dataend": true
}

GET /files

Retrieve file list

Parameters

...

Parameter

...

Type

...

Description

...

target_id

...

String

...

The id of the target which is related to the files

...

target_type

...

String

...

The file of the target which is related to the files. For now the possible values are 'user' and 'visit'

...

category_type

...

String

...

The category type of this file. For now the possible reasons are 'user_document', 'intake_attachment', 'user_consent', 'user_avatar'.

Response

Code Block


curl -X GET \
>   'https://api.vsee.io/cc/ligeng/api_v3/files?target_id=350936&target_type=user' \
>   -H 'X-ApiToken: 4df5b2b7dec8a8c40e142e43c1825502' \
>   -H 'cache-control: no-cache' \
>   -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
>   -F target_id=350936 \
>   -F target_type=user


{
    "data": [
  1636432432,
              "start": 1636431741,
              "version": 3,
              "participants": [
                {
     {             "idfirst_name": "5e1598e7-4118-47ca-84da-0923c71b6977Keven2",
                  "last_name": "55bb223fd7304.jpgTeodoro2",
            "size      "vseeid": 184259,"conciergedev+user575",
               "ext": "jpg", },
                 "fullpath": "https:\/\/api.vsee.io\/cc\/ligeng\/files\/view\/5e1598e7-4118-47ca-84da-0923c71b6977?auth_code=ede418b2b0b1fa5451c726a7e6959b2efabcad97&time=1578530083",{
                  "creatorfirst_name": {"Keven2",
                  "usernamelast_name": "ligeng+trial14+member01@vseelab.comTeodoro2",
                  "typevseeid": 200,"provider.w@vclinic.com",
                }
 "full_name": "Ligeng Long Long Long Long Long Long Long Long Long Long Long Long Long Long Long Name"
             ]
          }]
      }
    },
    {
      "id": "createdyyy":,
 1578473704     "recordings": {...}
  }  }
  ]
}

GET /visits/:id/

...

recordings/:

...

Retrieve file info

Parameters

...

recording_id

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

Input

Parameter Name

Type

Description

:
id
String
File id
Visit ID
auth
recording_
code
id
String
Auth code returned by other API method
time
String
Timestamp as returned by other API method
size
String
(optional) Resized image dimensions in {W}x{H} format. Example: 320x240. If the file is not image, this parameter will be ignored. Resized Image is always PNG format, Content-type: image/png header will be set in response

Response

...

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
  }
}

Versions Compared

Old Version 1

New Version Current

Key

POST /files

GET /visits

Input

POST /files/:id

DELETE /files/:id

GET /files

GET /visits/:id/

recordings/:

recording_id

Input

Response