Call Analysis
Get call analysis job
Call Analysis
Get call analysis job
Fetch a call analysis job by ID
GET
/
v1
/
call-analysis
/
{jobId}
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
async function main() {
const callAnalysis = await client.callAnalysis.retrieve('jobId');
console.log(callAnalysis.data);
}
main();
{
"data": {
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"call": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "IN_PROGRESS",
"summary": "<string>",
"callDirection": "INBOUND",
"startedAt": "<string>",
"endedAt": "<string>",
"durationMs": 123,
"endedReason": "<string>",
"isTest": false,
"participants": [
{
"name": "<string>",
"phoneNumber": "<string>",
"role": "AGENT",
"spokeFirst": true
}
]
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Call analysis job details
Analysis job with associated call context
Analysis job ID for tracking progress
Available options:
PENDING
, IN_PROGRESS
, COMPLETED
, FAILED
Available options:
RINGING
, IN_PROGRESS
, ENDED
Available options:
INBOUND
, OUTBOUND
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
async function main() {
const callAnalysis = await client.callAnalysis.retrieve('jobId');
console.log(callAnalysis.data);
}
main();
{
"data": {
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"call": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "IN_PROGRESS",
"summary": "<string>",
"callDirection": "INBOUND",
"startedAt": "<string>",
"endedAt": "<string>",
"durationMs": 123,
"endedReason": "<string>",
"isTest": false,
"participants": [
{
"name": "<string>",
"phoneNumber": "<string>",
"role": "AGENT",
"spokeFirst": true
}
]
}
}
}