> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Video Meeting Connected State

> Get the current users connected state.

This indicates if a user is configured to use VideoMeetings.
NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-AppointmentAgent.json post /api/v1/Agents/Appointment/GetVideoMeetingConnectedState
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - AppointmentAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Appointment/GetVideoMeetingConnectedState:
    post:
      tags:
        - Appointment_Agent
      summary: Get Video Meeting Connected State
      description: "Get the current users connected state.\n\nThis indicates if a user is configured to use VideoMeetings.\r\nNsApiSlow threshold: 5000 ms."
      operationId: v1AppointmentAgent_GetVideoMeetingConnectedState
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserConnectedState
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserConnectedState
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserConnectedState
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserConnectedState
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserConnectedState
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserConnectedState
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.UserConnectedState:
      description: "Details about the users connected state.\r\n<para />\r\nCarrier object for UserConnectedState.\r\nServices for the UserConnectedState Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAppointmentAgent\">Appointment Agent</see>."
      type: object
      properties:
        IsConnected:
          description: If true, the user is configured for VideoMeetings
          type: boolean
        ProviderId:
          description: Information about the provider configured on the tenant
          type: string
        LoginUrl:
          description: >-
            The URL to create a new Authorization record in the VideoMeetings
            provider
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Appointment GetVideoMeetingConnectedStateRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetVideoMeetingConnectedStateRequest.md)
- [SuperOffice.WebApi.Agents.AppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AppointmentAgent.md)
- [SuperOffice.WebApi.Agents.IAppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAppointmentAgent.md)
- [SuperOffice.WebApi.Data.UserConnectedState](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserConnectedState.md)
- [Video Meetings for SuperOffice: Jitsi](/integrations/video-meetings/jitsi/index.md)
- [Video Meetings for SuperOffice: Zoom](/integrations/video-meetings/zoom/index.md)
