call

Uploads an audio file and creates a call detail record.

Uploads a call audio recording file and creates a corresponding call detail record in the system. Accepts either a direct file upload or a URL to an audio file. Supports mp3 and wav formats. Used for importing external call recordings into Convirza for analysis and transcription.

post/call/upload

Request

  • Base URL
    https://apicfa.conviza.com/v2
  • URL
    https://apicfa.conviza.com/v2/call/upload
  • Auth
    none declared

Request body multipart/form-data

recording_filestring binary

Audio file to upload (mp3 or wav format). Required if recording_url is not provided. Cannot be used together with recording_url.

recording_urlstring uri

Public URL of the audio file to import (mp3 or wav format). Required if recording_file is not provided. Cannot be used together with recording_file.

call_datestring date-time required

Time the call started. Format YYYY-MM-DDTHH:MM:SS.000Z. Example 2019-12-24T06:43:13.000Z

group_idinteger required

The unique group to which the call belongs to.

group_ext_idstring

External identifier for the group, used for integration with external systems.

external_idstring

External reference ID linking this call to a record in your system. Must be unique within your organization. Useful for correlating API calls with your database records.

channel_idinteger

The unique identifier for the channel.

campaign_idinteger

Unique identifier representing the campaign.

caller_idinteger required

Phone number of the caller (10 digits). Example 2222444433.

tracking_numberinteger

Tracking phone number associated with this call (10 digits). If omitted, call will appear as "API Upload" in filter widgets. Must belong to your organization. Example 2222444433.

dispositionstring

Call outcome status. Valid values ANSWERED, NO ANSWER, BUSY. Defaults to ANSWERED if not specified.

line_typestring

Type of phone line used for the call. Defaults to VOIP if not specified.

ring_tointeger required

Final destination phone number that was called (10 digits). Example 2222444433.

assign_tostring

Email address of the agent who handled the call. Format user@domain.com.

custom_source_type_1string

Custom marketing source identifier for campaign attribution tracking.

custom_source_type_2string

Custom marketing source identifier for campaign attribution tracking.

custom_source_type_3string

Custom marketing source identifier for campaign attribution tracking.

custom_source_type_4string

Custom marketing source identifier for campaign attribution tracking.

custom_source_type_5string

Custom marketing source identifier for campaign attribution tracking.

company_namestring

Company name associated with the caller.

citystring

City associated with the caller's location.

zip_codeinteger

Postal code associated with the caller's location.

caller_namestring

The name of caller who called.

addressstring

Address associated with the caller.

statestring

State or province associated with the caller's location.

swap_channelstrue | false

Set to true to swap left/right audio channels. Conversation Analytics requires the agent on the right channel and caller on the left. Use this when channels are reversed in the original recording. Defaults to false.

is_outboundtrue | false

Set to true for outbound calls, false for inbound calls. Defaults to false (inbound).

tag_namestring[]

Array of tag names to assign to this call for categorization.

transcribetrue | false

Set to true to automatically transcribe the call audio. Defaults to false.

Response

Confirmation of successful file upload and call record creation

Changes

No recorded changes to this operation across all 2 revisions of this API.