List Prompts

GET

https://platform-api.convirza.com/v3/media-prompts

Media Prompts

Last modified:2026-04-03 14:27:57

Returns all call flow recordings for authenticated user organization unit with optional type filtering.

Query parameters:

type: Optional filter by recording type (prompt, whisper, voicemail, survey).

Behavior:

Retrieves all active recordings for the user organization.

Applies type filter when provided.

Returns recordings in descending order by creation date.

Includes file metadata and accessibility information.

Response includes:

Recording details: ID, name, file path, message type.

File metadata: size, format, duration.

Audit information: created_by, created_at.

Total count of matching recordings.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Recordings retrieved successfully

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/media-prompts?name&type' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "prompts": [
            {
                "id": 1,
                "name": "Welcome Message",
                "filename": "welcome-message.mp3",
                "type": "prompt",
                "url": "https://cdn.example.com/recordings/welcome-message.mp3",
                "recording_file_type": "mp3"
            }
        ],
        "whispers": [],
        "voicemails": []
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

Create Webhook

Upload Prompt