Webex · Schema

SearchMemberObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for the member.
firstName	string	First name of a person or workspace.
lastName	string	Last name of a person or workspace.
phoneNumber	string	Phone Number of a person or workspace.
t38FaxCompressionEnabled	boolean	T.38 Fax Compression setting and available only for ATA Devices. Choose T.38 fax compression if the device requires this option. this will override user level compression options.
lineType	object	Line type is used to differentiate Primary and SCA, at which endpoint it is assigned.
allowCallDeclineEnabled	boolean	Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only decli
memberType	object	Indicates if member is of type `PEOPLE` or `PLACE`.
location	object	Location object having a unique identifier for the location and its name.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchMemberObject",
  "title": "SearchMemberObject",
  "type": "object",
  "required": [
    "id",
    "firstName",
    "lastName",
    "lineType",
    "allowCallDeclineEnabled",
    "memberType"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
      "description": "Unique identifier for the member."
    },
    "firstName": {
      "type": "string",
      "example": "John",
      "description": "First name of a person or workspace."
    },
    "lastName": {
      "type": "string",
      "example": "Smith",
      "description": "Last name of a person or workspace."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+12055552221",
      "description": "Phone Number of a person or workspace."
    },
    "t38FaxCompressionEnabled": {
      "type": "boolean",
      "description": "T.38 Fax Compression setting and available only for ATA Devices. Choose T.38 fax compression if the device requires this option. this will override user level compression options."
    },
    "lineType": {
      "$ref": "#/components/schemas/LineType",
      "description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
    },
    "allowCallDeclineEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
    },
    "memberType": {
      "$ref": "#/components/schemas/MemberType",
      "description": "Indicates if member is of type `PEOPLE` or `PLACE`."
    },
    "location": {
      "$ref": "#/components/schemas/location",
      "description": "Location object having a unique identifier for the location and its name."
    }
  }
}