Doctor Consultation API

Enable Teleconsultation For Any Partner

Embed Web view or integrate via API call to show list of active doctors.

Call gets initiated right away. Allopath GP, Ayurveda, Homeopath doctors available.

Post call, Doctor generates Rx - automatically sent to user via SMS. Pushed back to partner via API call.

User Flow For Consult

myUpchar - Live Consult API: Get Live Doctors

https://beta.myupchar.com/api/v1/get_live_doctors_for_third_party?key=API_KEY&lang=en&name=USER_NAME&telephone=USER_TELEPHONE&age=USER_AGE&sex=USER_SEX&email=USER_EMAIL&speciality_id=SPECIALITY_ID

Where, you have to pass user details. User Email is optional and rest of the fields are required.
To filter the doctors list by speciality, pass speciality_id parameter. You can get the SPECIALITY_ID from live_doctor_specialities block

ID	Speciality
1	Cardiology
4	Orthopedics
7	ENT
10	Pediatrics
11	Dermatology
13	Dentistry
25	General Physician
26	Ayurveda
27	Homeopathy
29	Nutritionist
30	Dietician
45	Internal Medicine
66	Obstetrics & Gynaecology
67	Diabetology

For API_KEY contact myUpchar.

Expected response format:

{
  "status":200,
  "message":"Success",
  "data":{
    "livedoctor":{
       "live_doctor_list":[
          {
             "image_url":"https://doctor.myupchar.com/6322/test632220180910-17135-1iq6vb9.jpg",
             "id":6322,
             "name":"Dr. Atish Ranjan",
             "live_status":true,
             "live_status_text":"Available",
             "permalink":"https://www.myupchar.com/doctors/patna/kankarbagh/ent/dr-atish-ranjan-6322",
             "experience":12,
             "degree":"MBBS,DM",
             "speciality":"Emergency Medicine",
             "gender":"male",
             "specialist_doctor":true
          },
          {
             "image_url":"https://doctor.myupchar.com/18437/test1843720181129-1175-15cybye.jpg",
             "id":18437,
             "name":"Dr. Vikrant Mittal",
             "live_status":true,
             "live_status_text":"Available",
             "permalink":"https://www.myupchar.com/doctors/rupnagar/chandigarh-sector-59-s-o/ent/dr-vikrant-mittal-18437",
             "experience":9,
             "degree":"MBBS,MS",
             "speciality":"Infectious Disease",
             "gender":"male",
             "specialist_doctor":true
          },
          {
             "image_url":"https://doctor.myupchar.com/112895/20191110_124655.jpg",
             "id":112895,
             "name":"Dr. Anil Gupta",
             "live_status":false,
             "live_status_text":"Request a call back",
             "permalink":"https://www.myupchar.com/doctors/lucknow/aliganj/ent/dr-anil-gupta-112895",
             "experience":7,
             "degree":"MBBS,MS",
             "speciality":"ENT, Audiology & Speech Pathology",
             "gender":"male",
             "specialist_doctor":true
          },
          {
             "image_url":"https://doctor.myupchar.com/113329/IMG-20201204-WA0001.jpg",
             "id":113329,
             "name":"Dr. Navin Shukla",
             "live_status":false,
             "live_status_text":"Request a call back",
             "permalink":"https://www.myupchar.com/doctors/gwalior/moti-mahal-s-o/ent/dr-navin-shukla-113329",
             "experience":14,
             "degree":"MS",
             "speciality":"Oral & Maxillofacial Surgery",
             "gender":"male",
             "specialist_doctor":true
          }
       ]
    },
    "live_doctor_specialities":[
       {
          "id":1,
          "name":"Cardiology"
       },
       {
          "id":2,
          "name":"Oncology"
       },
       {
          "id":3,
          "name":"Neurology"
       },
       {
          "id":4,
          "name":"Orthopedics"
       },
       {
          "id":7,
          "name":"ENT"
       },
       {
          "id":8,
          "name":"Urology"
       },
       {
          "id":9,
          "name":"Ophthalmology"
       },
       {
          "id":10,
          "name":"Pediatrics"
       },
       {
          "id":11,
          "name":"Dermatology"
       },
       {
          "id":12,
          "name":"Psychiatry"
       },
       {
          "id":13,
          "name":"Dentistry"
       },
       {
          "id":18,
          "name":"General Surgery"
       },
       {
          "id":25,
          "name":"General Physician"
       },
       {
          "id":26,
          "name":"Ayurveda"
       },
       {
          "id":27,
          "name":"Homeopathy"
       },
       {
          "id":30,
          "name":"Dietician"
       },
       {
          "id":45,
          "name":"Internal Medicine"
       },
       {
          "id":47,
          "name":"Neurosurgery"
       },
       {
          "id":66,
          "name":"Obstetrics & Gynaecology"
       }
    ],
    "user":{
       "user_id":117952
    }
  }
}

