Sign in
AI Call Analysis

Sends a call recording for AI analysis. Send a signed url for the recording along with the call type and the agent name. Credits are charged on the length of the recording, measured by us, at one credit per minute rounded up. The analysis runs in the background, so this returns a requestId which you use to check the progress and fetch the result.

post/call/analysis/initiate

Request body

recordingUrlstring required

A signed url for the recording, time limited, for example a pre-signed Amazon S3 or Google Cloud Storage url. It must be an https url carrying a signature, and it needs to stay valid until the analysis finishes.

callType'incoming' | 'outgoing' required

Whether the call was incoming or outgoing. Missed calls and calls of no length cannot be analysed.

callerNamestring

Name of the agent who handled the call. Optional (pass it for better results).

customerNamestring

Name of the customer on the call. Optional.

processIdstring

Id of the process. Optional, and accepted for compatibility, but a recording sent through this API is always analysed against your default process.

metadataobject

Any reference of your own, such as a ticket number or a campaign name. Saved exactly as you send it and returned unchanged when you fetch the analysis. Up to 50 entries.

Response

If the auth token is valid.

statusCodenumber

Will be 0 in case of success

messagestring

Contains the success message or error reason, based on the statusCode

Example response

{
  "statusCode": 0,
  "message": "Successfully initiated the call analysis",
  "data": {
    "requestId": "68b1f2c9a4d3e5f601234567",
    "status": 2,
    "creditsUsed": 3
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.