Webex · Schema

EntryPointDTO

CallingCollaborationCommunicationsEnterpriseMessagingVideo 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	A unique name for the entry point within the organization. It is required only during a create or an update operation.
description	string	A short description of the entry point.
entryPointType	string	Setting to indicate if this entry point is meant for incoming or outgoing contacts. Use uppercase. Can be set to either `INBOUND` or `OUTBOUND`. With Outbound Type, Only Telephony channel is supported
channelType	string	Setting to indicate the channel type. Use uppercase. Supported channel types are: TELEPHONY, EMAIL, VIDEO, SOCIAL_CHANNEL, FAX, CHAT and OTHERS. It is required only during a create or an update operat
socialChannelType	string	Setting to indicate the type of Social Channel.This setting is available only when channel type is SOCIAL_CHANNEL.Use uppercase. Can be set to either `MESSAGEBIRD` or `MESSENGER`.
active	boolean	Used to toggle the state of the entrypoint from active to inactive and vice-versa. It is required only during a create or an update operation.
serviceLevelThreshold	integer	Allows to set the time that a customer request can be in a queue before the system flags it as outside the service level. If the agent completes a customer service request within this time interval, t
maximumActiveContacts	integer	Caps the maximum number of simultaneous calls for this entry point. The system busies out any additional calls when the number of active calls exceeds this number. It is required only for a create or
controlFlowScriptUrl	string	The system automatically populates this field with the URL for this entry point or the default control script of the queue.It happens when you don’t configure the control script using the Webex Contac
overflowNumber	string	Allows to set the destination phone number to which the system diverts the customer calls when they exceed the Maximum Time in Queue that has been set in the routing strategy. This setting is applicab
timezone	string	(Optional) Any routing strategy for this entry point uses the time zone that you select here.
imiOrgType	string	Refers to the type of digital channels used by the org. It takes two values: IMI (if all channels used are IMI) and MIXED_MODE (if both native and IMI channels are used).
assetId	string	ID of the asset in IMI that corresponds to this entrypoint.
xspVersion	string	(Optional) Used to subscribe for recording events.
subscriptionId	string	(Optional) Used to subscribe for recording events.
routePointId	string	The identifier of a route point of WxC which is similar to entry point of WxCC
flowId	string
flowTagId	string
musicOnHoldId	string
outdialQueueId	string
systemDefault	boolean	Indicates whether the created resource is system created or not
callbackEnabled	boolean	Indicates whether the created resource is call back enabled or not
outdialTransferToQueueEnabled	boolean	Indicates whether the resource is Default Outdial Transfer to Queue.
dnEpMappingCount	integer
flowOverrideSettings	array	Add a Flow override settings to entry-point. This feature enables non-flow developers and designers including Contact Center Supervisors and other Contact Center personnel to modify settings such as b
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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EntryPointDTO",
  "title": "EntryPointDTO",
  "required": [
    "active",
    "assetId",
    "channelType",
    "controlFlowScriptUrl",
    "entryPointType",
    "imiOrgType",
    "maximumActiveContacts",
    "name",
    "overflowNumber",
    "serviceLevelThreshold",
    "socialChannelType"
  ],
  "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": "A unique name for the entry point within the organization. It is required only during a create or an update operation.",
      "example": "Telephony-Ep"
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "A short description of the entry point.",
      "example": "Required for transferring out-dial calls to Queues"
    },
    "entryPointType": {
      "type": "string",
      "description": "Setting to indicate if this entry point is meant for incoming or outgoing contacts. Use uppercase. Can be set to either `INBOUND` or `OUTBOUND`. With Outbound Type, Only Telephony channel is supported. It is required only during a create or an update operation.",
      "example": "INBOUND",
      "enum": [
        "INBOUND",
        "OUTBOUND"
      ]
    },
    "channelType": {
      "type": "string",
      "description": "Setting to indicate the channel type. Use uppercase. Supported channel types are: \n\n TELEPHONY, EMAIL, VIDEO, SOCIAL_CHANNEL, FAX, CHAT and OTHERS.  It is required only during a create or an update operation.",
      "example": "TELEPHONY",
      "enum": [
        "TELEPHONY",
        "EMAIL",
        "FAX",
        "CHAT",
        "VIDEO",
        "OTHERS",
        "SOCIAL_CHANNEL"
      ]
    },
    "socialChannelType": {
      "type": "string",
      "description": "Setting to indicate the type of Social Channel.This setting is available only when channel type is SOCIAL_CHANNEL.Use uppercase. Can be set to either `MESSAGEBIRD` or `MESSENGER`.",
      "example": "MESSENGER",
      "enum": [
        "MESSAGEBIRD",
        "MESSENGER",
        "WHATSAPP",
        "APPLE_BUSINESS_CHAT",
        "GOOGLE_BUSINESS_MESSAGES"
      ]
    },
    "active": {
      "type": "boolean",
      "description": "Used to toggle the state of the entrypoint from active to inactive and vice-versa. It is required only during a create or an update operation.",
      "example": true
    },
    "serviceLevelThreshold": {
      "type": "integer",
      "description": "Allows to set the time that a customer request can be in a queue before the system flags it as outside the service level. \n\n If the agent completes a customer service request within this time interval, the system considers it within the service level. \nIt is required only for a create or an update operation.",
      "format": "int32",
      "example": 12
    },
    "maximumActiveContacts": {
      "type": "integer",
      "description": "Caps the maximum number of simultaneous calls for this entry point.\n\nThe system busies out any additional calls when the number of active calls exceeds this number.\n\nIt is required only for a create or an update operation.",
      "format": "int32",
      "example": 1
    },
    "controlFlowScriptUrl": {
      "type": "string",
      "description": "The system automatically populates this field with the URL for this entry point or the default control script of the queue.It happens when you don\u2019t configure the control script using the Webex Contact Center Routing Strategy module.This setting is available for the Telephony channel type.",
      "example": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield"
    },
    "overflowNumber": {
      "maxLength": 40,
      "minLength": 0,
      "pattern": "^[0-9]*$",
      "type": "string",
      "description": "Allows to set the destination phone number to which the system diverts the customer calls when they exceed the Maximum Time in Queue \n\nthat has been set in the routing strategy.\n\nThis setting is applicable only for the Telephony channel type.",
      "example": "1231231231"
    },
    "timezone": {
      "type": "string",
      "description": "(Optional) Any routing strategy for this entry point uses the time zone that you select here.",
      "example": "America/New_York"
    },
    "imiOrgType": {
      "type": "string",
      "description": "Refers to the type of digital channels used by the org. It takes two values: IMI (if all channels used are IMI) and MIXED_MODE (if both native and IMI channels are used).",
      "example": "MIXED_MODE",
      "enum": [
        "MIXED_MODE",
        "IMI"
      ]
    },
    "assetId": {
      "type": "string",
      "description": "ID of the asset in IMI that corresponds to this entrypoint.",
      "example": "a_38412723414"
    },
    "xspVersion": {
      "maxLength": 80,
      "minLength": 0,
      "type": "string",
      "description": "(Optional) Used to subscribe for recording events.",
      "example": "xsp-24.0"
    },
    "subscriptionId": {
      "maxLength": 80,
      "minLength": 0,
      "type": "string",
      "description": "(Optional) Used to subscribe for recording events.",
      "example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478"
    },
    "routePointId": {
      "type": "string",
      "description": "The identifier of a route point of WxC which is similar to entry point of WxCC",
      "example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
    },
    "flowId": {
      "type": "string"
    },
    "flowTagId": {
      "type": "string"
    },
    "musicOnHoldId": {
      "type": "string"
    },
    "outdialQueueId": {
      "type": "string"
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "callbackEnabled": {
      "type": "boolean",
      "description": "Indicates whether the created resource is call back enabled or not",
      "example": false
    },
    "outdialTransferToQueueEnabled": {
      "type": "boolean",
      "description": "Indicates whether the resource is Default Outdial Transfer to Queue.",
      "example": false
    },
    "dnEpMappingCount": {
      "type": "integer",
      "format": "int64"
    },
    "flowOverrideSettings": {
      "uniqueItems": true,
      "type": "array",
      "description": "Add a Flow override settings to entry-point.\nThis feature enables non-flow developers and designers including Contact Center Supervisors and other Contact Center personnel to modify settings such as business hours and audio prompts within Control Hub using configurable parameters, bypassing the complexity of flow editing.\nNote that flow override settings are applicable only for telephony entry-point.",
      "example": [
        {
          "name": "WelcomePromt",
          "type": "String",
          "entityType": "audio-file",
          "value": "greetings.wav",
          "id": "4f8d4487-a48e-48f5-be67-b4242345d0cf"
        }
      ],
      "items": {
        "$ref": "#/components/schemas/FlowOverrideSettingDTO"
      }
    },
    "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
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/webex-entrypointdto"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.