Guest

Generates a Guest token an Opentelemedicine appointment.

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

workflowUuidstringRequiredPattern: [^\/#\?]+?

Body

application/json

otpstringRequiredPattern: ^[0-9]{6}$

Responses

200Success

application/json

post

/api/open-tele/join/guest/{workflowUuid}

HTTPcURLJavaScriptPython

POST /api/open-tele/join/guest/{workflowUuid} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "otp": "text"
}

200Success

{
  "token": "abc123token",
  "appointment": {
    "id": "12345",
    "appointmentTypeId": "67890",
    "priority": "HIGH",
    "patientId": "54321",
    "consumerUuid": "uuid-1234",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "Male",
    "email": "[email protected]",
    "patientTimeZone": "America/New_York",
    "date": "2023-10-01T00:00:00Z",
    "startTime": "10:00",
    "endTime": "11:00",
    "startDateTime": "2023-10-01T10:00:00Z",
    "endDateTime": "2023-10-01T11:00:00Z",
    "token": "token-1234",
    "timeZone": "America/New_York",
    "note": "Patient requested a follow-up",
    "locationType": "GOOGLE_MAPS",
    "locationInfo": "Room 101",
    "externalId": "ext-12345",
    "attributes": {
      "key": "value"
    },
    "status": "BOOKED",
    "cancellationReason": "Patient no-show",
    "customCancellationReason": "Patient requested reschedule",
    "serviceProviderAttributes": {
      "key": "value"
    },
    "skipExternalSync": true,
    "parentResourceId": true,
    "isProviderUnavailable": true,
    "parentResource": {
      "id": "12345",
      "appointmentTypeId": "67890",
      "priority": "HIGH",
      "patientId": "54321",
      "consumerUuid": "uuid-1234",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01T00:00:00Z",
      "gender": "Male",
      "email": "[email protected]",
      "patientTimeZone": "America/New_York",
      "date": "2023-10-01T00:00:00Z",
      "startTime": "10:00",
      "endTime": "11:00",
      "startDateTime": "2023-10-01T10:00:00Z",
      "endDateTime": "2023-10-01T11:00:00Z",
      "token": "token-1234",
      "timeZone": "America/New_York",
      "note": "Patient requested a follow-up",
      "locationType": "GOOGLE_MAPS",
      "locationInfo": "Room 101",
      "externalId": "ext-12345",
      "attributes": {
        "key": "value"
      },
      "status": "BOOKED",
      "cancellationReason": "Patient no-show",
      "customCancellationReason": "Patient requested reschedule",
      "serviceProviderAttributes": {
        "key": "value"
      },
      "skipExternalSync": true,
      "parentResourceId": true,
      "isProviderUnavailable": true,
      "parentResource": {
        "id": "12345",
        "appointmentTypeId": "67890",
        "priority": "HIGH",
        "patientId": "54321",
        "consumerUuid": "uuid-1234",
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01T00:00:00Z",
        "gender": "Male",
        "email": "[email protected]",
        "patientTimeZone": "America/New_York",
        "date": "2023-10-01T00:00:00Z",
        "startTime": "10:00",
        "endTime": "11:00",
        "startDateTime": "2023-10-01T10:00:00Z",
        "endDateTime": "2023-10-01T11:00:00Z",
        "token": "token-1234",
        "timeZone": "America/New_York",
        "note": "Patient requested a follow-up",
        "locationType": "GOOGLE_MAPS",
        "locationInfo": "Room 101",
        "externalId": "ext-12345",
        "attributes": {
          "key": "value"
        },
        "status": "BOOKED",
        "cancellationReason": "Patient no-show",
        "customCancellationReason": "Patient requested reschedule",
        "serviceProviderAttributes": {
          "key": "value"
        },
        "skipExternalSync": true,
        "parentResourceId": true,
        "isProviderUnavailable": true,
        "parentResource": {
          "id": "12345",
          "appointmentTypeId": "67890",
          "priority": "HIGH",
          "patientId": "54321",
          "consumerUuid": "uuid-1234",
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01T00:00:00Z",
          "gender": "Male",
          "email": "[email protected]",
          "patientTimeZone": "America/New_York",
          "date": "2023-10-01T00:00:00Z",
          "startTime": "10:00",
          "endTime": "11:00",
          "startDateTime": "2023-10-01T10:00:00Z",
          "endDateTime": "2023-10-01T11:00:00Z",
          "token": "token-1234",
          "timeZone": "America/New_York",
          "note": "Patient requested a follow-up",
          "locationType": "GOOGLE_MAPS",
          "locationInfo": "Room 101",
          "externalId": "ext-12345",
          "attributes": {
            "key": "value"
          },
          "status": "BOOKED",
          "cancellationReason": "Patient no-show",
          "customCancellationReason": "Patient requested reschedule",
          "serviceProviderAttributes": {
            "key": "value"
          },
          "skipExternalSync": true,
          "parentResourceId": true,
          "isProviderUnavailable": true,
          "parentResource": {
            "id": "12345",
            "appointmentTypeId": "67890",
            "priority": "HIGH",
            "patientId": "54321",
            "consumerUuid": "uuid-1234",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01T00:00:00Z",
            "gender": "Male",
            "email": "[email protected]",
            "patientTimeZone": "America/New_York",
            "date": "2023-10-01T00:00:00Z",
            "startTime": "10:00",
            "endTime": "11:00",
            "startDateTime": "2023-10-01T10:00:00Z",
            "endDateTime": "2023-10-01T11:00:00Z",
            "token": "token-1234",
            "timeZone": "America/New_York",
            "note": "Patient requested a follow-up",
            "locationType": "GOOGLE_MAPS",
            "locationInfo": "Room 101",
            "externalId": "ext-12345",
            "attributes": {
              "key": "value"
            },
            "status": "BOOKED",
            "cancellationReason": "Patient no-show",
            "customCancellationReason": "Patient requested reschedule",
            "serviceProviderAttributes": {
              "key": "value"
            },
            "skipExternalSync": true,
            "parentResourceId": true,
            "isProviderUnavailable": true,
            "parentResource": "[Circular Reference]",
            "resources": "[Circular Reference]",
            "appointmentType": "[Circular Reference]",
            "participants": "[Circular Reference]",
            "relatedPatients": "[Circular Reference]",
            "relatedProviders": "[Circular Reference]",
            "appointmentWorkflow": {
              "id": "12345",
              "appointmentId": "67890",
              "workflowId": 1,
              "appointmentWorkflowTask": []
            },
            "updatedBy": {
              "key": "value"
            },
            "openTeleRoom": "[Circular Reference]",
            "patientMobileNumber": "[phone]",
            "schedulerAppointmentAction": [],
            "isAssigneeChanged": true,
            "appointmentLocationAddressId": 1,
            "appointmentLocationAddress": {
              "id": 12,
              "title": "Title",
              "line1": "10 Riverside",
              "line2": "Drive Mira Loma",
              "country": "United States",
              "state": "New Jersey",
              "district": "Passaic County",
              "city": "Woodland Park",
              "addressType": "PRIMARY",
              "zipCode": "123456",
              "latitude": 12.34,
              "longitude": 12.34,
              "deleted": true,
              "createdAt": "2021-01-01",
              "updatedAt": "2021-01-01"
            },
            "referralId": 1,
            "referral": "[Circular Reference]",
            "populationTags": [],
            "invoice": {
              "id": 123,
              "amount": "100.00",
              "personId": 123,
              "organizationId": 456,
              "status": "paid",
              "currency": "USD",
              "description": "Invoice for services rendered",
              "appointmentId": 789,
              "externalId": "ext_inv_123",
              "createdAt": "2023-01-01T00:00:00.000Z",
              "updatedAt": "2023-01-02T00:00:00.000Z",
              "invoiceToInvoiceItems": [],
              "url": "https://stripe.com/invoice/123"
            }
          },
          "resources": [],
          "appointmentType": {
            "id": "12345",
            "name": "Consultation",
            "priority": "HIGH",
            "description": "A brief consultation session",
            "durationInMinutes": 30,
            "appointmentTypeTemplateId": 1,
            "serviceProviderScheduleId": 2,
            "useDefaultAvailability": true,
            "overlappingSlots": true,
            "disabled": true,
            "externalId": "welkin-encounter-template",
            "schedulerSystemUserId": "user-123",
            "serviceProviderId": 1,
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-12-31T23:59:59Z",
            "color": "#FF5733",
            "locationType": "GOOGLE_MAPS",
            "userId": "user-456",
            "user": "[Circular Reference]",
            "maximumAppointmentsPerDay": 10,
            "maximumAppointmentsPerWeek": 1,
            "serviceProviderRole": "CLIENT_MANAGER",
            "bookingHorizon": 30,
            "attributes": {},
            "addressGroupId": 1,
            "addressGroup": "[Circular Reference]"
          },
          "participants": [],
          "relatedPatients": [],
          "relatedProviders": [],
          "appointmentWorkflow": {
            "id": "12345",
            "appointmentId": "67890",
            "workflowId": 1,
            "appointmentWorkflowTask": []
          },
          "updatedBy": {
            "key": "value"
          },
          "openTeleRoom": [],
          "patientMobileNumber": "[phone]",
          "schedulerAppointmentAction": [],
          "isAssigneeChanged": true,
          "appointmentLocationAddressId": 1,
          "appointmentLocationAddress": {
            "id": 12,
            "title": "Title",
            "line1": "10 Riverside",
            "line2": "Drive Mira Loma",
            "country": "United States",
            "state": "New Jersey",
            "district": "Passaic County",
            "city": "Woodland Park",
            "addressType": "PRIMARY",
            "zipCode": "123456",
            "latitude": 12.34,
            "longitude": 12.34,
            "deleted": true,
            "createdAt": "2021-01-01",
            "updatedAt": "2021-01-01"
          },
          "referralId": 1,
          "referral": {
            "id": 1,
            "patientId": 123,
            "patient": {},
            "requesterAgent": "12345",
            "requesterAgentType": "Organization",
            "requesterOnBehalfOf": "12345",
            "reason": "12345",
            "specialty": "cardiology",
            "description": "text",
            "source": "Zoho",
            "sourceId": "Zoho",
            "status": "draft",
            "default": true,
            "startDateTime": "2023-07-11T10:30:00Z",
            "expiryDateTime": "2023-07-11T10:30:00Z",
            "schedulerAppointments": "[Circular Reference]",
            "createdAt": "2023-07-11T10:30:00Z",
            "updatedAt": "2023-07-11T10:30:00Z"
          },
          "populationTags": [],
          "invoice": {
            "id": 123,
            "amount": "100.00",
            "personId": 123,
            "organizationId": 456,
            "status": "paid",
            "currency": "USD",
            "description": "Invoice for services rendered",
            "appointmentId": 789,
            "externalId": "ext_inv_123",
            "createdAt": "2023-01-01T00:00:00.000Z",
            "updatedAt": "2023-01-02T00:00:00.000Z",
            "invoiceToInvoiceItems": [],
            "url": "https://stripe.com/invoice/123"
          }
        },
        "resources": [],
        "appointmentType": {
          "id": "12345",
          "name": "Consultation",
          "priority": "HIGH",
          "description": "A brief consultation session",
          "durationInMinutes": 30,
          "appointmentTypeTemplateId": 1,
          "serviceProviderScheduleId": 2,
          "useDefaultAvailability": true,
          "overlappingSlots": true,
          "disabled": true,
          "externalId": "welkin-encounter-template",
          "schedulerSystemUserId": "user-123",
          "serviceProviderId": 1,
          "startDate": "2023-01-01T00:00:00Z",
          "endDate": "2023-12-31T23:59:59Z",
          "color": "#FF5733",
          "locationType": "GOOGLE_MAPS",
          "userId": "user-456",
          "user": "[Circular Reference]",
          "maximumAppointmentsPerDay": 10,
          "maximumAppointmentsPerWeek": 1,
          "serviceProviderRole": "CLIENT_MANAGER",
          "bookingHorizon": 30,
          "attributes": {},
          "addressGroupId": 1,
          "addressGroup": "[Circular Reference]"
        },
        "participants": [],
        "relatedPatients": [],
        "relatedProviders": [],
        "appointmentWorkflow": {
          "id": "12345",
          "appointmentId": "67890",
          "workflowId": 1,
          "appointmentWorkflowTask": []
        },
        "updatedBy": {
          "key": "value"
        },
        "openTeleRoom": [],
        "patientMobileNumber": "[phone]",
        "schedulerAppointmentAction": [],
        "isAssigneeChanged": true,
        "appointmentLocationAddressId": 1,
        "appointmentLocationAddress": {
          "id": 12,
          "title": "Title",
          "line1": "10 Riverside",
          "line2": "Drive Mira Loma",
          "country": "United States",
          "state": "New Jersey",
          "district": "Passaic County",
          "city": "Woodland Park",
          "addressType": "PRIMARY",
          "zipCode": "123456",
          "latitude": 12.34,
          "longitude": 12.34,
          "deleted": true,
          "createdAt": "2021-01-01",
          "updatedAt": "2021-01-01"
        },
        "referralId": 1,
        "referral": {
          "id": 1,
          "patientId": 123,
          "patient": {},
          "requesterAgent": "12345",
          "requesterAgentType": "Organization",
          "requesterOnBehalfOf": "12345",
          "reason": "12345",
          "specialty": "cardiology",
          "description": "text",
          "source": "Zoho",
          "sourceId": "Zoho",
          "status": "draft",
          "default": true,
          "startDateTime": "2023-07-11T10:30:00Z",
          "expiryDateTime": "2023-07-11T10:30:00Z",
          "schedulerAppointments": "[Circular Reference]",
          "createdAt": "2023-07-11T10:30:00Z",
          "updatedAt": "2023-07-11T10:30:00Z"
        },
        "populationTags": [],
        "invoice": {
          "id": 123,
          "amount": "100.00",
          "personId": 123,
          "organizationId": 456,
          "status": "paid",
          "currency": "USD",
          "description": "Invoice for services rendered",
          "appointmentId": 789,
          "externalId": "ext_inv_123",
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-02T00:00:00.000Z",
          "invoiceToInvoiceItems": [],
          "url": "https://stripe.com/invoice/123"
        }
      },
      "resources": [],
      "appointmentType": {
        "id": "12345",
        "name": "Consultation",
        "priority": "HIGH",
        "description": "A brief consultation session",
        "durationInMinutes": 30,
        "appointmentTypeTemplateId": 1,
        "serviceProviderScheduleId": 2,
        "useDefaultAvailability": true,
        "overlappingSlots": true,
        "disabled": true,
        "externalId": "welkin-encounter-template",
        "schedulerSystemUserId": "user-123",
        "serviceProviderId": 1,
        "startDate": "2023-01-01T00:00:00Z",
        "endDate": "2023-12-31T23:59:59Z",
        "color": "#FF5733",
        "locationType": "GOOGLE_MAPS",
        "userId": "user-456",
        "user": "[Circular Reference]",
        "maximumAppointmentsPerDay": 10,
        "maximumAppointmentsPerWeek": 1,
        "serviceProviderRole": "CLIENT_MANAGER",
        "bookingHorizon": 30,
        "attributes": {},
        "addressGroupId": 1,
        "addressGroup": "[Circular Reference]"
      },
      "participants": [],
      "relatedPatients": [],
      "relatedProviders": [],
      "appointmentWorkflow": {
        "id": "12345",
        "appointmentId": "67890",
        "workflowId": 1,
        "appointmentWorkflowTask": []
      },
      "updatedBy": {
        "key": "value"
      },
      "openTeleRoom": [],
      "patientMobileNumber": "[phone]",
      "schedulerAppointmentAction": [],
      "isAssigneeChanged": true,
      "appointmentLocationAddressId": 1,
      "appointmentLocationAddress": {
        "id": 12,
        "title": "Title",
        "line1": "10 Riverside",
        "line2": "Drive Mira Loma",
        "country": "United States",
        "state": "New Jersey",
        "district": "Passaic County",
        "city": "Woodland Park",
        "addressType": "PRIMARY",
        "zipCode": "123456",
        "latitude": 12.34,
        "longitude": 12.34,
        "deleted": true,
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01"
      },
      "referralId": 1,
      "referral": {
        "id": 1,
        "patientId": 123,
        "patient": {},
        "requesterAgent": "12345",
        "requesterAgentType": "Organization",
        "requesterOnBehalfOf": "12345",
        "reason": "12345",
        "specialty": "cardiology",
        "description": "text",
        "source": "Zoho",
        "sourceId": "Zoho",
        "status": "draft",
        "default": true,
        "startDateTime": "2023-07-11T10:30:00Z",
        "expiryDateTime": "2023-07-11T10:30:00Z",
        "schedulerAppointments": "[Circular Reference]",
        "createdAt": "2023-07-11T10:30:00Z",
        "updatedAt": "2023-07-11T10:30:00Z"
      },
      "populationTags": [],
      "invoice": {
        "id": 123,
        "amount": "100.00",
        "personId": 123,
        "organizationId": 456,
        "status": "paid",
        "currency": "USD",
        "description": "Invoice for services rendered",
        "appointmentId": 789,
        "externalId": "ext_inv_123",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-02T00:00:00.000Z",
        "invoiceToInvoiceItems": [],
        "url": "https://stripe.com/invoice/123"
      }
    },
    "resources": [],
    "appointmentType": {
      "id": "12345",
      "name": "Consultation",
      "priority": "HIGH",
      "description": "A brief consultation session",
      "durationInMinutes": 30,
      "appointmentTypeTemplateId": 1,
      "serviceProviderScheduleId": 2,
      "useDefaultAvailability": true,
      "overlappingSlots": true,
      "disabled": true,
      "externalId": "welkin-encounter-template",
      "schedulerSystemUserId": "user-123",
      "serviceProviderId": 1,
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-12-31T23:59:59Z",
      "color": "#FF5733",
      "locationType": "GOOGLE_MAPS",
      "userId": "user-456",
      "user": "[Circular Reference]",
      "maximumAppointmentsPerDay": 10,
      "maximumAppointmentsPerWeek": 1,
      "serviceProviderRole": "CLIENT_MANAGER",
      "bookingHorizon": 30,
      "attributes": {},
      "addressGroupId": 1,
      "addressGroup": "[Circular Reference]"
    },
    "participants": [],
    "relatedPatients": [],
    "relatedProviders": [],
    "appointmentWorkflow": {
      "id": "12345",
      "appointmentId": "67890",
      "workflowId": 1,
      "appointmentWorkflowTask": []
    },
    "updatedBy": {
      "key": "value"
    },
    "openTeleRoom": [],
    "patientMobileNumber": "[phone]",
    "schedulerAppointmentAction": [],
    "isAssigneeChanged": true,
    "appointmentLocationAddressId": 1,
    "appointmentLocationAddress": {
      "id": 12,
      "title": "Title",
      "line1": "10 Riverside",
      "line2": "Drive Mira Loma",
      "country": "United States",
      "state": "New Jersey",
      "district": "Passaic County",
      "city": "Woodland Park",
      "addressType": "PRIMARY",
      "zipCode": "123456",
      "latitude": 12.34,
      "longitude": 12.34,
      "deleted": true,
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01"
    },
    "referralId": 1,
    "referral": {
      "id": 1,
      "patientId": 123,
      "patient": {},
      "requesterAgent": "12345",
      "requesterAgentType": "Organization",
      "requesterOnBehalfOf": "12345",
      "reason": "12345",
      "specialty": "cardiology",
      "description": "text",
      "source": "Zoho",
      "sourceId": "Zoho",
      "status": "draft",
      "default": true,
      "startDateTime": "2023-07-11T10:30:00Z",
      "expiryDateTime": "2023-07-11T10:30:00Z",
      "schedulerAppointments": "[Circular Reference]",
      "createdAt": "2023-07-11T10:30:00Z",
      "updatedAt": "2023-07-11T10:30:00Z"
    },
    "populationTags": [],
    "invoice": {
      "id": 123,
      "amount": "100.00",
      "personId": 123,
      "organizationId": 456,
      "status": "paid",
      "currency": "USD",
      "description": "Invoice for services rendered",
      "appointmentId": 789,
      "externalId": "ext_inv_123",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-02T00:00:00.000Z",
      "invoiceToInvoiceItems": [],
      "url": "https://stripe.com/invoice/123"
    }
  }
}