Webex · Schema

UserProfileGetResponseObject

User profile details for the authenticated user.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier of the user.
lastName	string	Last name of the user.
firstName	string	First name of the user.
email	string	The email addresses of the person.
announcementLanguage	string	Language for announcements.
locationDialingCode	string	Dialing code for the user's location.
supportMobility	boolean	If `true`, the user supports mobility.
emergencyCallBackNumber	string	Emergency callback number for the user.
phoneNumbers	array	List of numbers associated with the user.
devices	array	List of devices associated with the user.
location	object
receptionistUrl	string	URL for the receptionist console.
callingHostUrl	string	URL for the calling host.
attendantConsoleUrl	string	URL for the attendant console.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserProfileGetResponseObject",
  "title": "UserProfileGetResponseObject",
  "type": "object",
  "description": "User profile details for the authenticated user.",
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYWZiM2JhYi1hN2UxLTQ1ZGUtYmYzZS1kOWUxMzkxYzU0Yjk",
    "lastName": "Doe",
    "firstName": "John",
    "email": "[email protected]",
    "announcementLanguage": "English",
    "locationDialingCode": "8327",
    "supportMobility": false,
    "emergencyCallBackNumber": "+16232992720",
    "phoneNumbers": [
      {
        "directNumber": "+441234222304",
        "enterprise": "832731599",
        "extension": "31599",
        "routingPrefix": "8327",
        "esn": "832731599",
        "primary": true
      },
      {
        "directNumber": "+441234200015",
        "enterprise": "832731587",
        "extension": "31587",
        "routingPrefix": "8327",
        "esn": "832731587",
        "primary": false
      }
    ],
    "devices": [
      {
        "description": [],
        "model": "DMS Cisco 8865",
        "mac": "110723241134",
        "primaryOwner": true,
        "type": "PRIMARY",
        "owner": {
          "lastName": "Mac",
          "firstName": "Jone",
          "type": "PEOPLE"
        },
        "activationState": "ACTIVATED"
      }
    ],
    "location": {
      "name": "Brampton",
      "address": {
        "address1": "mclean",
        "address2": "mclean",
        "city": "mclean",
        "state": "GB-BGE",
        "postalCode": "112233",
        "country": "GB"
      }
    },
    "receptionistUrl": "https://cisco.receptionist.cloud",
    "callingHostUrl": "https://var-int.broadcloudpbx.net",
    "attendantConsoleUrl": "https://cisco.receptionist.cloud"
  },
  "required": [
    "id",
    "lastName",
    "firstName",
    "email",
    "announcementLanguage",
    "locationDialingCode",
    "supportMobility",
    "emergencyCallBackNumber",
    "phoneNumbers",
    "devices",
    "location",
    "receptionistUrl",
    "callingHostUrl",
    "attendantConsoleUrl"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYWZiM2JhYi1hN2UxLTQ1ZGUtYmYzZS1kOWUxMzkxYzU0Yjk",
      "description": "Unique identifier of the user."
    },
    "lastName": {
      "type": "string",
      "example": "John",
      "description": "Last name of the user."
    },
    "firstName": {
      "type": "string",
      "example": "Doe",
      "description": "First name of the user."
    },
    "email": {
      "type": "string",
      "example": "[email protected]'",
      "description": "The email addresses of the person."
    },
    "announcementLanguage": {
      "type": "string",
      "example": "English",
      "description": "Language for announcements."
    },
    "locationDialingCode": {
      "type": "string",
      "example": "8327",
      "description": "Dialing code for the user's location."
    },
    "supportMobility": {
      "type": "boolean",
      "description": "If `true`, the user supports mobility."
    },
    "emergencyCallBackNumber": {
      "type": "string",
      "example": "+16232992720",
      "description": "Emergency callback number for the user."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserNumber"
      },
      "description": "List of numbers associated with the user."
    },
    "devices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserDevice"
      },
      "description": "List of devices associated with the user."
    },
    "location": {
      "$ref": "#/components/schemas/LocationObject"
    },
    "receptionistUrl": {
      "type": "string",
      "example": "https://cisco.receptionist.cloud",
      "description": "URL for the receptionist console."
    },
    "callingHostUrl": {
      "type": "string",
      "example": "https://var-int.broadcloudpbx.net",
      "description": "URL for the calling host."
    },
    "attendantConsoleUrl": {
      "type": "string",
      "example": "https://cisco.receptionist.cloud",
      "description": "URL for the attendant console."
    }
  }
}