Endpoint

Endpoints are H.323 or SIP room systems that Relay can control.

{
    "addressStyle": "HOSTNAME",
    "announcementId": "1988",
    "assetId": "1983",
    "autoJoinMode": "ENABLED",
    "calendarId": "bluejeansnet.com_cicj6pc9on321i5ugsb7fvp6fg@group.calendar.google.com",
    "calendarPushMode": "ENABLED",
    "calendarType": "GOOGLE",
    "contactListId": "4gfdcda24fde9338fa9awerf",
    "controlProtocol": "TANDBERG_HTTP",
    "customData": {
        "correlationId": "0cea05f7-87de-4b40-b7df-c997b10addcb"
    },
    "dialStyle": "ANNEX_O",
    "elevation": 102.0,
    "externalId": "17",
    "geolocation": {
        "latitude": 37.39904,
        "longitude": -122.04789
    },
    "id": "550c9289e4b0c0c6485f4cfa",
    "inMeetingControls": "ENABLED",
    "ipAddress": "10.4.6.64",
    "listenerServiceId": "5398236a9bab9338fa9a6a3d",
    "location": "516 Clyde Avenue, Mountain View, CA 94043",
    "manualMeetingDialer": "ENABLED",
    "meetingPrivacyMode": "REDACTED",
    "meshBaseUri": null,
    "name": "Interocitor",
    "password": null,
    "pointOfContact": "ben@bluejeansnet.com",
    "port": 80,
    "registerToSipProxy": "AUTO",
    "signalingProtocol": "H323",
    "username": "admin",
    "validatePasscodes": "ENABLED",
    "zeroTouchType": "STATIC"
}

Properties

addressStyle

When constructing a dial string, should we use the hostname or IP address of the Blue Jeans server? Possible values are HOSTNAME (bjn.vc) and IP_ADDRESS (104.238.247.247). Defaults to HOSTNAME.

announcementId

Announcement ID of a proximity device near this endpoint ("pro" only), optional. Defaults to null.

assetId

May be used to keep track of the Endpoint's physical asset tracking tag or sticker. Defaults to null.

autoJoinMode

Whether or not to automatically join meetings at the meeting start time. Value can be ENABLED, or null to disable. Defaults to null, which disables auto joining meetings.

calendarId

The email address of the room resource's calendar that contains this Endpoint's meetings. For Google Calendar, this looks like corp.com_123@resource.calendar.google.com. For Exchange, this looks like roomname@corp.com. For Office 365, this looks like roomname@corp.onmicrosoft.com or roomname@corp.com. Leave as null to disable calendar integration.

calendarPushMode

Whether or not to update the Endpoint's user interface with scheduled meetings from Relay. Currently available only for Endpoints with the TANDBERG_HTTP, CISCO_IX_SSH_SOAP, LIFESIZE_HTTP_ICON, POLYCOM_HTTP_REALPRESENCE, POLYCOM_HTTP_HDX, or MESH Control Protocol. Value can be ENABLED, or null to disable. Defaults to null, which disables pushing of meetings to the Endpoint.

calendarType

Which type of calendar server hosts the Endpoint's calendar: GOOGLE (Google Calendar), EXCHANGE (Microsoft Exchange), OFFICE_365 (Microsoft Office 365), or EXTERNAL (Externally Managed). Leave as null to disable calendar integration.

contactListId

Id of the ContactList. Contact lists are created by the Enterprise and are used to sync contacts to supported endpoints. Defaults to null, which means there is no contact list on the endpoint.

controlProtocol

Dictates how the Listener Service should communicate with the Endpoint's admin interface, depending on the make and model of the Endpoint. Can be TANDBERG_HTTP (works on most Cisco and Tandberg endpoints, excluding CTS/TX/IX/DX), POLYCOM_HTTP_HDX (works on HDX and VSX), POLYCOM_HTTP_REALPRESENCE (works on RealPresence Group series), POLYCOM_HTTP_REALPRESENCE_TRIO (works on Trio), POLYCOM_HTTP_REALPRESENCE_DEBUT (works on RealPresence Debut), POLYCOM_HTTP_VIDEOOS (works on Studio X/G7500), LIFESIZE_SSH (works on Room, Express, and Team), LIFESIZE_HTTP_ICON (works on Icon), TELY_HTTP (requires Tely firmware 4.5 and a Tely Device API license), MESH (integrates with custom implementations using a well-defined REST service), STARLEAF_HTTP (requires StarLeaf Support to enable the Endpoint API Option for each Endpoint you want to use), CISCO_IX_SSH_SOAP (works on IX5000), SONY_HTTP_PCSXG80 (works on PCS-XG80), YEALINK_HTTP_VC (works on VC800), or RADVISION_TCP_SCOPIA (works on XT5000, v8.3.4.18 or later). Leave as null to disable Endpoint control.

