Skip to Content
Tools referenceCalls and voicemail

Calls and voicemail

ToolWhat it does
call_getGet one accessible call and its current artifacts, including what produced it (single call, call session or workflow), its call session, the outcome detail, and the screening card when a screening assistant answered first.
call_logUpdate the editable purpose, outcome and notes on one call. Needs approval in the app. Outcome 11, Asked not to be called, also marks the called contact Do Not Contact for the whole team, replacing their current stage and ending their active sequence enrollments. callback_at logs the outcome Neutral - call back later and moves the call’s open task to that time, or creates a Phone call task for the contact.
call_searchSearch or filter the team’s call history by transcript keyword, phone number, direction, outcome, purpose, AI insight, teammate, recording or voicemail presence, date range, duration, call session, source, or screening.
call_session_getRead one call session: its state, counts, how the unanswered calls ended, and once it has ended the time it saved and how many contacts did not pick up, with the call ids to open through call_get. A live session is only read, never started, paused, skipped or ended. A teammate’s session opens only when the viewer’s permissions allow it.
call_session_listList the team’s call sessions (dialer sessions), newest first: name, mode (One at a time or Several at once), state, who ran it, and called, conversation, voicemail and meeting counts. Filter by teammate, mode and start date. Every row is visible to the team; can_open says whether the viewer may open its details. Read-only.
voicemail_listList or search the team’s voicemails - received, Instant Voicemail drops, and Magic Voicemail drops - with transcripts, by segment, owner, date range, or keyword.

call_get

Get one accessible call and its current artifacts, including what produced it (single call, call session or workflow), its call session, the outcome detail, and the screening card when a screening assistant answered first.

Load one call’s full detail: recording/transcript/AI hydration status (with live ETA while processing), transcript lines, AI summary and insights, the manual log (purpose/outcome/notes), and provenance (which sequence/task/deal produced it, whether it was a single call, a call session dial or a workflow log, and which call session it belongs to). Also the system outcome detail and, when a screening assistant answered first, the screened flag and the screening card (what was asked, the rep’s own reply, how it ended).

EndpointPOST https://api.prospeo.io/api/v2/tools/call-get
MCP toolcall_get on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
call_record_idstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

call_log

Update the editable purpose, outcome and notes on one call. Needs approval in the app. Outcome 11, Asked not to be called, also marks the called contact Do Not Contact for the whole team, replacing their current stage and ending their active sequence enrollments. callback_at logs the outcome Neutral - call back later and moves the call’s open task to that time, or creates a Phone call task for the contact.

Save or update the manual log on one call — purpose, outcome and free-text notes. The detector and screening fields of a call are system-written and cannot be set here. In the app this always raises an Allow/Deny card that states the exact log and any effect beyond it. Two inputs reach beyond the log: outcome_id 11 (Asked not to be called) marks the called contact Do Not Contact for the whole team and replaces their current stage, and callback_at logs “Neutral - call back later” and moves the call’s open task to that time or creates a Phone call task. API-key and MCP callers run without a card, so they should use those two inputs only when the user has asked for exactly that.

EndpointPOST https://api.prospeo.io/api/v2/tools/call-log
MCP toolcall_log on https://mcp.prospeo.io
EffectDeletes or removes data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationRecommended: MCP clients should confirm with the user before calling.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
call_record_idstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
purpose_idintegerNo
outcome_idintegerNo
notesstringNoLength 0 to 10000.
callback_atstringNo

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Search or filter the team’s call history by transcript keyword, phone number, direction, outcome, purpose, AI insight, teammate, recording or voicemail presence, date range, duration, call session, source, or screening.

Search and filter the team’s call history: one free-text input over call transcripts and raw phone numbers, plus direction/outcome/purpose/AI-insight/date-range/duration/recording/voicemail-left/sequence/ source/call-session/screened filters, all AND-combined, 25 per page (highlighted transcript snippet on a text-search hit). Each call also says what produced it, which call session it belongs to, the system outcome detail, and whether a screening assistant answered first. Use whenever the user names any criterion — a keyword, a number, a date range, an outcome, a call session, or screened calls — rather than a plain ‘show me calls’.

