# TeamViewer

> Manage remote devices, contacts, groups and support sessions; read users and connection reports.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/teamviewer

## Actions

### Create group

Creates a group.

**Inputs**

- Name (`name`, text, required): Name.
- Policy ID (`policy_id`, text): Policy ID.

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "id": "example",
    "name": "example",
    "owner": {
      "alias": "example",
      "name": "example",
      "userid": "example"
    },
    "permissions": "example",
    "policy_id": "example",
    "shared_with": []
  }
}
```

### Create support session

POST api/v1/Sessions.

**Inputs**

- Valid until (`valid_until`, date and time): Valid until.
- Groupid (`groupid`, text): Groupid.
- Custom ID (`custom_id`, text): Custom ID.
- Groupname (`groupname`, text): Groupname.
- Support session type (`support_session_type`, number): Support session type. One of: `0`, `1`, `2`, `3`.
- Sms invite number (`sms_invite_number`, text): Sms invite number.
- Sms invite language (`sms_invite_language`, number): Sms invite language. One of: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, and 23 more.
- Waiting message (`waiting_message`, text): Waiting message.
- Description (`description`, text): Description.
- End customer (`end_customer`, object): End customer.
- Assigned userid (`assigned_userid`, text): Assigned userid.
- Custom api (`custom_api`, text): Custom api.
- Tv version (`tv_version`, text): Tv version.

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "assigned_at": "example",
    "assigned_userid": "example",
    "code": "example",
    "created_at": "example",
    "customId": "example",
    "custom_api": "example",
    "description": "example",
    "end_customer": {
      "email": "example",
      "name": "example"
    },
    "end_customer_link": "example",
    "groupid": "example",
    "state": 0,
    "support_session_type": 0,
    "supporter_link": "example",
    "tv_version": "example",
    "valid_until": "example",
    "waiting_message": "example",
    "webclient_supporter_link": "example"
  }
}
```

### Delete group

Deletes a group.

**Inputs**

- Id (`id`, text, required): GroupId of group

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete support session

DELETE api/v1/Sessions/{id}.

**Inputs**

- Id (`id`, text, required): id

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {}
}
```

### Get account

Returns the account.

**Inputs**: None.

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "available_licenses": [],
    "company_name": "example",
    "custom_field_has_paid_license": "example",
    "email": "example",
    "email_language": "example",
    "email_validated": false,
    "license": {
      "details": "example",
      "isactive": false,
      "license_type": 0,
      "teamViewerLicenseId": "example",
      "type": "example",
      "version": 1
    },
    "name": "example",
    "permissions": "example",
    "profilepicture_url": "example",
    "social_login_identity_issuer": "example",
    "userid": "example"
  }
}
```

### Get connection report

GET api/v1/reports/connections/{id:Guid}.

**Inputs**

- Id (`id`, text, required): id

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "assigned_at": "example",
    "assigned_userid": "example",
    "billing_state": "example",
    "contact_id": "example",
    "currency": "example",
    "custom_api": "example",
    "deviceid": "example",
    "devicename": "example",
    "end_customer": {
      "email": "example",
      "name": "example"
    },
    "end_date": "example",
    "fee": 1.0,
    "feedback": {
      "session_rating": 1,
      "user_comment": "example"
    },
    "groupid": "example",
    "groupname": "example",
    "id": "example",
    "managedGroupIds": [],
    "managedGroupNames": [],
    "notes": "example",
    "session_code": "example",
    "session_created_at": "example",
    "session_note": "example",
    "start_date": "example",
    "support_session_type": 0,
    "userid": "example",
    "username": "example",
    "valid_until": "example"
  }
}
```

### Get contact

Retrieves a specific contact by ID.

**Inputs**

- Id (`id`, text, required): Contact ID (c-prefixed)

**Outputs**

- `data` (object): Response containing a list of contacts and optionally pending invitations.

**Example output**

```json
{
  "data": {
    "contacts": [],
    "invitations": []
  }
}
```

### Get device

GET api/v1/devices/{id}.

**Inputs**

- Id (`id`, text, required): id

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "devices": []
  }
}
```

### Get group

Returns group by groupId.

**Inputs**

- Id (`id`, text, required): GroupId of group

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "id": "example",
    "name": "example",
    "owner": {
      "alias": "example",
      "name": "example",
      "userid": "example"
    },
    "permissions": "example",
    "policy_id": "example",
    "shared_with": []
  }
}
```

### Get support session

GET api/v1/Sessions/{id}.

**Inputs**

- Id (`id`, text, required): id

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "assigned_at": "example",
    "assigned_userid": "example",
    "closed_at": "example",
    "code": "example",
    "created_at": "example",
    "custom_api": "example",
    "custom_module_id": "example",
    "description": "example",
    "end_customer": {
      "email": "example",
      "name": "example"
    },
    "end_customer_link": "example",
    "groupid": "example",
    "online": false,
    "state": "example",
    "support_session_type": "example",
    "supporter_link": "example",
    "tv_version": "example",
    "valid_until": "example",
    "waiting_message": "example",
    "webclient_supporter_link": "example"
  }
}
```

### Get user

Returns a user.

**Inputs**

