Create a new real call session

curl --request POST \
  --url https://api.wejam.ai/api/v1/real-call-sessions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "meetingName": "<string>",
  "transcript": "<string>",
  "email": "jsmith@example.com",
  "missionId": "<string>",
  "scorecardId": "<string>",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.wejam.ai/api/v1/real-call-sessions"

payload = {
    "meetingName": "<string>",
    "transcript": "<string>",
    "email": "jsmith@example.com",
    "missionId": "<string>",
    "scorecardId": "<string>",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    meetingName: '<string>',
    transcript: '<string>',
    email: 'jsmith@example.com',
    missionId: '<string>',
    scorecardId: '<string>',
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.wejam.ai/api/v1/real-call-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wejam.ai/api/v1/real-call-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'meetingName' => '<string>',
    'transcript' => '<string>',
    'email' => 'jsmith@example.com',
    'missionId' => '<string>',
    'scorecardId' => '<string>',
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wejam.ai/api/v1/real-call-sessions"

	payload := strings.NewReader("{\n  \"meetingName\": \"<string>\",\n  \"transcript\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"missionId\": \"<string>\",\n  \"scorecardId\": \"<string>\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wejam.ai/api/v1/real-call-sessions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meetingName\": \"<string>\",\n  \"transcript\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"missionId\": \"<string>\",\n  \"scorecardId\": \"<string>\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wejam.ai/api/v1/real-call-sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meetingName\": \"<string>\",\n  \"transcript\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"missionId\": \"<string>\",\n  \"scorecardId\": \"<string>\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "analysis": {
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "items": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "lastUpdatedAt": "2023-11-07T05:31:56Z",
        "score": 123,
        "behaviours": [],
        "conversationItemReferenceId": "<string>",
        "explanation": "<string>",
        "name": "<string>",
        "suggestion": "<string>"
      }
    ],
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "score": 123
  },
  "call": {
    "assistantReferenceId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "endedReason": "<string>",
    "providerCallId": "<string>",
    "summary": "<string>",
    "transcript": "<string>"
  },
  "completed": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "kpis": {
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "listenRatio": 123,
    "longestMonologue": 123,
    "talkSpeed": 123
  },
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "type": "REAL_CALL",
  "userId": "<string>",
  "missionReferenceId": "<string>",
  "missionTitle": "<string>",
  "participantUserIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "scorecardReferenceId": "<string>",
  "scorecardTitle": "<string>",
  "trackId": "<string>",
  "trackTitle": "<string>"
}

Call Reviewer

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

real-call-sessions

Create a new real call session

curl --request POST \
  --url https://api.wejam.ai/api/v1/real-call-sessions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "meetingName": "<string>",
  "transcript": "<string>",
  "email": "jsmith@example.com",
  "missionId": "<string>",
  "scorecardId": "<string>",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.wejam.ai/api/v1/real-call-sessions"

payload = {
    "meetingName": "<string>",
    "transcript": "<string>",
    "email": "jsmith@example.com",
    "missionId": "<string>",
    "scorecardId": "<string>",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    meetingName: '<string>',
    transcript: '<string>',
    email: 'jsmith@example.com',
    missionId: '<string>',
    scorecardId: '<string>',
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.wejam.ai/api/v1/real-call-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wejam.ai/api/v1/real-call-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'meetingName' => '<string>',
    'transcript' => '<string>',
    'email' => 'jsmith@example.com',
    'missionId' => '<string>',
    'scorecardId' => '<string>',
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wejam.ai/api/v1/real-call-sessions"

	payload := strings.NewReader("{\n  \"meetingName\": \"<string>\",\n  \"transcript\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"missionId\": \"<string>\",\n  \"scorecardId\": \"<string>\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wejam.ai/api/v1/real-call-sessions")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meetingName\": \"<string>\",\n  \"transcript\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"missionId\": \"<string>\",\n  \"scorecardId\": \"<string>\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wejam.ai/api/v1/real-call-sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meetingName\": \"<string>\",\n  \"transcript\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"missionId\": \"<string>\",\n  \"scorecardId\": \"<string>\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "analysis": {
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "items": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "lastUpdatedAt": "2023-11-07T05:31:56Z",
        "score": 123,
        "behaviours": [],
        "conversationItemReferenceId": "<string>",
        "explanation": "<string>",
        "name": "<string>",
        "suggestion": "<string>"
      }
    ],
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "score": 123
  },
  "call": {
    "assistantReferenceId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "endedReason": "<string>",
    "providerCallId": "<string>",
    "summary": "<string>",
    "transcript": "<string>"
  },
  "completed": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "kpis": {
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "listenRatio": 123,
    "longestMonologue": 123,
    "talkSpeed": 123
  },
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "type": "REAL_CALL",
  "userId": "<string>",
  "missionReferenceId": "<string>",
  "missionTitle": "<string>",
  "participantUserIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "scorecardReferenceId": "<string>",
  "scorecardTitle": "<string>",
  "trackId": "<string>",
  "trackTitle": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

meetingName

string

required

The name of the meeting.

Minimum string length: 1

transcript

string

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.

Required string length: 10 - 100000

string<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.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

missionId

string

The mission ID to be used for the scorecard.

Pattern: ^[0-9a-f]{24}$

scorecardId

string

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

Pattern: ^[0-9a-f]{24}$

userId

string<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.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

analysis

object

required

Show child attributes

call

object

required

Show child attributes

completed

boolean

required

createdAt

string<date-time>

required

string

required

kpis

object

required

Show child attributes

language

enum<string>

required

Available options:

en,

de,

fr,

es,

it,

nl,

zh-Hans

lastUpdatedAt

string<date-time>

required

state

enum<string>

required

Available options:

PENDING,

PROCESSING,

DONE

type

enum<string>

required

Available options:

REAL_CALL

userId

string

required

missionReferenceId

string | null

Reference ID for the associated mission

missionTitle

string | null

participantUserIds

string<uuid>[]

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.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

playedLanguage

enum<string> | null

Available options:

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

scorecardReferenceId

string | null

Reference ID for the associated scorecard

scorecardTitle

string | null

Title of the associated scorecard

trackId

string | null

Parent track id for mission-backed roleplay sessions

trackTitle

string | null