Audio(URL) - Submit New Conversation

POST {{base_url}}/v1/process/audio/url

Submit New Audio File URL:

The Async Audio URL API takes in a url link of your audio to proccess it.

It can be utilized for any use case where you have access to recorded audio stored publicly as URL and want to extract insights and other conversational attributes supported by Symbl's Conversation API.

The URL provided must be a publicly available URL. Currently we do not any support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms.

Learn More about Async Audio API.

Request Body

Parameters	Required	Description
`url`	Yes	A valid URL string. The URL must be a publicly accessible URL.
`customVocabulary`	No	Contains a list of words and phrases that provide hints to the speech recognition task.
`confidenceThreshold`	No	Minimum required confidence for the insight to be recognized. Value range from 0.0 to 1.0. The default value is 0.5.
`detectPhrases`	No	It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. It's a boolean value where the default value is `false`.
`name`	No	Your meeting name. Default name set to `conversationId`.
`webhookUrl`	No	Webhook URL on which job updates to be sent. This should be post API.
`entities`	No	Input custom entities which can be detected in your conversation using Entities' API. For example, check the sample code on right.
`languageCode`	No	We accept different languages. Please check language Code as per your requirement.
`enableSeparateRecognitionPerChannel`	No	Enables Speaker Separated Channel audio processing. Accepts `true` or `false`.
`channelMetadata`	No	This object parameter contains two variables `speaker` and `channel` to specify which speaker corresponds to which channel. This object only works when `enableSeparateRecognitionPerChannel` is set to `true`.

channelMetadata Object

{
  "channelMetadata": [
    {
      "channel": 1,
      "speaker": {
        "name": "Robert Bartheon",
        "email": "robertbartheon@gmail.com"
      }
    },
    {
      "channel": 2,
      "speaker": {
        "name": "Arya Stark",
        "email": "aryastark@gmail.com"
      }
    }
  ]
}

channelMetadata object has the following members:

Field	Description
`channel`	This denotes the channel number in the audio file. Each channel will contain independent speaker's voice data.
`speaker`	This is the wrapper object which defines the speaker for this channel.

speaker has the following members:

Field	Description
`name`	Name of the speaker.
`email`	Email address of the speaker.

Billing for a speaker separated channel audio file happens according to the number of channels present in the audio files. The duration for billing will be calculated according to the below formula:

totalDuration = duration_of_the_audio_file * total_number_of_channels

So if you send a 120-second file with 3 speaker separated channels, the total duration for billing would be 360 seconds or 6 minutes.

Webhook object

webhookUrl will be used to send the status of the job created for the uploaded audio URL. Every time the status of the job changes it will be notified on the webhookUrl.

Field	Description
`jobId`	ID to be used with Job API
`status`	Current status of the job. (Valid statuses - [ scheduled, in_progress, completed, failed ])

Response Object on Success

Field	Description
conversationId	ID to be used with Conversation API
jobId	ID to be used with Job API

Request Params

Key	Datatype	Required	Description
`enableAllTrackers`	boolean

Request Body

{"name"=>"Postman Default Meeting (Sales/Demo)", "url"=>"https://storage.googleapis.com/sales-intelligence-call-recordings/Realtor_Sales_Call_Youtube_12min.mp3", "confidenceThreshold"=>0.6, "timezoneOffset"=>0, "enableSpeakerDiarization"=>true, "diarizationSpeakerCount"=>2, "startTime"=>"2023-01-17T17:26:12", "features"=>{"featureList"=>["insights", "callScore"]}, "conversationType"=>"sales", "metadata"=>{"salesStage"=>"general", "prospectName"=>"Audio File LLC"}}

HEADERS

Key	Datatype	Required	Description
`x-api-key`	string
`Content-Type`	string