SkipCalls Public API

Sections

Theme switcher

Schedule a new call

Header Parameters

Authorizationstring

Body Parameters

phoneNumberstring Required

Phone number to call

goalstring Required

Goal of the call

scheduledAtstring

ISO 8601 date-time for scheduling the call

timezonestring

Timezone for scheduling the call (e.g. America/Los_Angeles)

Default value
America/Los_Angeles
additionalContextstring

Additional context for the call

maxDurationMinutesnumber

Maximum duration of the call in minutes

Minimum
1
Default value
15
doWeNeedToRetryboolean

Do we need to retry the call

Default value
false
voicestring

Voice to use for the call

retryAfterMinutesnumber

Number of minutes to wait before retrying if call fails

Minimum
1
Maximum
30
Default value
5
forceboolean

Force call creation without clarification

Default value
false
askForClarificationboolean

Allow to ask for clarification (if user is online)

Default value
false
includePrivateDataboolean

Include private data in the call prompt

Default value
false
agentIdstring

Agent ID to use for the call

allowCallTransferboolean

Allow to transfer the call to another number

Default value
false
callTransferNumberstring

Number to transfer the call to

titlestring

Title of the call (for campaign)

firstMessagestring

First message to use for the call (for campaign)

cronSchedulestring

Cron expression for recurring calls (e.g., "0 9 * * MON" for every Monday at 9 AM)

Response

201
Object

Call scheduled successfully

Response Attributes

successboolean Required

Success

callallof

Call

Show child attributes

400
Object

Invalid input data, needs clarification, insufficient credits, or call request denied

Response Attributes

successboolean Required
reasonstring Required
Enum values:
successneeds_clarificationdeniedsystem_errorinsufficient_creditsnormal_error
errorMessagestring
needsClarificationboolean
clarificationQuestionstring
originalGoalstring
isAllowedboolean
moderationReasonstring
moderationSuggestedActionstring
Was this section helpful?

POST

/

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