logo
API docs by Redocly

TeamViewer Engage Developer Documentation (v1.9)

Download OpenAPI specification:Download

TeamViewer Engage: engage-service@teamviewer.com URL: https://developers.engage.teamviewer.com Terms of Service

Authentication

The API uses a token based authentication mechanism. A client sends a token as an URL parameter or as a Bearer Token with every request in order to authenticate itself. Tokens can be created by any admin user in the Backend Settings Engage / Chatvisor at Settings > Developer tools > API keys.

Example: URL Parameter

https://app.chatvisor.com/rest/v1/example?access_token=myaccesstoken

Example: Bearer Token

Authorization: Bearer myaccesstoken

Authorization

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

access_token

Security Scheme Type: API Key
Query parameter name: access_token

WebHooks

In order to deliver real-time information about customer interactions, a web hook mechanism is used. REST endpoints configured by the admin user are notified by a HTTP POST request of certain events.

New conversation

This WebHook is triggered if a new customer is created or a existing customer changes from the state "DONE" to "UNREAD". It sends a Conversation object as defined below:

{
  "customerId": "string",
  "status": "UNREAD | DONE | UNRESOLVED",
  "lastMessage": {
    "test": "string"
  },
  "url": "string"
}

Status change

This hook is triggered at any change of the customer status. It receives a Conversation object like the WebHook for new conversations.

New message

Triggered when a new message arrived from a customer.

For the message format see Message

Customer Status

Tag and list active customers

Query a Customer

Query a single customer. Matched against all fields.

path Parameters
query
required
string

Responses

Get a list of active customers.

List customers. Only returns assigned users if user token is used.

Responses

Customer

Customers are accounts that interacted with your tenant through a channel and can send and received message

Assign customer

Assign the customer to a user or to a team. Team and user are mutually exclusive.

path Parameters
The id of the customer
required
string
query Parameters
The id of the user
string
The id of the team
string

Responses

Set status

Set the status of a customer manually.

path Parameters
The id of the customer
required
string
Request Body schema: application/json
required
string
Value: "UNREAD, UNRESOLVED, DONE"

Responses

Request samples

Content type
application/json
"UNREAD, UNRESOLVED, DONE"

List all customers

query Parameters
required
object (PageinationAPIDTO)

Responses

Create customer

Create a new customer.

Request Body schema: application/json
required
id
string

The unique identifier

email
string

E-Mail address

firstName
string

First name

lastName
string

Last name

gender
string
Enum: "female" "other" "male" "none"

The gender

externalId
string

Your ID within your organization

assignedUser
string

Assigned user

Responses

Request samples

Content type
application/json
{
  • "id": "5c593c728b02502bc3f8ffe1",
  • "email": "john.doe@example.com",
  • "firstName": "John",
  • "lastName": "Doe",
  • "gender": "MALE",
  • "externalId": "12345",
  • "assignedUser": "testuser@chatvisor.com"
}

Retrieve a customer

path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Report Chat

Get chat data as report

Get agent metrics

Get agent metrics splitted by conversation

Request Body schema: application/json
required
From Date (unix timestamp in milliseconds)
integer <int64>
To Date (unix timestamp in milliseconds)
integer <int64>
grouping
string
Enum: "TODAY" "TODAY_BY_MINUTE" "LAST_7_DAYS" "LAST_MONTH" "LAST_YEAR" "CUSTOM" "ALL"

Responses

Request samples

Content type
application/json
"Select the date range where you want to query"

Get conversation messages

Get messages of given conversation.

query Parameters
conversationId
required
string

