GET /rooms [public access]
Parameters
(none)
Rooms API supports DataTable API
Response
curl -k -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms"
{
"data": [{
"slug": "room1",
"name": "Room 1",
"domain": "demo.vsee.me",
"code": "room1_code",
"created": 1427922788,
"modified": 1427922788
}, ...]
}
POST /rooms
Parameters
Parameter | Type | Description |
|---|---|---|
|
| Clinic Admin token (app token) |
|
| Clinic’s domain |
|
| (optional) Room code (should be unique) |
|
| (optional) Set this room as default, other rooms will lose default status. |
|
| Room's name |
Response
curl --location --request POST 'https://api.vsee.me/api_v3/rooms' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'domain=vclinic.vsee.me' \
--form 'slug=provider00102' \
--form 'name=provider00102 room'
{
"data": {
"visits": {
"walkin": {
"enabled": true
},
"appointment": {
"enabled": false
}
},
"auth": {
"guest": {
"type": 600,
"log_in": {
"enabled": true
}
}
},
"subtitle": "If this is an emergency, please call 911.",
"slug": "provider00102",
"name": "provider00102 room",
"domain": "vclinic.vsee.me",
"active": true,
"users": "85741",
"account_code": "clinic",
"provider_ids": [
"85741"
],
"public_access_room": true,
"modified": 1605728974,
"created": 1605728974,
"payment": {
"consultations": [
{
"id": "5fb57ace-4808-4346-ad3c-3348925862c1",
"description": "15-min Consultation",
"duration": 15,
"amount": 0,
"group": false,
"charge": false,
"slots": 1
}
],
"currency": "USD",
"__note__": "paymentCurrency will be deprecated by 1 Jun 2017"
},
"operation_settings": {
"is_closed": false,
"close_msg": "Service currently not available. Please check back later",
"default_timezone": "America/Los_Angeles"
},
"id": "171",
"code": "b4vjj"
}
}
If room already exists (http response code 400):
{
"code": 400,
"message": "In domain 'vclinic.vsee.me' slug 'uat2' already exists."
}
GET /rooms/:code [public access]
Parameters
(none)
Response
curl -k -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms/room1"
{
"data": {
"description": "",
"specialties": [
{
"code": "general_care",
"name": "Default",
"duration": 15
},
{
"code": "primary_care",
"name": "Primary Care",
"duration": 15
},
{
"code": "psychiatry",
"name": "Psychiatry",
"duration": 30
},
{
"code": "dermatology",
"name": "Dermatology",
"duration": 15
}
],
"modified": 1466796316,
"created": 1446802721,
"payment": {
"paymentCurrency": "USD",
"consultations": [
{
"description": "15-min Consultation",
"amount": 0,
"duration": 15
},
{
"description": "30 min",
"amount": 20,
"duration": 30
},
{
"description": "45 min",
"amount": 40,
"duration": 45
}
]
},
"slug": "room1",
"name": "Room 1",
"domain": "demo.vsee.me",
"code": "room1",
"account_code": "DEMO-ACCOUNT"
}
GET /rooms/:code/providers [public access]
Response
curl -k -X GET \
-H "X-AccountCode: vclinic" \
"https://api.vsee.me/api_v3/rooms/example-room-code/providers"
{
"data": [
{
"id": "401",
"username": "provider-401",
"code": "",
"subtype": "482",
"first_name": "Jarod",
"last_name": "Sun 401",
"vseeid": "evisitdev+user401",
"photo": null,
"title": "",
"suffix": "",
"status": false,
"short_bio": false
}
]
}
GET /rooms/:code/providers/:id [public access]
Response
curl -k -X GET \
-H "X-AccountCode: vclinic" \
"https://api.vsee.me/api_v3/rooms/ceproom1/providers/826"
{
"data": {
"id": "826",
"code": "55de45a2ce384a24ad633301ac1f0144",
"first_name": "John",
"last_name": "Will",
"username": "provider1",
"vseeid": "conciergedev+user826",
"email": "anton+provider1@vsee.com",
"active": true,
"title": "Dr.",
"suffix": "M.D.",
"tos": false,
"phone": "334 2222211",
"subtype": "482",
"status": false,
"educational_training": "edu and training...",
"professional_interests": "interests...",
"personal_interests": "some personal hobby"
}
}
GET /rooms/:code/queue [public access]
Waiting time = average_visit_time * before_me
Response
curl -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms/ceproom1/queue"
{
"data": {
"length": 10,
"capacity": 100,
"average_visit_time": 3600,
"before_me": 3
}
}
length- total current queue lengthcapacity- maximum possible queue lengthaverage_visit_time- time in seconds per patientbefore_me- patient in the queue before me
POST /users/:id/rooms
Associate a room to a user
Parameters
Parameter | Type | Description |
|---|---|---|
|
| Room code |
|
| (optional) Set this room as default, other rooms will lose default status. |
Response
curl --location --request POST 'https://api.vsee.me/api_v3/users/85741/rooms' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'code=b4vjj''
{
"data": [
{
"_id": "171",
"slug": "provider00102",
"name": "provider00102 room",
"domain": "clinic.vseepreview.com",
"code": "b4vjj",
"active": true,
"users": "85741",
"account_code": "clinic",
"provider_ids": [
"85741"
],
"public_access_room": true,
"modified": {
"sec": 1605728974,
"usec": 177000
},
"created": {
"sec": 1605728974,
"usec": 177000
},
"payment": {
"consultations": [
{
"id": "5fb57ace-4808-4346-ad3c-3348925862c1",
"description": "15-min Consultation",
"duration": 15,
"amount": 0,
"group": false,
"charge": false,
"slots": 1
}
]
},
"default": false
}
]
}