EndpointPOST https://api.prospeo.io/api/v2/tools/call-search
MCP toolcall_search on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationPage-based: page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
pageintegerNoPage number, starting at 1. Each page holds 25 calls, newest first, and there is no page-size or sort option: the first call on page 1 is the most recent. From 1 to 100000. Default 1.
searchstringNoFree text over call transcripts and raw phone numbers, up to 300 characters. Length 0 to 300.
directionsarray of string (enum)NoCall directions to include: OUTGOING, INCOMING, MISSED; empty means no direction filter. Up to 3 items. Items one of: OUTGOING, INCOMING, MISSED.
outcome_idsarray of integerNoTeam outcome definition IDs to include, including custom and historical deleted IDs; empty means no outcome filter.
purpose_idsarray of integerNoTeam purpose definition IDs to include, including custom and historical deleted IDs; empty means no purpose filter.
ai_insightsarray of string (enum)NoAI-detected call insights to include; empty means no insight filter. Up to 6 items. Items one of: Engaged, Curious, Neutral, Rushed, Skeptical, Frustrated.
user_oidstringNoRestrict to one teammate’s calls by their user oid. Only has an effect for a caller who can view the whole team’s call history. Pattern ^[0-9a-fA-F]{24}$.
phone_number_idstringNoRestrict to calls made or received on one of the team’s own phone numbers, by its oid. Pattern ^[0-9a-fA-F]{24}$.
my_numbers_onlybooleanNoRestrict to calls on any of the caller’s own phone numbers. Ignored when phone_number_id is set. Default false.
has_recordingbooleanNoTrue for calls with a ready recording, False for calls without one, omitted for both.
voicemail_leftbooleanNoTrue for calls where a voicemail was left (Instant or Magic), False otherwise, omitted for both.
date_fromstringNoOnly include calls at or after this UTC timestamp (ISO 8601).
date_tostringNoOnly include calls at or before this UTC timestamp (ISO 8601).
duration_min_secondsintegerNoOnly include calls at least this many seconds long. From 0 to any.
duration_max_secondsintegerNoOnly include calls at most this many seconds long. From 0 to any.
sequence_oidstringNoRestrict to calls placed from one sequence, by its oid (the sequence-detail Calls tab use). Pattern ^[0-9a-fA-F]{24}$.
step_indexintegerNoRestrict to calls placed from one 0-indexed step of that sequence. Only meaningful together with sequence_oid. From 0 to any.
call_sourcesarray of string (enum)NoWhat produced the call: SINGLE (a rep’s own call), SESSION (a call session dial), WORKFLOW (logged by a workflow); empty means no source filter. Up to 3 items. Items one of: SINGLE, SESSION, WORKFLOW.
session_oidstringNoRestrict to the calls of one call session, by its oid. Pattern ^[0-9a-fA-F]{24}$.
screenedbooleanNoTrue for calls a screening assistant answered first, False for the rest, omitted for both.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

call_session_get

Read one call session: its state, counts, how the unanswered calls ended, and once it has ended the time it saved and how many contacts did not pick up, with the call ids to open through call_get. A live session is only read, never started, paused, skipped or ended. A teammate’s session opens only when the viewer’s permissions allow it.

Read one call session (dialer session): its state, the counts (called, conversations, voicemails, meetings), how the unanswered calls ended, and, once it has ended, the time it saved and how many contacts did not pick up, with the call oids to open through call_get. Read-only: a live session is reported, never started, paused, skipped or ended.

EndpointPOST https://api.prospeo.io/api/v2/tools/call-session-get
MCP toolcall_session_get on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
session_oidstringYesThe call session’s oid, from call_session_list or from a call’s session_oid. Pattern ^[0-9a-fA-F]{24}$.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

call_session_list

List the team’s call sessions (dialer sessions), newest first: name, mode (One at a time or Several at once), state, who ran it, and called, conversation, voicemail and meeting counts. Filter by teammate, mode and start date. Every row is visible to the team; can_open says whether the viewer may open its details. Read-only.

List the team’s call sessions (dialer sessions), newest first: name, mode (One at a time or Several at once), state, who ran it, and called, conversation, voicemail and meeting counts, 25 per page. Every session row is visible to the whole team; each row says whether the viewer is its owner and whether they can open its details.

EndpointPOST https://api.prospeo.io/api/v2/tools/call-session-list
MCP toolcall_session_list on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationPage-based: page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
pageintegerNoPage number, starting at 1, 25 sessions per page, newest first. From 1 to 100000. Default 1.
user_oidsarray of stringNoOnly sessions run by these teammates, by user oid; empty means the whole team. Up to 50 items.
modesarray of string (enum)NoSession modes to include: POWER is One at a time, PARALLEL is Several at once; empty means both. Up to 2 items. Items one of: POWER, PARALLEL.
started_fromstringNoOnly sessions started at or after this UTC timestamp (ISO 8601).
started_tostringNoOnly sessions started at or before this UTC timestamp (ISO 8601).

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

voicemail_list

List or search the team’s voicemails - received, Instant Voicemail drops, and Magic Voicemail drops - with transcripts, by segment, owner, date range, or keyword.

Page through the unified Voicemail tab: received voicemails, Instant-voicemail drops, and Magic Voicemail drops merged into one newest-first feed, optionally scoped to a segment (all/received/dropped) or an owner, and full-text searched over transcripts.

EndpointPOST https://api.prospeo.io/api/v2/tools/voicemail-list
MCP toolvoicemail_list on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationPage-based: page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
pageintegerNoPage number, starting at 1, 25 voicemails per page. From 1 to 100000. Default 1.
segmentstring (enum)NoWhich voicemails to include: ‘all’, ‘received’ (inbound voicemails left for the team), or ‘dropped’ (Instant or Magic Voicemail left by the caller). One of: all, received, dropped. Default "all".
dropped_kindstring (enum)NoNarrow the ‘dropped’ segment to Instant or Magic Voicemail drops only. Ignored unless segment is ‘dropped’. One of: instant, magic.
user_oidstringNoRestrict to one teammate’s voicemails by their user oid. Only has an effect for a caller who can view the whole team’s call history; otherwise the list is already scoped to the caller’s own. Pattern ^[0-9a-fA-F]{24}$.
querystringNoFree-text search over voicemail transcripts, up to 300 characters. Instant drops have no transcript and are excluded while a query is set. Length 0 to 300.
date_fromstringNoOnly include voicemails at or after this UTC timestamp (ISO 8601).
date_tostringNoOnly include voicemails at or before this UTC timestamp (ISO 8601).

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Last updated on