{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/CallInterceptPut", "title": "CallInterceptPut", "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "`true` if the intercept feature is enabled." }, "incoming": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INTERCEPT_ALL", "ALLOW_ALL" ], "description": "`INTERCEPT_ALL` indicated incoming calls are intercepted.\n * `INTERCEPT_ALL` - Incoming calls are routed as the destination and voicemail specify.\n * `ALLOW_ALL` - Incoming calls are not intercepted.\n" }, "voicemailEnabled": { "type": "boolean", "description": "If `true`, the destination will be the virtual line's voicemail." }, "announcements": { "type": "object", "properties": { "greeting": { "type": "string", "enum": [ "CUSTOM", "DEFAULT" ], "description": "`DEFAULT` indicates that a system default message will be placed when incoming calls are intercepted.\n * `CUSTOM` - A custom greeting is played when incoming calls are intercepted.\n * `DEFAULT` - A System default greeting is played when incoming calls are intercepted.\n" }, "newNumber": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "If `true`, the caller will hear this new number when a call is intercepted." }, "destination": { "type": "string", "example": "2225551212", "description": "New number caller will hear announced." } }, "description": "Information about the new number announcement." }, "zeroTransfer": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "If `true`, the caller will be transferred to destination of when zero (0) is pressed." }, "destination": { "type": "string", "example": "2225551212", "description": "Destination to which caller will be transferred when zero is pressed." } }, "description": "Information about how call will be handled if zero (0) is pressed." } }, "description": "Settings related to how incoming calls are handled when the intercept feature is enabled." } }, "description": "Settings related to how incoming calls are handled when the intercept feature is enabled." }, "outgoing": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INTERCEPT_ALL", "ALLOW_LOCAL_ONLY" ], "description": "`INTERCEPT_ALL` indicated all outgoing calls are intercepted.\n * `INTERCEPT_ALL` - Outgoing calls are routed as the destination and voicemail specify.\n * `ALLOW_LOCAL_ONLY` - Only non-local calls are intercepted.\n" }, "transferEnabled": { "type": "boolean", "example": true, "description": "If `true`, allows transfer and forwarding for the call type." }, "destination": { "type": "string", "example": "2225551212", "description": "Number to which the outbound call will be transferred." } }, "description": "Settings related to how outgoing calls are handled when the intercept feature is enabled." } } }