RPC actions

​

Source of truth

• OpenAPI schema: https://api.sippet.ai/api/open_api

​

Common request props

• headers?: Record<string, string>
• fetchOptions?: RequestInit
• customFetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

page?: { limit?: number; offset?: number; count?: boolean }
     | { limit?: number; after?: string; before?: string }

​

Public actions

​

Input objects

• token: string
• fullName?: string
• password?: string
• passwordConfirmation?: string

• sipUserId: UUID
• status?: "available" | "on_break" | "logged_out"
• source?: "widget" | "api" | "system" | null

• channel?: "chat" | "call"
• mode?: "text" | "voice"
• metadata?: Record<string, any> | null
• aiAgentId?: UUID | null

• status?: "active" | "ended"
• mode?: "text" | "voice"
• metadata?: Record<string, any> | null
• aiAgentId?: UUID | null

• operatorName: string

• id: UUID

• direction: "inbound" | "outbound"
• fromNumber: string
• toNumber: string
• sipUsername?: string | null
• callUuid: string
• callSource?: string
• status?: "initiated" | "ringing" | "answered" | "completed" | "failed" | "busy" | "no_answer" | null
• conversationId?: UUID | null
• startedAt?: UtcDateTimeUsec | null

• callUuid: string

• callUuid: string

• callUuid: string

• callUuid: string

• callUuid: string
• reason?: string

• callUuid: string

• contactId: UUID
• aiAgentId: UUID

• publicId: string

• fullName: string
• email?: string | null
• phoneE164?: string | null
• notes?: string | null

• fullName?: string
• email?: string | null
• phoneE164?: string | null
• notes?: string | null

• email: string
• password: string

• token: string

• token

​

Selectable fields (fields)

• id, name, provider, username, realm, proxy, register, fromDomain, fromUser, inboundAcl, password

• id, sipUserId, agentName, status, source, changedByUserId

• id, status, channel, mode, publicId, metadata, aiAgentId

• id, callUuid, queueName, callerIdNumber, callerIdName, state, agentName, waitStartedAt, answeredAt, completedAt, abandonedAt

• id, memberUuid, role, joinedAt, leftAt, callId, organisationId

• id, queueName, strategy, mohSound, maxWaitTime

• id, content, speaker, itemId, contentIndex, occurredAt, callId

• id, direction, fromNumber, toNumber, sipUsername, status, callUuid, callSource, startedAt, endedAt, durationSeconds, conversationId

• id, role, modality, content, metadata, itemId, contentIndex, occurredAt, conversationId

• id, phoneE164, label

• id, fullName, email, phoneE164, notes

• id, fullName, email, sipUsername

• id, eventType, toolName, toolCallId, toolArgumentsRaw, toolArguments, toolOutput, error, success, stateId, stateLabel, stepIndex, totalSteps, progressPercent, tokenUsage, inputTokens, outputTokens, totalTokens, inputTextTokens, inputAudioTokens, inputImageTokens, inputCachedTokens, inputCachedTextTokens, inputCachedAudioTokens, inputCachedImageTokens, outputTextTokens, outputAudioTokens, outputImageTokens, model, payload, callUuid, roomId, agentId, occurredAt, callId, organisationId

• id, sipUserId, agentName, status, source, changedByUserId

• id, name, voice, tone, languages, workflow, systemPrompt, safetyGuardrails, published

​

Related guides

• Quickstart: /quickstart
• Getting started (classic): /guides/getting-started-classic
• Realtime patterns: /guides/realtime-telephony-patterns