Webex · Schema

CreateInterpreterObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
languageCode1 string The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_IS
languageCode2 string The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_IS
email string Email address of meeting interpreter. If not specified, an empty interpreter will be created for this bi-directional language channel, and a specific email can be assigned to this empty interpreter by
displayName string Display name of meeting interpreter. If the interpreter is already an invitee of the meeting and it has a different display name, that invitee's display name will be overwritten by this attribute.
hostEmail string Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user
sendEmail boolean If `true`, send email to the interpreter.
View JSON Schema on GitHub

JSON Schema

webex-createinterpreterobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateInterpreterObject",
  "title": "CreateInterpreterObject",
  "type": "object",
  "required": [
    "languageCode1",
    "languageCode2"
  ],
  "properties": {
    "languageCode1": {
      "type": "string",
      "example": "en",
      "description": "The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)."
    },
    "languageCode2": {
      "type": "string",
      "example": "de",
      "description": "The pair of `languageCode1` and `languageCode2` form a bi-directional simultaneous interpretation language channel. The language codes conform with [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address of meeting interpreter. If not specified, an empty interpreter will be created for this bi-directional language channel, and a specific email can be assigned to this empty interpreter by `Update a Meeting Interpreter` API later. Please note that multiple interpreters with different emails can be assigned to the same bi-directional language channel, but the same email cannot be assigned to more than one interpreter."
    },
    "displayName": {
      "type": "string",
      "example": "Hoffmann",
      "description": "Display name of meeting interpreter. If the interpreter is already an invitee of the meeting and it has a different display name, that invitee's display name will be overwritten by this attribute."
    },
    "hostEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin on-behalf-of scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host."
    },
    "sendEmail": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, send email to the interpreter."
    }
  }
}