Webex · Schema

TtsUsageResponse

Response containing text-to-speech usage information.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
noOfApiCalls integer The number of text-to-speech API calls made in the current time window.
maxAllowedApiCalls integer The maximum number of text-to-speech API calls allowed in the current time window.
usageResetTimestamp string The timestamp when the usage counter will reset. It will be returned when reaching the maximum allowed API calls in the time window.
View JSON Schema on GitHub

JSON Schema

webex-ttsusageresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TtsUsageResponse",
  "title": "TtsUsageResponse",
  "type": "object",
  "description": "Response containing text-to-speech usage information.",
  "example": {
    "maxAllowedApiCalls": 150,
    "noOfApiCalls": 25,
    "usageResetTimestamp": "2024-01-01T00:00:00.000Z"
  },
  "required": [
    "noOfApiCalls",
    "maxAllowedApiCalls"
  ],
  "properties": {
    "noOfApiCalls": {
      "type": "integer",
      "example": 25,
      "description": "The number of text-to-speech API calls made in the current time window."
    },
    "maxAllowedApiCalls": {
      "type": "integer",
      "example": 150,
      "description": "The maximum number of text-to-speech API calls allowed in the current time window."
    },
    "usageResetTimestamp": {
      "type": "string",
      "example": "2026-01-01T00:00:00.000Z",
      "description": "The timestamp when the usage counter will reset. It will be returned when reaching the maximum allowed API calls in the time window."
    }
  }
}