Responses

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (ChatReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Get conversation metrics

Get conversations with measured metrics included.

Request Body schema: application/json
required
From Date (unix timestamp in milliseconds)
integer <int64>
To Date (unix timestamp in milliseconds)
integer <int64>
grouping
string
Enum: "TODAY" "TODAY_BY_MINUTE" "LAST_7_DAYS" "LAST_MONTH" "LAST_YEAR" "CUSTOM" "ALL"

Responses

Request samples

Content type
application/json
"Select the date range where you want to query"

Resource

Recorded Resource requests.

List all Resources

query Parameters
required
object (PageinationAPIDTO)

Responses

Filter resources

Request Body schema: application/json
required
resourceName
string

name filter

sessionId
string

sessionId filter

visitId
string

visitId filter

visitorIds
Array of strings unique

visitorId filter

externalIds
Array of strings unique

externalId filter

statusCode
integer <int32>

statuscode filter

type
string

Type filter

object (BooleanArrayFilterString)

Tags filter

object (DateFilterAPIDTO)

Date filter

groupBy
string
Enum: "RESOURCE_NAME" "SESSION_ID" "VISIT_ID" "VISITOR_ID" "EXTERNAL_ID" "TYPE" "PATH" "URL" "STATUS_CODE"

GroupBy property

path
string

Path filter

url
string

Url filter

object (Criteria)

Responses

Request samples

Content type
application/json
{
  • "resourceName": "Filters the resources for name",
  • "sessionId": "Filters the resources for a specific session",
  • "visitId": "Filters the resources for a specific visit",
  • "visitorIds": "Filters the resources for a specific visitor",
  • "externalIds": "Filters the resources for a visitor with Id set through js api 'CV.user.tag()'",
  • "statusCode": 0,
  • "type": "Filters the resources for types",
  • "tags": "Filters the CoBrowsing sessions for tags",
  • "dateFilter": "Select the date range where you want to query",
  • "groupBy": "groups the resources by the property and averages resources with the same name in their groups",
  • "path": "Filters the resources for a website path",
  • "url": "Filters the resources for a website url",
  • "criteria": {
    }
}

Chat

Manage the chat

Get Visibility Status

Returns the visible status of the chat

Responses

Set Chat Visibility

Set the visibility status of the chat

query Parameters
visible
required
boolean

Responses

Opening Hours

Define opening hours for your tenant. Can be used for rules.

Retrieve Opening Hours

Responses

Add new opening hours

Request Body schema: application/json
required
name
string
Default: "Name of the opening hours"
id
string

Unique id of the opening hours

timezoneOffset
integer <int32>

Timezone offset

Array of objects (OpeningHourConditionDTO)
Array of objects (OpeningHourHolidayDTO)

Responses

Request samples

Content type
application/json
{
  • "name": "Name of the opening hours",
  • "id": "string",
  • "timezoneOffset": 1,
  • "conditions": [
    ],
  • "holidays": [
    ]
}

Statistics

statistics

LiveView

Retrieves statistics about LiveView sessions

query Parameters
from
required
integer <int64>
Example: from=1553593383000

Start timestamp (UNIX timestamp with milliseconds)

to
required
integer <int64>
Example: to=1553593383000

End timestamp (UNIX timestamp with milliseconds)

Responses

LiveChat

Retrieves statistics about LiveChat conversations

query Parameters
from
required
integer <int64>
Example: from=1553593383000

Start timestamp (UNIX timestamp with milliseconds)

to
required
integer <int64>
Example: to=1553593383000

End timestamp (UNIX timestamp with milliseconds)

Responses

Report Realtime Metrics

Get realtime metrics

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (RealtimeReportMetricFilterEntryAPIDTO)

Metric filters

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ]
}

Report CoBrowse

