SkipCalls Public API

Sections

Theme switcher

Get call details

Header Parameters

Authorizationstring

Path Parameters

idstring Required

Call ID

Response

200
Object

Response Attributes

idstring Required
userIdstring Required
phoneNumberstring Required

Phone number to call

sourcestring Required

How the outbound call was created

Enum values:
LEGACY_UNKNOWNMANUAL_SCHEDULINGCHATPOST_CALL_ACTIONCONTACT_ACTIONINTEGRATIONCAMPAIGNUSER_COPYSMART_RETRYRECURRING
... 2 other enums
callFromstring

Call from #

goalstring Required

Call goal

goalStatusstring Required

Goal achievement status

Default value
UNKNOWN
Enum values:
UNKNOWNSUCCESSFAILED
scheduledAtstring Required

Call scheduled at

titlestring Required

Call title

statusstring Required

Call status

Enum values:
QUEUEDIN_PROGRESSAWAITING_CONNECTIONSUCCESSFAILEDNOT_STARTEDCANCELLEDCALL_TRANSFERRED
additionalContextstring

Additional context

minutesUsednumber

Minutes used

transactionsarray

Transactions related to the call

Show child attributes

voicestring

Voice used for the call

retryAfterMinutesnumber

Retry after minutes

maxDurationMinutesnumber

Max duration of the call in minutes

doWeNeedToRetryboolean

Do we need to retry the call

recordingUrlstring

Recording URL

userRatingboolean

User rating, where true is good and false is bad. null is no rating.

reviewedAtstring

Reviewed at

finalSummarystring

Final summary

shortFinalSummarystring

Short final summary

placeWhereToCallstring

Place where to call

roleplayTranscriptarray

Roleplay transcript

Show child attributes

agentallof

Agent

Show child attributes

voicemailsarray

Voice mail messages

Show child attributes

callTransferNumberstring

Call transfer number

isCallTransferredboolean

Whether the call is transferred

Default value
false
allowCallTransferboolean

Whether the call transfer is allowed

Default value
false
dataCollectionsarray

Data collections

Show child attributes

evaluationsarray

Evaluations

Show child attributes

analysisallof

Analysis

Show child attributes

followUpsarray

Follow-ups

Show child attributes

tasksarray

Tasks

Show child attributes

taskResultsarray

Per-call results of the agent goals (Call Handling): what it asked/did and the outcome

Show child attributes

voiceSpeednumber

Voice speed

callTypingSoundboolean

Typing sound

Default value
true
callBackgroundSoundboolean

Background sound

Default value
true
recommendedNextActionstring

Recommended next action (AI generated)

testCallboolean

Test call

Default value
false
isFavoriteboolean

Is this call favorited by the user

Default value
false
callInterceptedByUserboolean

Whether the call was intercepted by the user

Default value
false
shareHashstring

Share hash for public sharing

matchedFieldsarray

Fields that matched the search query (only present in search results)

Show child attributes

notesstring

User manual notes about this call (max 400 chars)

Max length
400
contactIdstring

Linked contact ID

404
Object

Call not found

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot