Phone Number Config Notification

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cm-com/main/json-schema/cm-com-api-phone-number-config-notification-schema.json",
  "title": "Phone Number Config Notification",
  "description": "Configuration settings for configuring a Phone Number for the Voice Notification Application.",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cm-com-voice-phone-numbers-v1-openapi.yml#/components/schemas/ApiPhoneNumberConfigNotification",
  "type": "object",
  "properties": {
    "phoneNumber": {
      "type": "integer",
      "description": "The Phone Number that the current configuration applies to.",
      "format": "int64"
    },
    "appAccountGuid": {
      "type": "string",
      "description": "The unique identifier of the application can be found in the Voice Management App in the API Settings section.",
      "format": "uuid"
    },
    "type": {
      "type": "string",
      "description": "The Application type that should be used. Can be either `directforwarding`, `flowbuilder`, `notification`, `sip`, `halo` or `none`."
    },
    "promptType": {
      "type": [
        "string",
        "null"
      ],
      "description": "The type of prompt that should be played in the notification. Can be either `file` for a custom audio file in the Voice Audio Manager, or `tts` for a text-to-speech message."
    },
    "prompt": {
      "type": [
        "string",
        "null"
      ],
      "description": "The text-to-speech message if the PromptType property is set to `tts`, or the path of the audio file in the Voice Audio Manager if the PromptType property is set to `file`."
    },
    "language": {
      "type": [
        "string",
        "null"
      ],
      "description": "The language of the text-to-speech voice that will be used in ISO 639-1 format. Only relevant if the PromptType value is set to `tts`."
    },
    "gender": {
      "type": [
        "string",
        "null"
      ],
      "description": "The gender of the text-to-speech voice that will be used. Can be either `male` or `female`. Only relevant if the PromptType value is set to `tts`."
    },
    "voiceNumber": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The specific text-to-speech voice that will be used for the given Language and Gender combination. Only relevant if the PromptType value is set to `tts`. Should in most cases be set to 1.",
      "format": "int32"
    },
    "callbackUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "Callback URL that will be called after the Notification was completed."
    }
  },
  "additionalProperties": false
}