Chat with us, powered by LiveChat

Developer API

Overview

The MediSprout API allows your application to schedule and perform virtual medical visits via your branded landing web page and mobile apps (iOS & Android).

MediSprout offers two payment plans:

  • One Time - You will be charged for each visit.
  • Monthly - You will be charged each month for each active provider (unlimited visits).

Routes

Schedule Visit

When scheduling a visit you will also pass in the provider who will perform the visit. New providers will be created and existing providers will be updated if needed. Updates will occur if the provider information has changed (Name, Email, Phone, Address, etc...). Frequent updates will be flagged as a possible abuse of the API Terms and Conditions.

Action: https://platform.medisprout.com/api/visit
Method: POST
Content-Type: application/json

Request
Param Required Type Description
token Yes String Your secret API token.
visitOn Yes Number The date the visit is to take place. Number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.
id Yes String Unique provider identifier for your application. Max length = 255.
plan Yes String Payment plan for this provider. Must be either 'OneTime' or 'Monthly'. A providers plan may never change. If you wish to use the same provider with a different plan then the 'id' must be different.
name Yes String Provider name. Max length = 250.
healthcareOrgName Yes String Healthcare Org. name. Max length = 250.
email No String Provider email address. Max length = 250.
phone No String Provider phone number. Max length = 50.
street1 No String Provider street address. Max length = 150.
street2 No String Provider street address. Max length = 150.
city No String Provider city. Max length = 150.
state No String Provider state. Max length = 2.
zip No String Provider zip code. Max length = 20.
Response
Param Required Type Description
success Yes Boolean Was the request a success or a failure. true or false. If false the error and errorCode will be available.
errorCode No Number Error code. All error codes are described below.
error No String String representation of the error.
providerVisitUrl No String The url the provider will use to join the visit. This should only be given to the provider.
attendeesVisitUrl No String The url the attendees will use to join the visit. This may be given to up to 25 participants (patients, family members, other providers).
providerVisitCode No String The code the provider will use to join the visit. This should only be given to the provider.
attendeesVisitCode No String The code the attendees will use to join the visit. This may be given to up to 25 participants (patients, family members, other providers).

Visit Record

Returns a list of media that was captured during this visit. Media can be files shared, diagnostic data, text messages and/or the recorded video. Recording the video is optional.

Action: https://platform.medisprout.com/api/visit/record
Method: POST
Content-Type: application/json

Request
Param Required Type Description
token Yes String Your secret API token.
providerVisitCode Yes String The code that was generated when the visit was created.
Response
Param Required Type Description
success Yes Boolean Was the request a success or a failure. true or false. If false the error and errorCode will be available.
errorCode No Number Error code. All error codes are described below.
error No String String representation of the error.
records No Array Array of records. Record = [name, type, downloadUrl]. type = {video, file, chat, etc...}. Each record contains a download url where the resource can be found. Each download url will expire after 60 seconds. You may request the entire record again if needed.

Delete Provider

Delete a provider with a monthly plan.

Action: https://platform.medisprout.com/api/provider/delete
Method: POST
Content-Type: application/json

Request
Param Required Type Description
token Yes String Your secret API token.
id Yes String Unique provider identifier for your application. Max length = 255.
Response
Param Required Type Description
success Yes Boolean Was the request a success or a failure. true or false. If false the error and errorCode will be available.
errorCode No Number Error code. All error codes are described below.
error No String String representation of the error.

Errors

Error Codes
Code Error
0 Unknown system error.
1 Invalid JSON.
2 API token missing.
3 Invalid API token. Api account not found.
4 visitOn missing.
5 Missing provider name.
6 Missing healthcare org. name.
7 Missing plan.
8 Invalid provider info. Please check field constraints.
9 May not change plan for existing provider.
10 ID missing.
11 Provider not found.
12 API account is suspended.
13 Visit not found.
14 Record has expired.
Loading