Get Co-Browsing data as report

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (CoBrowseReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Get Cobrowse table reports

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (CoBrowseReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

System Messages

Manage your system messages.

Delete languages

All system messages of this language will be deleted

path Parameters
Language key
required
string
Example: en

Responses

Get messages of language

Get the language keys of your system messages

path Parameters
Language key
required
string
Example: en

Responses

Create/Replace system message

If the id already exists, it will be overridden.

Request Body schema: application/json
required
message
string

Text of the system message.

id
string

ID of the system message.

language
string

Language of the system message.

Responses

Request samples

Content type
application/json
{
  • "message": "Hello world",
  • "id": "helloworld",
  • "language": "en"
}

Get languages

Get the language keys of your system messages

Responses

User

Manage users of your tenant

Retrieve a user

path Parameters
userId
required
string

The unique identifier of the user

Responses

Delete a user

path Parameters
userId
required
string

The id of the user to delete

Responses

List all users

query Parameters
required
object (PageinationAPIDTO)

Responses

Create a new user

Request Body schema: application/json
required
externalId
string

Unique external identifier of the user

email
required
string

E-Mail address of the user

displayName
string

Displayname of the user

description
string

Description of the user

roleId
string

Role assigned to user (If the user is an admin, the static constant "ADMIN" is set)

password
string

Password of the user

tags
Array of strings unique

Tags assigned to user

mcoEnabled
boolean

Enables or disables MCO-Integration

admin
boolean

Responses

Request samples

Content type
application/json
{
  • "externalId": "5c593c728b02502bc3f8ffe1",
  • "email": "john.doe@example.com",
  • "displayName": "Stephen Brown",
  • "description": "Responsible for usecase X",
  • "roleId": "5c593c728b02502bc3f8ffe1",
  • "password": "Password123",
  • "tags": [
    ],
  • "mcoEnabled": true,
  • "admin": true
}

Assign a user to a role

Adds a user to an existing role

path Parameters
userId
required
string

The id of the user to assign

query Parameters
roleId
required
string

The identifier of the role that should be assigned to the user

Responses

Assign tag to user

query Parameters
userEmail
required
string
tag
required
string

Responses

Report Agent

Get agent data as report

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (AgentReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Get agent login times

Get times how long the agents where logged in.

Request Body schema: application/json
required
From Date (unix timestamp in milliseconds)
integer <int64>
To Date (unix timestamp in milliseconds)
integer <int64>
grouping
string
Enum: "TODAY" "TODAY_BY_MINUTE" "LAST_7_DAYS" "LAST_MONTH" "LAST_YEAR" "CUSTOM" "ALL"

Responses

Request samples

Content type
application/json
"Select the date range where you want to query"

Get agent online times

Get times how long the agents where online.

Request Body schema: application/json
required
From Date (unix timestamp in milliseconds)
integer <int64>
To Date (unix timestamp in milliseconds)
integer <int64>
grouping
string
Enum: "TODAY" "TODAY_BY_MINUTE" "LAST_7_DAYS" "LAST_MONTH" "LAST_YEAR" "CUSTOM" "ALL"

Responses

Request samples

Content type
application/json
"Select the date range where you want to query"

Session

Recorded website visitor sessions. A session includes the whole path until the visitor closes the browser.

Retrieve a session

path Parameters
sessionId
required
string

The id of the session to retrieve

Responses

Delete a session

path Parameters
sessionId
required
string

The id of the session to delete

Responses

List all sessions

query Parameters
unused
required
string
required
object (PageinationAPIDTO)

Responses

Find sessions by tags filter

Request Body schema: application/json
required
object (Pageable)
object (SessionFilter)

A tags filter for sessions

Responses

Request samples

Content type
application/json
{
  • "pageable": {
    },
  • "tagFilter": {
    }
}

Report Rules

Get rule data as report

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (RuleReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Report Message

Get message data as report

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (MessageReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

JsError

Recorded a JavaScript Error.

List all JsErrors

query Parameters
filter
required
string
required
object (PageinationAPIDTO)

Responses

Filter JSErrors

Request Body schema: application/json
required
sessionId filter
string
visitorId filter
Array of strings unique
externalId filter
Array of strings unique
object (DateFilterAPIDTO)

Date filter

object (BooleanArrayFilterString)

Tags filter

Path filter
string
Url filter
string
fileName
string

filename filter

object (Criteria)

Responses

Request samples

Content type
application/json
{
  • "sessionId filter": "Filters for a specific session",
  • "visitorId filter": "Filters for a specific visitor",
  • "externalId filter": "Filters for a visitor with Id set through API",
  • "dateFilter": "Select the date range where you want to query",
  • "Tags filter": "Filters the CoBrowsing sessions for tags",
  • "Path filter": "Filters the resources for a website path",
  • "Url filter": "Filters the resources for a website url",
  • "fileName": "Filters the errors for a file",
  • "criteria": {
    }
}

Activity

View information about user activity in backend. These are log events of certain parts of the application, for instance when a user sends a message or calls a customer

Call

Events that happen when a user calls a customer

query Parameters
required
object (Pageable)

Responses

LiveChat

Message send events

query Parameters
required
object (Pageable)

Responses

Status

Changes in the status of a customer (e.g. user sets the customer status to DONE)

query Parameters
required
object (Pageable)

Responses

LiveView

Events for Co-browsing (e.g. a session is started)

query Parameters
required
object (Pageable)

Responses

Report Session

Get session data as report

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (SessionReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

CoBrowsing

Generate public links to join a session/chat.

Generate a link-pair for Universal CoBrowsing

Generates two Universal CoBrowsing links with a random session id. One for the host and one for the user(s) to join the session.

query Parameters
url
required
string

The url the Universal CoBrowsing session should start with

userEmail
string

The email of the tenant user, which hosts this session

Responses

Team

Teams are group of users that a user can be assigned to

Retrieve a team

path Parameters
teamId
required
string

The id of the team to retrieve

Responses

Delete a team

path Parameters
teamId
required
string

The id of the team to delete

Responses

Assign tag to team

query Parameters
teamId
required
string
tag
required
string

Responses

Retrieve the availability status of a team

path Parameters
teamId
required
string

The id of the team

Responses

List all teams

query Parameters
unused
required
string
required
object (PageinationAPIDTO)

Responses

Create a team

Request Body schema: application/json
required
id
string

The unique identifier

name
string

The name

members
Array of strings

Team members (The ids of the team member users)

tags
Array of strings unique

Tags of the team

Responses

Request samples

Content type
application/json
{
  • "id": "5c593c728b02502bc3f8ffe1",
  • "name": "Product X experts",
  • "members": [
    ],
  • "tags": [
    ]
}

Add user

Adds a user to an existing team

path Parameters
teamId
required
string

The id of the team

query Parameters
userId
required
string

The id of the user to add

Responses

Role

Manage roles of users

Retrieve a role

path Parameters
roleId
required
string

The unique identifier of the role

Responses

Delete a role

path Parameters
roleId
required
string

The id of the role to delete

Responses

List all defined roles

query Parameters
required
object (PageinationAPIDTO)

Responses

Report Session Metrics

Get session metric data as report

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (SessionMetricReasonReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Report Visit

Get visit data as report

Get visit table reports

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (VisitReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Get Visit Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (VisitReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Report Conference

Get conference data as report

Get Report

Get data based on the filters you provided.

Request Body schema: application/json
required
Array of objects (ConferenceReportMetricFilterEntryAPIDTO)

Metric filters

object (DateFilterAPIDTO)

Date filter

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dateFilter": "Select the date range where you want to query"
}

Watchdogs

Define triggers when a notification should be sent.

Retrieve Watchdog

Responses

Add new watchdog

Request Body schema: application/json
required
id
string
name
string
watchdogType
string
Enum: "JAVASCRIPT_ERROR" "MESSAGE_RECEIVED" "CUSTOMER_ASSIGNED" "FORM_SUBMISSION" "SETTING_CHANGED"
Array of objects (WatchdogReceiver)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "watchdogType": "JAVASCRIPT_ERROR",
  • "receivers": [
    ]
}

Delete watchdog

query Parameters
watchdogId
required
string

Responses

Routing Rules

Routing rules and routing actions.

Retrieve a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to retrieve

Responses

Delete a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to delete

Responses

Dectivate a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to deactivate

Responses

Activate a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to activate

Responses

List the rules

List rules

Responses

Create a rule

Create a rule.

Request Body schema: application/json
required
name
string

Name of the routing rule.

Array of HAS_ID (object) or HasTagRuleConditionAPIDTO (object) or NoAnswerRuleConditionAPIDTO (object) or OpeningHourRuleConditionAPIDTO (object) or UrlRoutingRuleConditionAPIDTO (object)

The conditions when the rule should match.

types
Array of strings unique
Items Enum: "CHAT" "CALL"

For which type the rule should be applied.

elseRules
Array of objects (RoutingRule)

Fallback rules when the actual rule does not match.

Array of QueueRoutingAction (object) or RoutingToRoutingAction (object) or SendFlowRoutingAction (object) or SystemMessageRoutingAction (object)

Actions which should be triggered for the rule.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "conditions": [
    ],
  • "types": [
    ],
  • "elseRules": [
    ],
  • "actions": [
    ]
}

Call Recording

Get list of call recordings.

Download recording

Download the file of a recording

path Parameters
ID of the recording
required
string
Example: 5c593c9c8b02502bc3f8ffe3
query Parameters
(Optional) The channel to download for split recordings
integer <int32>

Responses

List recordings

List the recordings of calls

query Parameters
(Optional) The customerId of the appointment
string
Example: (Optional) The customerId of the appointment=5c593c9c8b02502bc3f8ffe3

Responses

Delete recording

Delete a single recording

Responses

Visit

Recorded website visits. A visit includes one access of the website.

Retrieve a visit

path Parameters
visitId
required
string

The id of the visit to retrieve

Responses

List all visits

query Parameters
filter
required
string
required
object (PageinationAPIDTO)

Responses

Tenants

Manage and list your tenants. For authentication please use the private user key what you can generate at Settings/API

Get Queue Status

List the current queue status of all your tenants.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get online status of your agents

List the tenants and the online status of the agents.

Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Active Sessions

Session data for customer support.

Active Sessions

Get the active LiveView sessions

Responses

Message

Manage chat messages to and from customers including sending new messages

Send a message to a customer

The request body is used as the message text.

path Parameters
customerId
required
string

The id of the customer

query Parameters
isExternalId
required
boolean

The id is an external id

Request Body schema: application/json
required
message
string

Text message

type
required
string
Enum: "MESSAGE" "AUDIO" "VIDEO" "FILE" "CARD"

Type of message

url
string

URL to file

buttonLink
string

Link of button

buttonText
string

Text of button

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "type": "MESSAGE",
  • "url": "string",
  • "buttonLink": "string",
  • "buttonText": "string"
}

List all messages

query Parameters
customerId
required
string

The id of the customer to filter the message

required
object (PageinationAPIDTO)

Responses

SLA Rules

SLA rules.

Retrieve a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to retrieve

Responses

Delete a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to delete

Responses

List the rules

List rules

Responses

Create a rule

Create a rule.

Request Body schema: application/json
required
name
string

Name of the routing rule.

Array of HAS_ID (object) or HasTagRuleConditionAPIDTO (object) or NoAnswerRuleConditionAPIDTO (object) or OpeningHourRuleConditionAPIDTO (object) or UrlRoutingRuleConditionAPIDTO (object)

The conditions when the rule should match.

object (SLATrigger)
Default: "Defined SLA response times"
Array of objects (WatchdogReceiver)
Default: "Defined SLA receivers if no target is matched"
watchdogEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "conditions": [
    ],
  • "trigger": "Defined SLA response times",
  • "receivers": "Defined SLA receivers if no target is matched",
  • "watchdogEnabled": true
}

Activate a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to activate

Responses

Dectivate a rule

path Parameters
ruleId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the rule to deactivate

Responses

Appointment

Manage the appointments of each user.

List appointments

List the appointments

Responses

Create an appointment

Create an appointment.

Request Body schema: application/json
required
title
required
string

Title

description
string

Description

durationInMinutes
integer <int32>

Duration

date
string <date-time>

Date of the appointment

timezoneId
string

TimezoneID

record
boolean

If appointment is automatically recorded

owner
string

Owner of the appointment

password
string

Password of the appointment

attendees
Array of strings unique

Attendee e-mails

sendInviteEmail
boolean

Send invite emails to all attendees

customerId
string

CustomerId of the appointment

valid
boolean

If appointment is valid (default = true)

validAfter
integer <int32>

Valid for X hours after the appointment

validBefore
integer <int32>

Valid for X hours before the appointment

validType
string
Enum: "HOURS" "APPOINTMENT"

How long the appointment link should be valid

object

Custom properties for the appointment

object (AppointmentAPIPermissions)

Permissions for the specific conference

Responses

Request samples

Content type
application/json
{
  • "title": "Testappointment",
  • "description": "Testdescription",
  • "durationInMinutes": 30,
  • "date": "2019-08-24T14:15:22Z",
  • "timezoneId": "Europe/Vienna",
  • "record": false,
  • "owner": "test@test.com",
  • "password": "testpassword",
  • "attendees": "[ test@test.com, test1@test.com ]",
  • "sendInviteEmail": true,
  • "customerId": "13245",
  • "valid": true,
  • "validAfter": 13245,
  • "validBefore": 13245,
  • "validType": "HOURS",
  • "customProperties": {
    },
  • "permissions": {
    }
}

Retrieve an appointment

path Parameters
appointmentId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the appointment to retrieve

Responses

Update an appointment

Update an appointment.

path Parameters
appointmentId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the appointment to update

Request Body schema: application/json
required
title
required
string

Title

description
string

Description

durationInMinutes
integer <int32>

Duration

date
string <date-time>

Date of the appointment

timezoneId
string

TimezoneID

record
boolean

If appointment is automatically recorded

owner
string

Owner of the appointment

password
string

Password of the appointment

attendees
Array of strings unique

Attendee e-mails

sendInviteEmail
boolean

Send invite emails to all attendees

customerId
string

CustomerId of the appointment

valid
boolean

If appointment is valid (default = true)

validAfter
integer <int32>

Valid for X hours after the appointment

validBefore
integer <int32>

Valid for X hours before the appointment

validType
string
Enum: "HOURS" "APPOINTMENT"

How long the appointment link should be valid

object

Custom properties for the appointment

object (AppointmentAPIPermissions)

Permissions for the specific conference

Responses

Request samples

Content type
application/json
{
  • "title": "Testappointment",
  • "description": "Testdescription",
  • "durationInMinutes": 30,
  • "date": "2019-08-24T14:15:22Z",
  • "timezoneId": "Europe/Vienna",
  • "record": false,
  • "owner": "test@test.com",
  • "password": "testpassword",
  • "attendees": "[ test@test.com, test1@test.com ]",
  • "sendInviteEmail": true,
  • "customerId": "13245",
  • "valid": true,
  • "validAfter": 13245,
  • "validBefore": 13245,
  • "validType": "HOURS",
  • "customProperties": {
    },
  • "permissions": {
    }
}

Delete an appointment

path Parameters
appointmentId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the appointment to delete

Responses

Get running status

Get status if appointment is currently running.

path Parameters
appointmentId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the appointment to get the running status from

Responses

Update appointment properties

Update appointment properties.

path Parameters
appointmentId
required
string
Example: 5c593c9c8b02502bc3f8ffe3

The identifier of the appointment to update

Request Body schema: application/json
required
record
boolean

If appointment is automatically recorded

Responses

Request samples

Content type
application/json
{
  • "record": false
}

LiveView by session id and user

Generate a public link by session id (with user, who is automatically logged in) which joins a LiveView session

path Parameters
sessionId
required
string

The sessionId of the session

email
required
string

The email of the user

query Parameters
language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses

Recording

Generate a public link to play a recording by session id

path Parameters
sessionId
required
string

The sessionId of the recording

query Parameters
language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses

Chat

Generate a public link to get to the chat

path Parameters
email
required
string

The login email of the agent

query Parameters
language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses

getPreSignedEngageUrl

path Parameters
email
required
string

The login email of the agent

query Parameters
redirectPath
required
string

The path which should be redirected to

language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses

LiveView by session id

Generate a public link by session id which joins a LiveView session

path Parameters
sessionId
required
string

The sessionId of the session

query Parameters
language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses

Co-Browsing Join Page

Generate a public link to get to the Co-Browsing join page

path Parameters
email
required
string

The login email of the agent

query Parameters
language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses

Chat by Customer

Generate a public link to get to the chat

path Parameters
email
required
string

The login email of the agent

customerId
required
string

The customerId of the chat

query Parameters
language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses

LiveView by share id

Generate a public link by share id which joins a LiveView session

path Parameters
shareId
required
string

The shareId of the session

query Parameters
language
string

Desired UI language (Default: en, Available: en,de,jp,uk,ru)

Responses