TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
phone: '919876543210', // the phone to act with (x-phone)
});
async function main() {
const response = await client.calls.getCall({
call_id: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
});
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/calls/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'x-phone: 919876543210'{
"call_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"notification_id": "false_919999999999@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_919999999999@c.us",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "919999999999@c.us",
"chat_name": "John Doe",
"caller": "919999999999@c.us",
"direction": "incoming",
"result": "connected",
"handled_via": "periskope",
"timestamp": "2026-01-15T09:30:00.000Z",
"duration_seconds": 184,
"answered_by": "agent@example.com",
"transcript": {
"status": "done",
"utterances": [
{
"start_seconds": 12.4,
"speaker": "John Doe",
"text": "Hi, I wanted to check on my order."
}
]
},
"summary": {
"text": "The customer asked about a delayed order. The agent confirmed it ships tomorrow and shared the tracking link."
},
"answered_by_name": "Asha Rao",
"started_at": "2026-01-15T09:30:00.000Z",
"answered_at": "2026-01-15T09:30:05.000Z",
"ended_at": "2026-01-15T09:33:09.000Z",
"end_reason": "remote_end",
"participants": [
{
"email": "agent@example.com",
"name": "Asha Rao",
"role": "host"
}
],
"recording": {
"url": "https://api.periskope.app/app/media/periskope-call-attachments/00000000-0000-0000-0000-000000000000/phone-aaaaaaaaaaaaaaaa/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.wav?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"url_expires_at": "2026-01-15T10:30:00.000Z",
"duration_seconds": 184,
"channels": {
"left": "customer",
"right": "agents"
},
"agent_tracks": [
{
"email": "agent@example.com",
"name": "Asha Rao",
"url": "https://api.periskope.app/app/media/periskope-call-attachments/00000000-0000-0000-0000-000000000000/phone-aaaaaaaaaaaaaaaa/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.agent-0.wav?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
],
"recorded_at": "2026-01-15T09:33:10.000Z",
"truncated": false
}
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "NOT_FOUND_ERROR",
"message": "No call matches call_id",
"status": 404
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Call APIs
Get Call
Returns one call in full, including its transcript. Accepts the call_id or the notification_id.
TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
phone: '919876543210', // the phone to act with (x-phone)
});
async function main() {
const response = await client.calls.getCall({
call_id: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
});
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/calls/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'x-phone: 919876543210'{
"call_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"notification_id": "false_919999999999@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_919999999999@c.us",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "919999999999@c.us",
"chat_name": "John Doe",
"caller": "919999999999@c.us",
"direction": "incoming",
"result": "connected",
"handled_via": "periskope",
"timestamp": "2026-01-15T09:30:00.000Z",
"duration_seconds": 184,
"answered_by": "agent@example.com",
"transcript": {
"status": "done",
"utterances": [
{
"start_seconds": 12.4,
"speaker": "John Doe",
"text": "Hi, I wanted to check on my order."
}
]
},
"summary": {
"text": "The customer asked about a delayed order. The agent confirmed it ships tomorrow and shared the tracking link."
},
"answered_by_name": "Asha Rao",
"started_at": "2026-01-15T09:30:00.000Z",
"answered_at": "2026-01-15T09:30:05.000Z",
"ended_at": "2026-01-15T09:33:09.000Z",
"end_reason": "remote_end",
"participants": [
{
"email": "agent@example.com",
"name": "Asha Rao",
"role": "host"
}
],
"recording": {
"url": "https://api.periskope.app/app/media/periskope-call-attachments/00000000-0000-0000-0000-000000000000/phone-aaaaaaaaaaaaaaaa/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.wav?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"url_expires_at": "2026-01-15T10:30:00.000Z",
"duration_seconds": 184,
"channels": {
"left": "customer",
"right": "agents"
},
"agent_tracks": [
{
"email": "agent@example.com",
"name": "Asha Rao",
"url": "https://api.periskope.app/app/media/periskope-call-attachments/00000000-0000-0000-0000-000000000000/phone-aaaaaaaaaaaaaaaa/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.agent-0.wav?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
],
"recorded_at": "2026-01-15T09:33:10.000Z",
"truncated": false
}
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "NOT_FOUND_ERROR",
"message": "No call matches call_id",
"status": 404
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Authorizations
Headers
Path Parameters
Response
The call in full, with its transcript
A WhatsApp call on one of the organization's phones: who called whom, how it ended and, for calls handled in Periskope, its recording, participants, transcript and summary.
'periskope' when the call's audio ran through Periskope (answered or placed by a member in the app); 'phone' otherwise — answered, placed or missed on the WhatsApp phone itself. Only Periskope calls have a recording, transcript and summary.
Available options:
periskope, phone Example:
"periskope"
Was this page helpful?