Webex · Schema

MultimediaProfileDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
organizationId string ID of the contact center organization. It is required to define for the following operations - All bulk save operations
id string ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version integer The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
name string Enter the name for the multimedia profile. Generally, use names that indicate the type of the profile, such as Default Telephony Profile.
description string Enter a description for the multimedia profile.
chat integer Define the upper limits for this channel type. It should range from 0 or 1(depends on the 'BlendingMode') to 5.
email integer Define the upper limits for this channel type. It should range from 0 to 5.
telephony integer Define the upper limits for this channel type. It should be either 0 or 1(depends on the 'BlendingMode').
social integer Define the upper limits for this channel type. It should range from 0 to 5.
active boolean Specify whether the multimedia profile is active or not.
blendingModeEnabled boolean Specify whether the blending mode is enabled or not for a multimedia profile.
blendingMode string Blending mode can be one the following: BLENDED: This mode allows agents to handle multiple contacts of different channel types simultaneously. Number of contacts that you can set for Voice: 0–1 and
systemDefault boolean Indicates whether the created resource is system created or not
manuallyAssignable object
createdTime integer Creation time(in epoch millis) of this resource.
lastUpdatedTime integer Time(in epoch millis) when this resource was last updated.
View JSON Schema on GitHub

JSON Schema

webex-multimediaprofiledto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MultimediaProfileDTO",
  "title": "MultimediaProfileDTO",
  "required": [
    "active",
    "blendingMode",
    "blendingModeEnabled",
    "chat",
    "email",
    "name",
    "social",
    "telephony"
  ],
  "type": "object",
  "properties": {
    "organizationId": {
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
      "format": "uuid",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "format": "int32",
      "example": 1
    },
    "name": {
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9._\\-\\s]*$",
      "type": "string",
      "description": "Enter the name for the multimedia profile. Generally, use names that indicate the type of the profile, such as Default Telephony Profile.",
      "example": "Default Telephony Profile"
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "Enter a description for the multimedia profile.",
      "example": "This multimedia profile is for Default Telephony Profile"
    },
    "chat": {
      "type": "integer",
      "description": "Define the upper limits for this channel type. It should range from 0 or 1(depends on the 'BlendingMode') to 5.",
      "format": "int32",
      "example": 0
    },
    "email": {
      "type": "integer",
      "description": "Define the upper limits for this channel type. It should range from 0 to 5.",
      "format": "int32",
      "example": 5
    },
    "telephony": {
      "type": "integer",
      "description": "Define the upper limits for this channel type. It should be either 0 or 1(depends on the 'BlendingMode').",
      "format": "int32",
      "example": 0
    },
    "social": {
      "type": "integer",
      "description": "Define the upper limits for this channel type. It should range from 0 to 5.",
      "format": "int32",
      "example": 4
    },
    "active": {
      "type": "boolean",
      "description": "Specify whether the multimedia profile is active or not.",
      "example": true
    },
    "blendingModeEnabled": {
      "type": "boolean",
      "description": "Specify whether the blending mode is enabled or not for a multimedia profile.",
      "example": true
    },
    "blendingMode": {
      "type": "string",
      "description": "Blending mode can be one the following:\n\nBLENDED: This mode allows agents to handle multiple contacts of different channel types simultaneously. Number of contacts that you can set for Voice: 0\u00e2\u20ac\u201c1 and for Chat, Email, and Social Channel: 0\u00e2\u20ac\u201c5\n\nBLENDED_REALTIME: This allows agents to handle a contact of one real-time channel at a time - either voice or chat. Along with this they can handle non-realtime contacts which include email and social channels. Number of contacts that you can set for Voice: 1 (mandatory), Chat: 1\u00e2\u20ac\u201c5, Email and Social Channel: 0\u00e2\u20ac\u201c5\n\nEXCLUSIVE: This mode allows agents to focus on one customer contact at a time.",
      "example": "BLENDED"
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "manuallyAssignable": {
      "$ref": "#/components/schemas/MultimediaProfileChannelDTO"
    },
    "createdTime": {
      "type": "integer",
      "description": "Creation time(in epoch millis) of this resource.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    },
    "lastUpdatedTime": {
      "type": "integer",
      "description": "Time(in epoch millis) when this resource was last updated.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    }
  }
}