Create Online Visit Link

📘

Endpoint only available to clients utilizing Telegra's Online Visit System

Start with the patient dashboard url.

  • https://{put-environment-base-url}.telegramd.com
  • If you have set up a custom white-labeled domain, it will be used instead.

Add the online visit route to the patient dashboard url

  • https://{put-environment-base-url}.telegramd.com/startVisit

Add required and non-required query parameters to the url


  • Provide the affiliate query parameter to view white-labeling
    • https://{put-environment-base-url}.telegramd.com?affiliate={affiliate-id}
    • https://{put-environment-base-url}.telegramd.com?affiliate=aff::f3c45ff5-f307-4d2f-a883-19d370482181
  • Redirect the patient to any site after the OVS is complete
    • https://{put-environment-base-url}.telegramd.com?redirectUrl={redirect-url}
    • https://{put-environment-base-url}.telegramd.com?redirectUrl=https://wikipedia.com

Post-checkout flow (Order exists)

  • Add the order ID to the orderId query parameter
    • https://{put-environment-base-url}.telegramd.com?orderId={order-id}
    • https://{put-environment-base-url}.telegramd.com?orderId=order::adf80681-8eee-4230-b582-e68e8c7e1b02

Pre-checkout flow (Create order after intake)

  • Add the product variation ID and quantity
    • https://{put-environment-base-url}.telegramd.com?productVariations={"productVariation":"pvt::0f8f8856-xxxx-xxxx-xxxx-c195ffc992a1", "quantity": "1"}]