Webex · Schema

LogInResourceRequest

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
dialNumber	string	A dialNumber field contains the number to dial such as a route point or extension, maximum length 43 characters.
teamId	string	The unique ID representing a team of users. Leaving this field blank is valid for supervisor role but invalid for agent role, maximum length 36 characters.
isExtension	boolean	It indicates if the dialNumber field is full number or extension. It is set to false by default.
roles	array	It represents the current role of the user. The user can either be an ```agent``` or a ```supervisor```.
deviceType	string	It represents the way to differentiate type of login request (```AGENT_DN```, ```EXTENSION```, ```BROWSER```). Leaving this field is valid for supervisor role but invalid for agent role.
deviceId	string	It is equal to dialNumber for AGENT_DN & EXTENSION deviceType and for BROWSER it is populated as webrtc-AgentUUID, maximum length 43 characters.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LogInResourceRequest",
  "title": "LogInResourceRequest",
  "properties": {
    "dialNumber": {
      "description": "A dialNumber field contains the number to dial such as a route point or extension, maximum length 43 characters.",
      "type": "string",
      "example": "5678956899"
    },
    "teamId": {
      "description": "The unique ID representing a team of users. Leaving this field blank is valid for supervisor role but invalid for agent role, maximum length 36 characters.",
      "type": "string",
      "example": "5c8e24ff-a31a-422d-b7a7-b56c6739081d"
    },
    "isExtension": {
      "description": "It indicates if the dialNumber field is full number or extension. It is set to false by default.",
      "type": "boolean",
      "example": "false"
    },
    "roles": {
      "description": "It represents the current role of the user. The user can either be an ```agent``` or a ```supervisor```.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "agent",
        "supervisor"
      ]
    },
    "deviceType": {
      "description": "It represents the way to differentiate type of login request (```AGENT_DN```, ```EXTENSION```, ```BROWSER```). Leaving this field is valid for supervisor role but invalid for agent role.",
      "type": "string",
      "example": "AGENT_DN"
    },
    "deviceId": {
      "description": "It is equal to dialNumber for AGENT_DN & EXTENSION deviceType and for BROWSER it is populated as webrtc-AgentUUID, maximum length 43 characters.",
      "type": "string",
      "example": "5678956899"
    }
  },
  "required": [
    "dialNumber",
    "roles"
  ],
  "type": "object"
}