Invite guest

Invites a Guest for an Opentelemedicine appointment with the appropriate meeting url and OTP.

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

consumerIdstringRequired

ID of the consumer

Example: 12345

dataobjectOptional

Additional data

Default: {}Example: {"key":"value"}

emailDataobjectOptional

Email related data

Default: {}Example: {"subject":"Hello"}

textDataobjectOptional

Text message related data

Default: {}Example: {"message":"Hi"}

Responses

200

Successful response

application/json

post

/api/open-tele/{appointmentId}/invite-guest

HTTPcURLJavaScriptPython

POST /api/open-tele/{appointmentId}/invite-guest 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: 105

{
  "consumerId": "12345",
  "data": {
    "key": "value"
  },
  "emailData": {
    "subject": "Hello"
  },
  "textData": {
    "message": "Hi"
  }
}

200

Successful response

No content