The object is everything inside data. The field names below are relative to it: attributes.kind is data.attributes.kind in the response.
Fields
string
required
Voice session ID (vos_*).
string
required
Resource type. Always voiceSession.
object
required
kind is the session’s purpose and names the block that holds its result. New kinds may be added; ignore kinds you don’t handle.
Hide attributes
string
required
Collects payment for a payment intent.
string
required
Call lifecycle, independent of payment outcome. ended requires a recorded call end. expired means the dial window or call time limit passed without a recorded end. One of: awaitingCall, inProgress, ended, canceled, expired. See Statuses.
string | null
required
Reference supplied when the session was created, or null.
string | null
required
Supplied caller phone number, or null for a session without one.
string | null
required
Dial destination while the session accepts a call and you have permission to create payment voice sessions. Otherwise null. Treat it as opaque: store it from the create response and never build it from the session ID.
string
required
RFC 3339 deadline for starting the session’s one permitted call.
string | null
required
Requested return destination, or null. This does not confirm the destination answered.
object
required
The session’s call, as reported.
Hide call
string | null
required
Reported call start time in RFC 3339, or null when unavailable.
string | null
required
Time the call was recorded as ended in RFC 3339, or null.
integer | null
required
Reported call duration in seconds, or null.
string | null
required
Reported party ending the call. Null before an end is recorded. One of: caller, assistant, unknown.
string | null
required
Redacted call summary, or null.
string | null
required
Time a return transfer was requested in RFC 3339, or null. This does not confirm the return leg connected.
string | null
required
RFC 3339 time the session closed, or null. Set once the call has ended and its result is known, or the session expired or was canceled. voiceSession.completed fires once then.
string
required
RFC 3339 time the session was created.
string
required
RFC 3339 time the stored session last changed.
object
required
The result of a payment session.
Hide payment
string | null
required
paid when the card was charged on the call. linkSent when voice payment did not succeed and the caller was texted the payment link. unpaid otherwise. Null until the result is known, which can be while the call is still in progress. A later link payment does not change it. New values may be added. One of: paid, linkSent, unpaid.
string | null
required
RFC 3339 time the payment link was texted to the caller, or null.
integer
required
Card payments that failed during this session.
object | null
required
The last failed card payment in this session, or null.
Hide failure
string | null
required
Failure code, when known. New codes may be added.
string | null
required
Explanation of the failure.
string | null
required
Recommended payer action, when known. One of: doNotRetry, tryAgainLater, confirmCardData.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Associated payment intent. Set on payment sessions.
Hide paymentIntent
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always paymentIntent.
string
required
Payment intent ID (pmi_*).
object
required
Associated Natural customer, or null when none is associated.
Hide customerParty
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Customer party ID (pty_*).
object
required
The party that created the session: the platform calling for the customer, or the customer itself.
Hide initiatingParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
ID of the party that created the session (pty_*).
Statuses
Status
Meaning
Can become
awaitingCall
The session can be dialed until dialExpiresAt.
inProgress, canceled, expired
inProgress
The call started and no call end is recorded.
ended, expired
ended
The provider reported the call end, regardless of the payment outcome.
Final
canceled
A newer session for the same payment intent replaced it, or its payment intent was canceled.
Final
expired
The dial window or the call time limit passed without a recorded end. A call end reported before the session closes, about 5 minutes after the limit, still makes it ended; after that it stays expired.
ended
Permissions
Create needs both voiceSessions.create and paymentIntents.create, Voice enabled on your account, and an active Accept application for the business you collect for. List, get and the transcript need voiceSessions.read.
Events
voiceSession.completed: A voice session closed as ended, expired, or canceled. Sent once per session. canceled and expired can arrive a few minutes late. A paid call whose call end never arrived closes as expired with payment.outcomepaid. It does not mean paid. Read payment.outcome: paid, linkSent when voice payment did not succeed and the caller was texted the payment link, or unpaid. The payment intent is the source of truth for money, and delivery order is not guaranteed.