Copy

Where id in live_doctor_list array is doctor_id. doctor_id will be passed in Call Doctor API.

myUpchar - Live Consult API: Call Doctor API

https://beta.myupchar.com/api/v1/call_doctor_third_party?key=API_KEY&user_id=USER_ID&doctor_id=DOCTOR_ID&lab_report_url=LAB_REPORT_URL

Where, you will get USER_ID and DOCTOR_ID from the response of the first API.
LAB_REPORT_URL is a url for user's lab report (like blood report or xray) and this field is optional.

Expected response format:

{  "status": 200,  "message": "Success",  "data": {    "thread_id": 1585896,    "user_id": 117952,    "doctor_id": 27984  },  "call_response": "Your call has been initiated"}

Expected response format for Request a callback doctors:

{  "status": 200,  "message": "Success",  "data": {    "thread_id": 1585896,    "user_id": 117952,    "doctor_id": 27984  },  "call_response": "Doctor will contact you within 24 hours. Please be available on the phone."}

Copy

NOTE: In Beta, a call will be placed with an internal testing number no matter which doctor_id is passed.

myUpchar - Live Consult API: Get Rx

https://beta.myupchar.com/api/get_rx_third_party?key=API_KEY&thread_id=THREAD_ID

Where, THREAD_ID is provided in the response from Call Doctor API. status in response can be 200 (message: success) or 201 (message: Consultation Thread not present)

Expected response format:

{"status":200,"message":"success","data":{ "prescription_id" : 332345 "prescription_url" : "https://www.myupchar.com/prescriptions/show_pdf/xxx.pdf"}}

Copy

myUpchar - Live Consult API: Get Address

https://beta.myupchar.com/api/v1/user_addresses?key=API_KEY&user_id=USER_ID

Expected response format:

{
  "status": 200,
  "data": [
    {
    "address_id": 384366,
    "full_address": "User Name 702, Eastern Majesty, Tata Colony, Delhi, 201005 Mobile: 99xxxxxxxx"
    },
    {
    "address_id": 427790,
    "full_address": "User Name 2003, Near Eastern Majesty, Tata Colony, Delhi, 201005 Mobile: 99xxxxxxxx"
    }
  ]
}

Copy

myUpchar - Live Consult API: Create Address

https://beta.myupchar.com/api/v1/add_user_address?key=API_KEY&user_id=USER_ID&user_name=USER_NAME&mobile=MOBILE&address_line1=ADDRESS_LINE1&address_line2=ADDRESS_LINE2&pincode=PINCODE&city=CITY&state=STATE

Where, you have to pass the user address details all fields are required.

Expected response format:

{
  "status": 200,
  "message": "Address added Successfully",
  "address_id": 431588
}

Copy

myUpchar - Live Consult API: Order Prescription Medicines

https://beta.myupchar.com/api/v1/order_prescription_medicine?key=API_KEY&user_id=USER_ID&prescription_id=PRESCRIPTION_ID&address_id=ADDRESS_ID

Where, you will get the PRESCRIPTION_ID from get RX API response and ADDRESS_ID from Get Address Api response.

Expected response format:

{
  "status": 200,
  "message": "Order Placed Successfully",
  "data": {
    "order_id": 4300138,
    "payment_mode": "COD",
    "amount": 437.3
  }
}

Copy

myUpchar - Doctor Consultation API

Enable Teleconsultation For Any Partner

User Flow For Consult

myUpchar - Live Consult API: Get Live Doctors

myUpchar - Live Consult API: Call Doctor API

myUpchar - Live Consult API: Get Rx

myUpchar - Live Consult API: Get Address

myUpchar - Live Consult API: Create Address

myUpchar - Live Consult API: Order Prescription Medicines