Skip to content

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

Jump to bottom
Igor Simevski edited this page Apr 5, 2017 · 1 revision

Changes

In paths

Added:

"/accounts/{account_id}/media/files/{media_id}": {
  "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-files",
    "consumes": [
      "application/json"
    ],
    "produces": [
      "application/json"
    ],
    "parameters": [
      {
        "$ref": "#/parameters/accountIdParam"
      },
      {
        "$ref": "#/parameters/mediaIdParam"
      },
      {
        "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": "Replaced",
        "schema": {
          "$ref": "#/definitions/MediaFull"
        }
      },
      "401": {
        "$ref": "#/responses/response401"
      },
      "403": {
        "$ref": "#/responses/response403"
      },
      "404": {
        "$ref": "#/responses/response404"
      },
      "422": {
        "$ref": "#/responses/response422"
      }
    }
  }
},
"/accounts/{account_id}/media/tts/{media_id}": {
  "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"
      }
    }
  }
}

In definitions

In CreateExtensionParams > Properties:
Added

"voicemail": {
  "$ref": "#/definitions/Voicemail",
  "description": "Voicemail object"
},
"call_notifications": {
  "$ref": "#/definitions/CallNotifications",
  "description": "Call Notifications object"
}

Removed

"voicemail[greeting][alternate]": {
  "type": "object",
  "description": "Recording lookup object"
},
"voicemail[greeting][enable_leave_message_prompt]": {
  "type": "boolean",
  "description": "Enable the \"leave a message\" prompt for voicemail"
},
"voicemail[enabled]": {
  "type": "boolean",
  "description": "Voicemail enabled"
},
"voicemail[password]": {
  "type": "integer",
  "description": "Voicemail password"
},
"voicemail[greeting][type]": {
  "type": "string",
  "description": "Voicemail greeting type"
},
"voicemail[greeting][standard]": {
  "type": "object",
  "description": "Recording lookup object"
},
"voicemail[transcription]": {
  "type": "string",
  "description": "Voicemail transcription type"
},
"voicemail[notifications][emails]": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "description": "Email notifications for voicemails. Can be a single email or an array of emails"
},
"voicemail[notifications][sms]": {
  "type": "string",
  "description": "SMS notifications for voicemails"
},
"call_notifications[emails]": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "description": "Email notifications for calls. Can be a single email or an array of emails"
},
"call_notifications[sms]": {
  "type": "string",
  "description": "SMS notifications for calls"
}

In ReplaceExtensionParams > Properties:
Added

"voicemail": {
  "$ref": "#/definitions/Voicemail",
  "description": "Voicemail object"
},
"call_notifications": {
  "$ref": "#/definitions/CallNotifications",
  "description": "Call Notifications object"
}

Removed

"voicemail[greeting][alternate]": {
  "type": "object",
  "description": "Recording lookup object"
},
"voicemail[password]": {
  "type": "integer",
  "description": "Voicemail password"
},
"voicemail[greeting][standard]": {
  "type": "object",
  "description": "Recording lookup object"
},
"voicemail[greeting][type]": {
  "type": "string",
  "description": "Voicemail greeting type"
},
"voicemail[enabled]": {
  "type": "boolean",
  "description": "Voicemail enabled"
},
"voicemail[greeting][enable_leave_message_prompt]": {
  "type": "boolean",
  "description": "Use leave message prompt after voicemail"
},
"voicemail[transcription]": {
  "type": "string",
  "description": "Voicemail transcription type"
},
"voicemail[notifications][emails]": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "description": "Email notifications for voicemails. Can be a single email or an array of emails"
},
"voicemail[notifications][sms]": {
  "type": "string",
  "description": "SMS notifications for voicemails"
},
"call_notifications[emails]": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "description": "Email notifications for calls. Can be a single email or an array of emails"
},
"call_notifications[sms]": {
  "type": "string",
  "description": "SMS notifications for calls"
}

Changed
Before

"route": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "description": "Route object lookup (must belong to this extension)"
}

After

"route": {
  "type": "string",
  "description": "Route object lookup (must belong to this extension)"
}

In CreatePhoneNumberParams > Properties:
Added

"caller_id": {
  "$ref": "#/definitions/CallerIdPhoneNumber",
  "description": "Caller ID object"
},": {
  "$ref": "#/definitions/SmsForwardingParams",
  "description": "SMS Forwarding Object, or NULL"
},
"call_notifications": {
  "$ref": "#/definitions/CallNotifications",
  "description": "Call Notifications object"
}

Removed

"caller_id[name]": {
  "type": "string",
  "description": "Caller ID name"
},
"caller_id[type]": {
  "type": "string",
  "description": "Caller ID type"
},
"sms_forwarding[type]": {
  "type": "string",
  "description": "'application' or 'extension'"
},
"sms_forwarding[application]": {
  "type": "object",
  "description": "Application lookup object"
},
"sms_forwarding[extension]": {
  "type": "object",
  "description": "Extension lookup object"
},
"call_notifications[emails]": {
  "type": "array",
  "description": "Call notifications for emails. Can be a single email or an array of emails",
  "items": {
    "type": "string"
  }
},
"call_notifications[sms]": {
  "type": "string",
  "description": "Call notification for SMS"
}

Added:

"SmsForwardingParams": {
  "description": "SMS Forwarding Object, or NULL",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Can be \"extension\" or \"application\"",
      "pattern": "extension|application"
    },
    "extension": {
      "type": "integer",
      "description": "Required if type = \"extension\". Extension that messages should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object."
    },
    "application": {
      "type": "integer",
      "description": "Required if type = \"application\". Application that messages should be directed to. Output is an Application Summary Object. Input must be an Application Lookup Object."
    }
  }
}

In ReplacePhoneNumberParams > Properties
Added

"caller_id": {
  "$ref": "#/definitions/CallerIdPhoneNumber",
  "description": "Caller ID object"
},
"sms_forwarding": {
  "$ref": "#/definitions/SmsForwardingParams",
  "description": "SMS Forwarding Object, or NULL"
},
"call_notifications": {
  "$ref": "#/definitions/CallNotifications",
  "description": "Call Notifications object"
}

Removed

"caller_id[name]": {
  "type": "string",
  "description": "Caller ID name"
},
"caller_id[type]": {
  "type": "string",
  "description": "Caller ID type"
},
"sms_forwarding[type]": {
  "type": "string",
  "description": "'application' or 'extension'"
},
"sms_forwarding[application]": {
  "type": "object",
  "description": "Application lookup object"
},
"sms_forwarding[extension]": {
  "type": "object",
  "description": "Extension lookup object"
},
"call_notifications[emails]": {
  "type": "array",
  "description": "Call notifications for emails. Can be a single email or an array of emails",
  "items": {
    "type": "string"
  }
},
"call_notifications[sms]": {
  "type": "string",
  "description": "Call notification for SMS"
}

In CallerIdPhoneNumber > Properties
Changed
Before

"type": {
  "type": "string",
  "description": "Can be \"business\" or \"personal\"",
  "pattern": "extension|application"
}

After

"type": {
  "type": "string",
  "description": "Can be \"business\" or \"personal\"",
  "pattern": "business|personal"
}
Clone this wiki locally