Bandwidth Media API

openapi: 3.2.0
info:
  title: Bandwidth Messaging Media API
  description: The Bandwidth Messaging API allows developers to send and receive SMS and MMS messages programmatically. It supports both toll-free and local number messaging, group messaging, and application-to-person (A2P) messaging workflows. The API provides delivery receipts via webhooks, message status tracking, and media management for MMS attachments. Bandwidth operates its own tier-1 network, providing direct carrier connectivity for reliable message delivery.
  version: '2.0'
  contact:
    name: Bandwidth Support
    url: https://support.bandwidth.com
  termsOfService: https://www.bandwidth.com/legal/
servers:
- url: https://messaging.bandwidth.com/api/v2
  description: Production Server
security:
- basicAuth: []
tags:
- name: Media
  description: Upload, retrieve, and manage media files for use in MMS messages. Supports files up to 3.75 MB with 48-hour retention.
paths:
  /users/{accountId}/media:
    get:
      operationId: listMedia
      summary: List media files
      description: Retrieves a list of all media files that have been uploaded to the account. Each request returns a maximum of 1000 media files. Bandwidth retains uploaded media for up to 48 hours.
      tags:
      - Media
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: continuationToken
        in: query
        description: Token for paginating through large media lists
        schema:
          type: string
      responses:
        '200':
          description: Media list retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Media'
        '401':
          description: Unauthorized
  /users/{accountId}/media/{mediaName}:
    put:
      operationId: uploadMedia
      summary: Upload a media file
      description: Uploads a media file for use in MMS messages. Files can be up to 3.75 MB in size. Bandwidth provides free file storage for an unlimited number of files with 48-hour retention.
      tags:
      - Media
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: mediaName
        in: path
        required: true
        description: The filename to assign to the uploaded media
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        description: The MIME type of the media file being uploaded
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '204':
          description: Media uploaded successfully
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    get:
      operationId: getMedia
      summary: Download a media file
      description: Downloads a specific media file by its name. Returns the binary content of the media file.
      tags:
      - Media
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: mediaName
        in: path
        required: true
        description: The name of the media file to download
        schema:
          type: string
      responses:
        '200':
          description: Media file content
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
        '404':
          description: Media not found
    delete:
      operationId: deleteMedia
      summary: Delete a media file
      description: Permanently deletes a specific media file from the account.
      tags:
      - Media
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: mediaName
        in: path
        required: true
        description: The name of the media file to delete
        schema:
          type: string
      responses:
        '204':
          description: Media deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Media not found
components:
  schemas:
    Media:
      type: object
      properties:
        mediaName:
          type: string
          description: The name of the media file
        contentLength:
          type: integer
          description: The size of the media file in bytes
        contentType:
          type: string
          description: The MIME type of the media file
        content:
          type: string
          description: The URL to access the media content
  parameters:
    accountId:
      name: accountId
      in: path
      required: true
      description: The unique identifier for the Bandwidth account
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using your Bandwidth API credentials. Use your API username and password from the Bandwidth Dashboard.
externalDocs:
  description: Bandwidth Messaging API Documentation
  url: https://dev.bandwidth.com/docs/messaging/