...
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 |
...
| Code Block |
|---|
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"
}
} |
GET /rooms/:code [public access]
Parameters
(none)
Response
...
If room already exists (http response code 400):
| Code Block |
|---|
{
"code": 400,
"message": "In domain 'vclinic.vsee.me' slug 'uat2' already exists."
} |
GET /rooms/:code [public access]
Parameters
(none)
Response
| Code Block |
|---|
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"
}
|
...
| Code Block |
|---|
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
}
]
} |
POST /rooms
Create a room
| Code Block |
|---|
curl --location --request POST 'https://api-template-wellevate-schedules.vseepreview.com/cc/next/api_v3/rooms' \
--header 'X-AccountCode: template-wellevate-schedules-00101' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'domain=template-wellevate-schedules-00101.vseepreview.com' \
--form 'slug=uat2' \
--form 'name=UAT2' |
Input
...
Parameter Name
...
Type
...
Description
...
X-ApiToken
...
Header
...
Clinic Admin token (app token)
...
X-ApiKey
...
Header
...
domain
...
string
...
Clinic’s domain
...
code
...
string
...
Room code (should be unique)
...
slug
...
string
...
(optional) Set this room as default, other rooms will lose default status.
...
name
...
string
...
| Code Block |
|---|
{
"data": {
"visits": {
"walkin": {
"enabled": true
},
"appointment": {
"enabled": true
}
},
"auth": {
"guest": {
"type": 600,
"log_in": {
"enabled": true
}
}
},
"subtitle": "If this is an emergency, please call 911.",
"slug": "uat2",
"name": "UAT2",
"domain": "template-wellevate-schedules-00101.vseepreview.com",
"active": true,
"account_code": "template-wellevate-schedules-00101",
"users": "",
"provider_ids": [],
"public_access_room": true,
"modified": 1605549399,
"created": 1605549399,
"payment": {
"consultations": [
{
"id": "5fb2bd57-9394-4cc0-934a-1b3b925862c1",
"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": "169",
"code": "jstq9"
}
}
|
If room already exists (http response code 400):
| Code Block |
|---|
{
"code": 400,
"message": "In domain "template-wellevate-schedules-00101.vseepreview.com" slug "uat2" already exists."
} |