latestOpenAPI 3.0.02026-08-19219210532.7 KB

bd5a5f406bca

real-call-session

Create a new real call session

Attributes the session to exactly one of userId or email. A known email resolves to the existing user. When the email does not match an existing user in the caller's organization, a Member user is automatically provisioned (the account requires setting a password on first login) ONLY when the organization has enabled "Automatically create new users from real-call transcripts" in its settings and the email's domain matches one of the organization's configured email domains; otherwise the upload is rejected with 422 and neither a user nor a session is created.

Speaker-labeled SRT: a standard SRT transcript may carry a label: message prefix on the first content line of each cue. A label that normalizes (trim + lowercase) to a valid email whose domain matches the organization's configured domains (or any email when no domains are configured) marks the speaker as internal (sales side); a non-matching email marks an external client whose turns are never attributed and never provisioned. Internal speakers are attributed to the matching Jam user (auto-provisioned under the same organization opt-in as the email parameter when unknown; turns stay unattributed when provisioning is disabled or impossible) and recorded as session participants. A non-email label (e.g. Client:) is stripped from the content without attribution, but only when its colon is followed by whitespace or ends the line (prose colons such as 10:30 or URLs are left intact).

Rep scoring: the userId/email parameter designates the scored rep. Scoring, KPIs and dashboards attribute exclusively to the rep; other labeled speakers are recorded as participants only (see participantUserIds on the session).

post/api/v1/real-call-sessions

Request body

emailstring email

The learner email associated with the transcript. Designates the scored rep (see userId). When no user with this email exists in the organization, a Member user is automatically provisioned and the session is attributed to them.

meetingNamestring required

The name of the meeting.

missionIdstring

The mission ID to be used for the scorecard.

scorecardIdstring

The scorecard ID to use for analysis. When omitted, the system will automatically classify the transcript and select the most appropriate scorecard.

transcriptstring required

The transcript text to upload. Supports plain text, SRT, and speaker-labeled SRT where the first content line of a cue carries a "label: message" prefix: email labels attribute the turn to that Jam user and record them as a session participant; non-email labels (e.g. "Client:") are stripped without attribution. The transcript is rejected with 422 when it is speaker-labeled but the attributed rep (userId/email) never speaks in it.

userIdstring uuid

The learner user ID associated with the transcript. Designates the scored rep: scoring, KPIs and dashboards attribute exclusively to this user; other labeled speakers become participants only.

Response

completedboolean required
createdAtstring date-time required
idstring required
language'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans' required
lastUpdatedAtstring date-time required
missionReferenceIdstring nullable

Reference ID for the associated mission

missionTitlestring nullable
participantUserIdsstring[]

User IDs of all attributed speakers in the call, including the scored rep. Not yet resolved at creation time — read it from the session GET once transcript processing has finished.

playedLanguage'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'pl' | 'zh' | 'ja' | 'id' | 'tr' | 'pt' | 'el' | 'ko' | 'vi' | 'hi' | 'ms' | 'th' | 'hr' | 'ro' | 'bg' | 'sv' | 'no' | 'yue' | 'null' nullable
scorecardReferenceIdstring nullable

Reference ID for the associated scorecard

scorecardTitlestring nullable

Title of the associated scorecard

state'PENDING' | 'PROCESSING' | 'DONE' required
trackIdstring nullable

Parent track id for mission-backed roleplay sessions

trackTitlestring nullable
type'REAL_CALL' required
userIdstring required