customData

May be used to store arbitrary data with Endpoints in Relay, for use in integrations with external systems. Accepts an object of key-value pairs where both keys and values are Strings. Defaults to null.

dialStyle

Name of the DialStyle used to format one-string dial strings. Can be a DialStyle created by the Enterprise, one of built-in DialStyles (ANNEX_O or IP_PLUS), or null to use the default ANNEX_O.

elevation

May be used to keep track of where this Endpoint is physically located using geographic coordinates. Value is a floating-point number of meters above Mean Sea Level. See also geolocation. Defaults to null.

externalId

May be used to keep track of this Endpoint in a separate non-Relay data source; e.g., the foreign key of this Endpoint in a different management database. Defaults to null.

geolocation

May be used to keep track of where this Endpoint is physically located using geographic coordinates. Represented as an object containing a longitude (number of decimal degrees from -180.0 [east] to 180.0 [west]) and a latitude (number of decimal degrees from -90.0 [south] to 90.0 [north]).See also elevation. Defaults to null.

id

Generated automatically when the entity is created, and cannot be changed.

inMeetingControls

Whether or not to show custom controls on the endpoint's native UI to easily perform meeting actions like remote muting and changing layouts without having to use DTMF codes. This does not affect endpoint's built-in controls, or the controls on Blue Jeans tablet apps like Relay Touch. This is currently only supported on Cisco Endpoints running CE9.2.1 or later. Value can be ENABLED, or null to disable. Defaults to null.

ipAddress

The Endpoint's hostname on your network, reachable by the Listener Service. Can be a fully-qualified domain name, an IPv4 address, or an IPv6 address enclosed in square brackets. The field is named ipAddress for backwards compatibility.

listenerServiceId

The ID of an existing Listener Service that has a network route to this Endpoint.

location

May be used to keep track of where this Endpoint is physically located; e.g., street address, building name, or datacenter rack. Defaults to null.

manualMeetingDialer

Whether or not to show custom controls on the endpoint's home screen to easily join ad-hoc BlueJeans and Teams meetings by typing in the meeting details on the touchscreen, without having to construct a SIP URI. This is currently only supported on Cisco Endpoints running CE9.2.1 or later. Value can be ENABLED, or null to disable. Defaults to null.

meetingPrivacyMode

Meeting privacy mode for this endpoint. If set to PRIVATE, all meeting details are removed for all meetings for this endpoint. If set to REDACTED, only the meeting title and description are removed for all meetings for this endpoint. When omitted or set to null, all meeting details are always passed through as-is.

meshBaseUri

When using ControlProtocol.MESH, provides the URI of where to find the base REST service for controlling this endpoint. Otherwise, leave null.

name

The user-facing name of the Endpoint, usually set to match the sign outside the conference room door.

password

Used by Relay to log in to the Endpoint. When reading from the API, the password will always appear null, even if one is set. When writing to the API, send the new password as a String, or send null to leave the existing password unchanged. Endpoint passwords are stored in encrypted form.

pointOfContact

May be used to keep track of who is resposible for this Endpoint; e.g., an IT administrator's email address or phone number. Defaults to null.

port

TCP or UDP port used by Relay to connect to the Endpoint's admin interface over the given controlProtocol. If null, the default port for the controlProtocol is used.

registerToSipProxy

Whether or not to register the Endpoint to the Listener Service's built-in SIP proxy when appropriate. Currently available only for Endpoints with the TANDBERG_HTTP Control Protocol. Value can be AUTO, or null to disable. Defaults to null, which disables the SIP proxy for the Endpoint.

signalingProtocol

Can be H323 or SIP. If null, the endpoint will use its default protocol.

username

Used by Relay to log in to the Endpoint's admin interface.

validatePasscodes

May be used to validate BlueJeans passcodes upon the endpoint. When you join a meeting from the endpoint's touchscreen or OSD this will check the passcode is valid and prompt for it if necessary (ie. if no passcode was supplied, passcode was wrong, or the moderator passcode is necessary to join the meeting.) This is currently only supported on Cisco Endpoints running CE9.6.1 or later. Value can be ENABLED, or null to disable. Defaults to null.

zeroTouchType

Whether or not to enable Zero Touch for this endpoint.Defaults to null, which disables Zero Touch.