- Id (`id`, text, required): User Identifier (UserId should start with u char)

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "activated_license_id": "example",
    "activated_license_name": "example",
    "activated_meeting_license_key": "example",
    "activated_subLicense_name": "example",
    "active": false,
    "creation_date": "example",
    "custom_quickjoin_id": "example",
    "custom_quicksupport_id": "example",
    "email": "example",
    "id": "example",
    "last_access_date": "example",
    "log_sessions": false,
    "name": "example",
    "online_state": "example",
    "password_updatedat": "example",
    "permissions": "example",
    "show_comment_window": false,
    "sso_status": 0,
    "tfa_enabled": false,
    "tfa_enforcement": false,
    "userRoleId": "example"
  }
}
```

### List connection reports

List remote session reports, newest first, up to 1,000 at a time, with how many more remain and a link to the next page.

**Inputs**

- Username (`username`, text): LocalSystemUser that created the session
- Userid (`userid`, text): AccountId to which the session belongs
- Groupid (`groupid`, text): GroupId that is used to filter session reports. Only reports to devices within this group will be returned. Special case: 0 means "no group", so only reports to unnamed devices are returned.
- Managed group ID (`managed_group_id`, text): Managed device group id that is used to filter session reports. Only reports to devices within this managed group will be returned.
- Devicename (`devicename`, text): ServerName. Used to filter reports. Only reports to devices with this name will be returned.
- Deviceid (`deviceid`, text): TeamViewerId to filter sessions. Is a string as it is in the DB scheme.
- From date (`from_date`, date and time): Only reports of sessions that started on or after this date.
- To date (`to_date`, date and time): Returned reports shall end before this date
- Offset ID (`offset_id`, text): Used to partition the results. If there are more than 1000 results for a call, there is a link to the further results that contains the ParticipantSessionId of the last session. With this, we can exactly determine which results have already been received. All reports after the row with ParticipantSessionId will be returned when the results are ordered by end date descending. The row with the ID itself will be skipped.
- Has code (`has_code`, true/false): If set to true will filter out reports without a session code. If false, it will filter out reports with a session code. Will not filter out anything if the parameter is left out.
- Session code (`session_code`, text): If specified only returns connection reports for specified session code
- Support session type (`support_session_type`, text): If specified only returns connection reports of the given session type - valid values are "RemoteConnection" / "1" and "RemoteSupportActive" / "2" and "RemoteSupportActiveSdk" / "3"
- Session report features (`session_report_features`, list): If specified, only reports which have the specified feature will be returned.

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "next_offset": "example",
    "records": [],
    "records_remaining": 1
  }
}
```

### List contacts

Retrieves all contacts with optional filtering.

**Inputs**

- Name (`name`, text): Filter by name. Case-insensitive partial match (e.g., "John" matches "John Smith").
- Online state (`online_state`, text): Current online state. One of: `online`, `busy`, `away`, `offline`.
- Email (`email`, text): Filter by email address. Multiple addresses can be separated by comma or space.
- Groupid (`groupid`, text): Filter by group ID (g-prefixed, e.g., 'g1000'). Returns only contacts in the specified group.
- Include invitations (`include_invitations`, true/false): When true, includes pending invitations (invited contacts who have not yet created their account) in the response. Default: false.

**Outputs**

- `data` (object): Response containing a list of contacts and optionally pending invitations.

**Example output**

```json
{
  "data": {
    "contacts": [],
    "invitations": []
  }
}
```

### List devices

GET api/v1/devices.

**Inputs**

- Name (`name`, text): parameters.name
- Online state (`online_state`, text): Current online state. One of: `online`, `offline`.
- Groupid (`groupid`, text): parameters.groupid
- Remotecontrol ID (`remotecontrol_id`, text): parameters.remotecontrol_id

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "devices": []
  }
}
```

### List groups

Returns groups by filter criteria.

**Inputs**

- Name (`name`, text): Name of the group
- Shared (`shared`, true/false): Is group shared or not
- Should match full name (`should_match_full_name`, true/false): Is name should match completely or not

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "groups": []
  }
}
```

### List support sessions

GET api/v1/Sessions.

**Inputs**

- Groupid (`groupid`, text): groupid
- Assigned userid (`assigned_userid`, text): assigned_userid
- State (`state`, text): Whether the support session is open or closed. One of: `open`, `closed`.
- Full list (`full_list`, true/false): full_list
- Offset (`offset`, text): offset

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "next_offset": "example",
    "sessions": [],
    "sessions_remaining": 1
  }
}
```

### List users

Returns users with filter criteria.

**Inputs**

- Email (`email`, text): User email
- Name (`name`, text): User display name
- Permissions (`permissions`, text): Comma separated access rights. Please use user role APIs for user's rights
- Full list (`full_list`, true/false): Is detailed user information needed

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {
    "users": []
  }
}
```

### Update device

PUT api/v1/Devices/{id}.

**Inputs**

- Id (`id`, text, required): id
- Alias (`alias`, text): Alias.
- Groupid (`groupid`, text): Groupid.
- Description (`description`, text): Description.
- Password (`password`, text): Password.
- Policy ID (`policy_id`, text): Policy ID.

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {}
}
```

### Update group

Updates group.

**Inputs**

- Id (`id`, text, required): GroupId of group
- Name (`name`, text): Name.
- Policy ID (`policy_id`, text): Policy ID.

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {}
}
```

### Update support session

PUT api/v1/Sessions/{id}.

**Inputs**

- Id (`id`, text, required): id
- Groupid (`groupid`, text): Groupid.
- Custom module ID (`custom_module_id`, text): Custom module ID.
- Groupname (`groupname`, text): Groupname.
- Waiting message (`waiting_message`, text): Waiting message.
- Description (`description`, text): Description.
- End customer (`end_customer`, object): End customer.
- Assigned userid (`assigned_userid`, text): Assigned userid.
- Custom api (`custom_api`, text): Custom api.
- State (`state`, text): Whether the support session is open or closed. One of: `open`, `closed`.
- Tv version (`tv_version`, text): Tv version.
- Sms invite number (`sms_invite_number`, text): Sms invite number.
- Sms invite language (`sms_invite_language`, number): Sms invite language. One of: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, and 23 more.

**Outputs**

- `data` (object): Team Viewer response data.

**Example output**

```json
{
  "data": {}
}
```
