Skip to content

Changes to phonecom apiv4.swagger.json in v1.0.5

Igor Simevski edited this page Mar 28, 2017 · 1 revision

Changes

In paths

Added

"/accounts/{account_id}/media/files": {
  "post": {
    "security": [
      {
        "apiKey": []
      }
    ],
    "tags": [
      "media"
    ],
    "summary": "Add a media object to your account that can be used as a greeting or hold music. Users may create a media by using the built-in Text-to-speech (TTS) facility or upload a file of their choice. (Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB)",
    "description": "See Account Media for more info on the properties.",
    "operationId": "create-account-media-files",
    "consumes": [
      "multipart/form-data"
    ],
    "produces": [
      "application/json"
    ],
    "parameters": [
      {
        "$ref": "#/parameters/accountIdParam"
      },
      {
        "name": "json",
        "in": "formData",
        "description": "Media extra parameters",
        "required": false,
        "type": "string"
      },
      {
        "name": "file",
        "in": "formData",
        "description": "Media file",
        "required": false,
        "type": "file"
      }
    ],
    "responses": {
      "201": {
        "description": "Created",
        "schema": {
          "$ref": "#/definitions/MediaFull"
        }
      },
      "401": {
        "$ref": "#/responses/response401"
      },
      "403": {
        "$ref": "#/responses/response403"
      },
      "422": {
        "$ref": "#/responses/response422"
      }
    }
  }
}

In /accounts/{account_id}/media > post
Before "operationId": "create-account-media"
After "operationId": "create-account-media-tts"
And moved post in /accounts/{account_id}/media/tts


Before "/accounts/{account_id}/media/{recording_id}"
After "/accounts/{account_id}/media/{media_id}"

In /accounts/{account_id}/media/{media_id} > get
Before

{
	"name": "recording_id",
	"in": "path",
	"description": "Recording ID",
	"required": true,
	"type": "integer"
}

After

{
	"$ref": "#/parameters/mediaIdParam"
}

Added Replace and Delete Media

"put": {
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    "media"
  ],
  "summary": "Update a media object to your account. Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB.",
  "description": "See Account Media for more info on the properties.",
  "operationId": "replace-account-media-tts",
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "parameters": [
    {
      "$ref": "#/parameters/accountIdParam"
    },
    {
      "$ref": "#/parameters/mediaIdParam"
    },
    {
      "name": "data",
      "in": "body",
      "description": "Media data",
      "required": false,
      "schema": {
        "$ref": "#/definitions/CreateMediaParams"
      }
    }
  ],
  "responses": {
    "201": {
      "description": "Replaced",
      "schema": {
        "$ref": "#/definitions/MediaFull"
      }
    },
    "401": {
      "$ref": "#/responses/response401"
    },
    "403": {
      "$ref": "#/responses/response403"
    },
    "404": {
      "$ref": "#/responses/response404"
    },
    "422": {
      "$ref": "#/responses/response422"
    }
  }
},
"delete": {
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    "media"
  ],
  "summary": "Delete an individual media record",
  "description": "See Account Media for more info on the properties.",
  "operationId": "delete-account-media",
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "parameters": [
    {
      "$ref": "#/parameters/accountIdParam"
    },
    {
      "$ref": "#/parameters/mediaIdParam"
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "schema": {
        "$ref": "#/definitions/DeleteMedia"
      }
    },
    "401": {
      "$ref": "#/responses/response401"
    },
    "403": {
      "$ref": "#/responses/response403"
    },
    "404": {
      "$ref": "#/responses/response404"
    },
    "409": {
      "$ref": "#/responses/response409"
    }
  }
}

In /accounts/{account_id}/menus/{menu_id} > put
Before "description": "This service replaces the details of an individual Menu."
After "description": "See Account Menus for more info on the properties."

In /accounts/{account_id}/menus/{menu_id} > delete
Before "description": "This service shows the details of an individual menu."
After "description": "See Account Menus for more info on the properties."


In parameters

Added `mediaIdParam"

"mediaIdParam": {
  "name": "media_id",
  "in": "path",
  "description": "Media ID",
  "required": true,
  "type": "integer"
}

In definitions

In ListPhoneNumbers

Before

"items": {
  "description": "Array of Contact Phone Number Objects. See below for details.",
  "type": "array",
  "items": {
    "$ref": "#/definitions/PhoneNumberContact"
  }
}

After

"items": {
  "description": "Array of Contact Phone Number Objects. See below for details.",
  "type": "array",
  "items": {
    "$ref": "#/definitions/PhoneNumberFull"
  }
}

Added

"DeleteMedia": {
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  }
}