Alianza

Alianza Media API

The Media API from Alianza — 6 operation(s) for media.

Documentation GitHub OpenAPI

Operations 9

GET /v2/partition/{partitionId}/account/{accountId}/media_2/{id} Retrieve Media. Will return a 302 redirect to the actual file location #

PUT /v2/partition/{partitionId}/account/{accountId}/media_2/{id} Update 2 #

DELETE /v2/partition/{partitionId}/account/{accountId}/media_2/{id} Delete hold music #

POST /v2/partition/{partitionId}/account/{accountId}/media_2 Upload IVR Prompt or Account Hold Music #

GET /v2/partition/{partitionId}/account/{accountId}/media_2/type/holdmusic Retrieve Hold Music Media ID #

DELETE /v2/partition/{partitionId}/account/{accountId}/media_2/type/holdmusic Remove the hold music media selection for this account #

PUT /v2/partition/{partitionId}/account/{accountId}/media_2/type/holdmusic/{id} Set the hold music on this account to this media storage id #

GET /v2/partition/{partitionId}/account/{accountId}/media/{mediaId} Retrieve Media of type #

POST /v2/partition/{partitionId}/account/{accountId}/media Add IVR prompt #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/alianza/openapi/alianza-media-api-openapi.yml

Other Resources

🔗

Swagger

https://artifacts.apis.io/alianza/openapi/_original/alianza-apidocs-swagger2-original.json

🔗

ToolCrosswalk

https://artifacts.apis.io/alianza/mcp/alianza-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/alianza:alianza-media-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Alianza Media API
  version: '2'
  description: 'Operations tagged Media across 2 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
  description: Development
- url: https://api.q2.alianza.com
  description: QA
- url: https://api.b2.alianza.com
  description: Beta
- url: https://api.alianza.com
  description: Production
