jambonz-feature-server/lib/tasks/specs.json

{
  "sip:decline": {
    "properties": {
      "status": "number",
      "reason": "string",
      "headers": "object"
    },
    "required": [
      "status"
    ]
  },
  "hangup": {
    "properties": {
      "headers": "object"
    },
    "required": [
    ]
  },
  "play": {
    "properties": {
      "url": "string",
      "loop": "number",
      "earlyMedia": "boolean"
    },
    "required": [
      "url"
    ]
  },
  "say": {
    "properties": {
      "text": "string",
      "loop": "number",
      "synthesizer": "#synthesizer",
      "earlyMedia": "boolean"
    },
    "required": [
      "text"
    ]
  },
  "gather": {
    "properties": {
      "action": "string",
      "finishOnKey": "string",
      "input": "array",
      "numDigits": "number",
      "partialResultCallback": "string",
      "speechTimeout": "number",
      "timeout": "number",
      "recognizer": "#recognizer",
      "play": "#play",
      "say": "#say"
    },
    "required": [
      "action"
    ]
  },
  "dial": {
    "properties": {
      "action": "string",
      "answerOnBridge": "boolean",
      "callerId": "string",
      "confirmUrl": "string",
      "confirmMethod": {
        "type": "string",
        "enum": ["GET", "POST"]
      },
      "dialMusic": "string",
      "headers": "object",
      "listen": "#listen",
      "method": {
        "type": "string",
        "enum": ["GET", "POST"]
      },
      "target": ["#target"],
      "timeLimit": "number",
      "timeout": "number",
      "transcribe": "#transcribe"
    },
    "required": [
      "target"
    ]
  },
  "listen": {
    "properties": {
      "action": "string",
      "finishOnKey": "string",
      "maxLength": "number",
      "metadata": "object",
      "mixType": {
        "type": "string",
        "enum": ["mono", "stereo", "mixed"]
      },
      "passDtmf": "boolean",
      "playBeep": "boolean",
      "sampleRate": "number",
      "timeout": "number",
      "transcribe": "#transcribe",
      "url": "string",
      "earlyMedia": "boolean"
    },
    "required": [
      "url"
    ]
  },
  "transcribe": {
    "properties": {
      "transcriptionCallback": "string",
      "recognizer": "#recognizer",
      "earlyMedia": "boolean"
    },
    "required": [
      "transcriptionCallback"
    ]
  },
  "target": {
    "properties": {
      "type": {
        "type": "string",
        "enum": ["phone", "sip", "user"]
      },
      "url": "string",
      "method": {
        "type": "string",
        "enum": ["GET", "POST"]
      },
      "number": "string",
      "sipUri": "string",
      "auth": "#auth",
      "name": "string"
    },
    "required": [
      "type"
    ]
  },
  "auth": {
    "properties": {
      "user": "string",
      "password": "string"
    },
    "required": [
      "user",
      "password"
    ]
  },
  "synthesizer": {
    "properties": {
      "vendor": {
        "type": "string",
        "enum": ["google"]
      },
      "voice": "string"
    },
    "required": [
      "vendor"
    ]
  },
  "recognizer": {
    "properties": {
      "vendor": {
        "type": "string",
        "enum": ["google"]
      },
      "language": "string",
      "hints": "array",
      "profanityFilter": "boolean",
      "interim": "boolean",
      "dualChannel": "boolean"
    },
    "required": [
      "vendor"
    ]
  }
}