Read the call log

View call details and transcripts in the dashboard or through the API, with card details redacted.

List sessions

List voice sessions to review recent calls. Filter by status or creation date. Use customerPartyId to view a customer’s sessions. For platform users and API keys, the default call log also includes sessions initiated by the platform or its agents for customers. Like payment-request and transaction history, this recorded activity remains available after the customer disconnects, subject to the reader’s platform permissions. The same access applies to call details and transcripts. Calls started directly by a customer appear in that customer’s view. Pass customerPartyId to read that view. Cross-customer history does not include a dial URI.

from naturalpay import Natural

# Set NATURAL_API_KEY to your API key.
client = Natural()
sessions = client.voice_sessions.list(status="ended", limit=20)

import Natural from "@naturalpay/sdk";

// Set NATURAL_API_KEY to your API key.
const client = new Natural();
const sessions = await client.voiceSessions.list({ status: "ended", limit: 20 });

natural voice-sessions list --status ended --limit 20

Show my 20 most recent ended voice sessions.

curl "https://api.natural.com/voice/sessions?status=ended&limit=20" \
  -H "Authorization: Bearer $NATURAL_API_KEY"

Session status describes the call, not the payment outcome.

Status	Meaning
`awaitingCall`	Waiting for the caller to connect
`inProgress`	Call is in progress
`ended`	Call end was recorded
`failed`	Session failed
`canceled`	A newer session replaced this one
`expired`	The time limit passed without a recorded call end

The result lives in the block named after the session’s kind. For payment sessions, payment.outcome is paid, linkSent, or unpaid, and payment.failure holds the last decline. completedAt is set once the call has ended and the result is known, when voiceSession.completed fires. New kinds may be added; ignore kinds you don’t handle.

Read one session

Get a voice session to view its call details.

session = client.voice_sessions.get("vos_019d0a1b2c3d4e5f60718293a4b5c6f0")

const session = await client.voiceSessions.get({
  voiceSessionId: "vos_019d0a1b2c3d4e5f60718293a4b5c6f0",
});

natural voice-sessions get --voice-session-id vos_019d0a1b2c3d4e5f60718293a4b5c6f0

Show the details for voice session vos_019d0a1b2c3d4e5f60718293a4b5c6f0.

curl https://api.natural.com/voice/sessions/vos_019d0a1b2c3d4e5f60718293a4b5c6f0 \
  -H "Authorization: Bearer $NATURAL_API_KEY"

The call object includes the start time, end time, duration, and who ended the call. Fields remain null until those details are known. For the payment outcome, follow the paymentIntent relationship. See Follow the payment.

Fetch the transcript

Get the transcript to read the conversation with card details redacted.

transcript = client.voice_sessions.get_transcript(session.data.id)

const transcript = await client.voiceSessions.getTranscript({
  voiceSessionId: session.data.id,
});

natural voice-sessions get-transcript --voice-session-id vos_019d0a1b2c3d4e5f60718293a4b5c6f0

Show the transcript for that voice session.

curl https://api.natural.com/voice/sessions/vos_019d0a1b2c3d4e5f60718293a4b5c6f0/transcript \
  -H "Authorization: Bearer $NATURAL_API_KEY"

If no call started, the response has status notAvailable and no transcript turns.

Overview

Common use cases

Products

Guides

List sessions

Read one session

Fetch the transcript

​List sessions

​Read one session

​Fetch the transcript

List sessions

Read one session

Fetch the transcript