Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Media Prompts
  • Platform
    • Users
      • List Users
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
      • Create User
    • Groups
      • List Child Groups
      • Get Group Tree
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • List Webhooks
      • Get Webhook Details
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
      • Create Webhook
    • Media Prompts
      • List Prompts
        GET
      • Upload Prompt
        POST
      • Delete Prompt
        DELETE
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Create Agent
      POST
    • Get Agent Details
      GET
    • Update Agent
      PUT
    • Partial Update Agent
      PATCH
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
      GET
    • Create Broadcast
      POST
    • Get Broadcast Details
      GET
    • Update Broadcast
      PUT
    • Partial Update Broadcast
      PATCH
    • Delete Broadcast
      DELETE
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
    • SMS
      • Get SMS Conversations
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  1. Media Prompts

Upload Prompt

POST
https://platform-api.convirza.com/v3/media-prompts
Media Prompts
Last modified:2026-04-03 14:27:57
Uploads an audio file for call flow recording and stores metadata in the database.
Supported recording types:
prompt: IVR prompts and menu options.
whisper: Agent whisper messages.
voicemail: Voicemail greetings.
survey: Call survey questions.
File requirements:
Maximum file size: 50MB.
Allowed formats: wav, mp3, mp4, ogg, webm, m4a, aac, flac.
File is stored with unique filename to prevent collisions.
Request validation:
name must be unique within the organization unit.
org_unit_id must reference an existing organization.
message_type must be one of the supported types.
Response:
Returns recording ID, file path, and upload confirmation.
Includes metadata for immediate use in call flows.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params multipart/form-dataRequired

Responses

🟢201
application/json
File uploaded successfully
Body

🟠400
🟠401
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://platform-api.convirza.com/v3/media-prompts' \
--header 'Authorization: Bearer <token>' \
--form 'name="Welcome Message"' \
--form 'file=@""' \
--form 'message_type="prompt"' \
--form 'recording_file_type="uploaded"' \
--form 'recording_created_by="456"'
Response Response Example
201 - Example 1
{
    "code": 200,
    "message": "Success",
    "data": {
        "media_prompt_id": 12345,
        "url": "/uploads/call-flow-recordings/welcome-message.wav",
        "filename": "Welcome Message",
        "recording_name": "file-1774815772438-335827217"
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}
Modified at 2026-04-03 14:27:57
Previous
List Prompts
Next
Delete Prompt
Built with