tags:
- name: Media
paths:
  /v2/partition/{partitionId}/account/{accountId}/media_2/{id}:
    get:
      tags:
      - Media
      summary: Retrieve Media. Will return a 302 redirect to the actual file location
      description: Use to retrieve Media of a given type
      operationId: get_1
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ID of prompt
        required: true
        schema:
          type: string
      - name: mediaType
        in: query
        description: Type of Media
        required: true
        schema:
          type: string
          enum:
          - HoldMusic
          - IvrPrompt
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              type: string
              format: byte
          content:
            application/octet-stream:
              schema:
                type: array
                items:
                  type: string
                  format: byte
        '400':
          description: Invalid Media Type supplied
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              type: string
              format: byte
          schema:
            type: array
            items:
              type: string
              format: byte
        '400':
          description: Invalid Media Type supplied
    put:
      tags:
      - Media
      operationId: update_2
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: successful operation
      responsesObject:
        default:
          description: successful operation
      deprecated: true
      summary: Update 2
      x-summary-source: derived
    delete:
      tags:
      - Media
      operationId: deleteHoldMusic
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ID of Hold Music Media
        required: true
        schema:
          type: string
      responses:
        default:
          description: successful operation
      responsesObject:
        default:
          description: successful operation
      deprecated: true
      summary: Delete hold music
      x-summary-source: derived
  /v2/partition/{partitionId}/account/{accountId}/media_2:
    post:
      tags:
      - Media
      summary: Upload IVR Prompt or Account Hold Music
      description: 'Use to add an IVR Prompt (use file upload to submit a wav file).

        Use to add Hold Music (use the job service, then submit the jobUploadKey for the wav, mp3, ogg already uploaded)'
      operationId: uploadAccountMedia
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: jobUploadKey
        in: query
        description: Provide an upload key (Use for Hold Music)
        required: false
        schema:
          type: string
      responses:
        '400':
          description: Invalid ID supplied
        '404':
          description: Account not found
        '200':
          description: Processed the IVR Prompt file upload
          responseSchema:
            originalRef: MediaX
            $ref: '#/components/schemas/MediaX'
          content:
            application/json:
              schema:
                originalRef: MediaX
                $ref: '#/components/schemas/MediaX'
        '202':
          description: When providing a file upload key. The key has been accepted and the asynchronous process has started
          responseSchema:
            originalRef: Job
            $ref: '#/components/schemas/Job'
          content:
            application/json:
              schema:
                originalRef: Job
                $ref: '#/components/schemas/Job'
      responsesObject:
        '400':
          description: Invalid ID supplied
        '404':
          description: Account not found
        '200':
          description: Processed the IVR Prompt file upload
          responseSchema:
            originalRef: MediaX
            $ref: '#/components/schemas/MediaX'
          schema:
            originalRef: MediaX
            $ref: '#/components/schemas/MediaX'
        '202':
          description: When providing a file upload key. The key has been accepted and the asynchronous process has started
          responseSchema:
            originalRef: Job
            $ref: '#/components/schemas/Job'
          schema:
            originalRef: Job
            $ref: '#/components/schemas/Job'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Wave File to upload. (Use for IVR prompt)
                  format: binary
  /v2/partition/{partitionId}/account/{accountId}/media_2/type/holdmusic:
    get:
      tags:
      - Media
      summary: Retrieve Hold Music Media ID
      description: Use to retrieve Hold Music Media ID
      operationId: getAccountHoldMusic
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: custom
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: HoldMusicX
            $ref: '#/components/schemas/HoldMusicX'
          content:
            application/json:
              schema:
                originalRef: HoldMusicX
                $ref: '#/components/schemas/HoldMusicX'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: HoldMusicX
            $ref: '#/components/schemas/HoldMusicX'
          schema:
            originalRef: HoldMusicX
            $ref: '#/components/schemas/HoldMusicX'
    delete:
      tags:
      - Media
      summary: Remove the hold music media selection for this account
      description: Used to remove an existing media storage id that is used to play hold music for this account.
      operationId: deleteAccountMusicOnHold
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        default:
          description: successful operation
      responsesObject:
        default:
          description: successful operation
  /v2/partition/{partitionId}/account/{accountId}/media_2/type/holdmusic/{id}:
    put:
      tags:
      - Media
      summary: Set the hold music on this account to this media storage id
      description: Used to set the hold music to a different storage id
      operationId: updateAccountMusicOnHold
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Hold Music storage id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: HoldMusicX
            $ref: '#/components/schemas/HoldMusicX'
          content:
            application/json:
              schema:
                originalRef: HoldMusicX
                $ref: '#/components/schemas/HoldMusicX'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: HoldMusicX
            $ref: '#/components/schemas/HoldMusicX'
          schema:
            originalRef: HoldMusicX
            $ref: '#/components/schemas/HoldMusicX'
  /v2/partition/{partitionId}/account/{accountId}/media/{mediaId}:
    get:
      tags:
      - Media
      summary: Retrieve Media of type
      description: Use to retrieve Media of a given type
      operationId: get_2
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: mediaId
        in: path
        description: ID of prompt
        required: true
        schema:
          type: string
      - name: fileName
        in: query
        description: Name of media
        required: false
        schema:
          type: string
      - name: mediaType
        in: query
        description: Type of Media
        required: true
        schema:
          type: string
          enum:
          - HoldMusic
          - IvrPrompt
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              type: string
              format: byte
          content:
            application/octet-stream:
              schema:
                type: array
                items:
                  type: string
                  format: byte
        '400':
          description: Invalid Media ID supplied
        '404':
          description: Account not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              type: string
              format: byte
          schema:
            type: array
            items:
              type: string
              format: byte
        '400':
          description: Invalid Media ID supplied
        '404':
          description: Account not found
  /v2/partition/{partitionId}/account/{accountId}/media:
    post:
      tags:
      - Media
      summary: Add IVR prompt
      description: Use to add an IVR prompt
      operationId: add
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: string
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Invalid ID supplied
        '404':
          description: Account or IVR not found
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: string
          schema:
            type: string
        '400':
          description: Invalid ID supplied
        '404':
          description: Account or IVR not found
      requestBody:
        content:
          multipart/form-data:
            schema:
              originalRef: MultipartFormDataInput
              $ref: '#/components/schemas/MultipartFormDataInput'
        description: Media file
        required: true
components:
  schemas:
    MediaX:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
    JobError:
      type: object
      properties:
        error:
          type: string
        lineNumber:
          type: integer
          format: int32
        column:
          type: string
        input:
          type: string
    Job:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        userId:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - DONE
          - FAILED
        errors:
          type: array
          items:
            originalRef: JobError
            $ref: '#/components/schemas/JobError'
        inputKey:
          type: string
        outputKey:
          type: string
        start:
          type: integer
          format: int64
        lastUpdated:
          type: integer
          format: int64
    MultipartFormDataInput:
      type: object
    HoldMusicX:
      type: object
      properties:
        storageId:
          type: string
        url:
          type: string
    Job_2:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        userId:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - DONE
          - FAILED
        errors:
          type: array
          items:
            $ref: '#/components/schemas/JobError'
        inputKey:
          type: string
        outputKey:
          type: string
        start:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
      xml:
        name: job
    MultipartFormDataInput_2:
      type: object
      properties:
        file:
          type: string
          format: binary
    PublicApiException:
      type: object
      properties:
        status:
          type: integer
        messages:
          type: array
          items:
            type: string
        data:
          type: object
          additionalProperties: true
          example:
            key: value
            key2: value2
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
x-refined-from:
- alianza-apidocs-swagger2-original.json
- alianza-openapi-original.yml
x-provenance:
  method: harvested
  publisher: Alianza
  source: https://developer.alianza.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)