• Release Notes
  • User
  • Admin
  • Developers
  • Integrations

›REST API Examples

General

  • Co-Browsing
  • Universal Embedded Co-Browsing
  • Chat
  • Videocalling with Queue
  • Generate API Token

External

  • Salesforce
  • Outlook
  • Freshdesk
  • Microsoft Teams
  • ZealiD
  • Individual Platform

Data

  • Audit Logs

Use Cases

  • CoBrowsing - Example
  • SessionRecording - Optin/Optout button
  • UserTagging & Login Example
  • UserTagging & Screensharing Example
  • Mobile user tagging & LiveView
  • WebChat API - Example
  • ActionRules Matched API - Example

REST API Examples

  • Agent Times
  • Rule matches
  • Appointments
  • Universal Co-Browsing

REST Example - Appointments

This page gives an example to create meeting links and optionally download the recording of the meeting.

Create appointment

With the following API you can create an appointment: https://developers.chatvisor.com/#operation/createUsingPOST

Request
Response
POST https://api.chatvisor.com/rest/v1/appointment?access_token=<TOKEN>

BODY:
{
"attendees": [
"test2@engage.teamviewer.com"
],
"date": "2020-11-11T13:10:00",
"description": "Testdescription",
"durationInMinutes": 30,
"timezoneId": "Europe/Vienna",
"owner": "test@engage.teamviewer.com",
"password": "testpassword",
"record": false,
"sendInviteEmail": false,
"title": "Testappointment",
"validAfter": 13245,
"validBefore": 13245,
"validType": "HOURS",
"customProperties": {"property1": "propertyvalue"}
}
{
"title": "Testappointment",
"description": "Testdescription",
"durationInMinutes": 30,
"date": "2020-11-11T13:10:00.000Z",
"timezoneId": "Europe/Vienna",
"record": false,
"owner": "test@engage.teamviewer.com",
"password": "testpassword",
"attendees": [
"test@engage.teamviewer.com",
"test2@engage.teamviewer.com"
],
"sendInviteEmail": false,
"customerId": "13245",
"validAfter": 13245,
"validBefore": 13245,
"validType": "HOURS",
"customProperties": {
"property1": "propertyvalue"
},
"id": "eisjehlrvflgrgltklazspwq",
"urls": {
"publicUrl": "<URL>",
"agentUrl": "<URL>"
}
}

Download recording

List recordings

Before you can download a recording you have to list the recordings based on the customerId. https://developers.chatvisor.com/#operation/listUsingGET_3

The customerId is equal to the appointment id if the appointment was created without customerId.

Download recording

Use the ID of the recording what you get from listing the recordings and use is for downloading the recording.

Request
GET https://api.chatvisor.com/rest/v1/callrecording/download/<ID>?access_token=<TOKEN>
← Rule matchesUniversal Co-Browsing →
  • Create appointment
  • Download recording
    • List recordings
    • Download recording
MANUALS
User Manual: Sales Suite
Admin Manual: Sales Suite
User Manual: Support Suite
Admin Manual: Support Suite
DEVELOPERS
Integrations
REST API
SDK API
LEGAL
Privacy Policy
Terms and Conditions
Imprint
Engage
Copyright © 2024 TeamViewer Austria GmbH