API Reference
Fetch Single Call
11min
get call details retrieve detailed information about a specific call, including its transcription, analysis results, and associated metadata endpoint get https //app salesriver ai/api/v1/calls/\ id path parameters parameter type description id string the unique identifier of the call response the response includes comprehensive information about the call, including its metadata, transcription, and ai analysis results response structure type callresponse = { id string; createdat date; duration number | null; outcome string | null; rep score number | null; source string | null; status callstatus; state string | null; external id string | null; ai cost number | null; analysis error string | null; model identifier string | null; rep { id string; external id string; } | null; analysis { \[key string] string | null; custom data extraction \[{ question string; answer string; }] }; transcription { text string; confidence number; words any\[]; utterances { speaker string; start number; end number; text string; words any\[]; confidence number; }\[]; }; }; response fields field type description id string unique identifier of the call createdat date timestamp when the call was created duration number duration of the call in seconds outcome string outcome of the call rep score number score assigned to the representative (0 5) source string source of the call that was passed in when the call was analyzed status string current status of the call possible values uploaded , transcribing , transcribed , analyzing , complete , error state string state that the caller is located in this value is passed in when the call was analyzed external id string the id of the call in your system ai cost number cost of ai transcription & analysis in dollars analysis error string error message if analysis failed, null if successful caller number string the caller number rep object representative information rep id string representative's unique identifier rep external id string representative's external identifier analysis object analysis results from ai model will contain key value pairs for every piece of data extracted, as well as a custom data extraction array of objects with the question (question key field) and the answer analysis custom data extraction object custom data extraction results, if any transcription object call transcription details transcription text string full transcription text transcription confidence number confidence score for the transcript, between 0 0 (low confidence) and 1 0 (high confidence) transcription words array array of transcribed words with timestamps, speaker labels, and a confidence score of 0 1 transcription utterances array array of utterances with speaker labels, timestamps, text, and an array of words example request curl i h "authorization your api key" \\ https //api example com/api/v1/calls/123e4567 e89b 12d3 a456 426614174000 example response { id "123e4567 e89b 12d3 a456 426614174000", createdat new date("2024 03 15t10 30 00z"), duration 180, outcome "success", rep score 0 85, source "abc media", status "complete", state "fl", external id "5237642", ai cost 0 18, analysis error null, caller number "+18598675309", model identifier "med adv inbound call", rep { id "789e4567 e89b 12d3 a456 426614174000", external id "rep123" }, analysis { sentiment "positive", key points "discussed medicare advantage plan benefits", custom data extraction \[{ question "did agent follow script", answer "no" }] }, transcription { text "hello, i'm interested in learning about medicare advantage plans can you tell me more about the benefits?", confidence 0 95, words \[ { text "hello", start 0, end 0 5, confidence 0 98, speaker "a" }, { text "i'm", start 0 6, end 0 8, confidence 0 97, speaker "a" }, { text "interested", start 0 9, end 1 2, confidence 0 96, speaker "a" }, { text "in", start 1 3, end 1 4, confidence 0 99, speaker "a" }, { text "learning", start 1 5, end 1 8, confidence 0 95, speaker "a" }, { text "about", start 1 9, end 2 0, confidence 0 99, speaker "a" }, { text "medicare", start 2 1, end 2 4, confidence 0 94, speaker "a" }, { text "advantage", start 2 5, end 2 8, confidence 0 93, speaker "a" }, { text "plans", start 2 9, end 3 1, confidence 0 97, speaker "a" }, { text "can", start 3 2, end 3 3, confidence 0 98, speaker "a" }, { text "you", start 3 4, end 3 5, confidence 0 99, speaker "a" }, { text "tell", start 3 6, end 3 7, confidence 0 97, speaker "a" }, { text "me", start 3 8, end 3 9, confidence 0 99, speaker "a" }, { text "more", start 4 0, end 4 2, confidence 0 96, speaker "a" }, { text "about", start 4 3, end 4 4, confidence 0 99, speaker "a" }, { text "the", start 4 5, end 4 6, confidence 0 99, speaker "a" }, { text "benefits", start 4 7, end 5 0, confidence 0 95, speaker "a" } ], utterances \[ { speaker "a", start 0, end 2 8, text "hello, i'm interested in learning about medicare advantage plans ", words \[ { text "hello", start 0, end 0 5, confidence 0 98, speaker "a" }, { text "i'm", start 0 6, end 0 8, confidence 0 97, speaker "a" }, { text "interested", start 0 9, end 1 2, confidence 0 96, speaker "a" }, { text "in", start 1 3, end 1 4, confidence 0 99, speaker "a" }, { text "learning", start 1 5, end 1 8, confidence 0 95, speaker "a" }, { text "about", start 1 9, end 2 0, confidence 0 99, speaker "a" }, { text "medicare", start 2 1, end 2 4, confidence 0 94, speaker "a" }, { text "advantage", start 2 5, end 2 8, confidence 0 93, speaker "a" } ], confidence 0 96 }, { speaker "a", start 2 9, end 3 1, text "plans ", words \[ { text "plans", start 2 9, end 3 1, confidence 0 97, speaker "a" } ], confidence 0 97 }, { speaker "a", start 3 2, end 5 0, text "can you tell me more about the benefits?", words \[ { text "can", start 3 2, end 3 3, confidence 0 98, speaker "a" }, { text "you", start 3 4, end 3 5, confidence 0 99, speaker "a" }, { text "tell", start 3 6, end 3 7, confidence 0 97, speaker "a" }, { text "me", start 3 8, end 3 9, confidence 0 99, speaker "a" }, { text "more", start 4 0, end 4 2, confidence 0 96, speaker "a" }, { text "about", start 4 3, end 4 4, confidence 0 99, speaker "a" }, { text "the", start 4 5, end 4 6, confidence 0 99, speaker "a" }, { text "benefits", start 4 7, end 5 0, confidence 0 95, speaker "a" } ], confidence 0 97 } ] } } error responses invalid api key http/1 1 401 unauthorized invalid api key call not found http/1 1 404 not found call not found method not allowed http/1 1 405 method not allowed method post not allowed internal server error http/1 1 500 internal server error internal server error