dist¶

Interfaces¶

DrachtioSrfSipGateway¶

Extends¶

SipStackGateway

Properties¶

rawClient¶

readonly rawClient: {
  dialogs: Map<string, Dialog>;
  sdkPackage: "drachtio-srf";
  srf: Srf;
};

dialogs¶

dialogs: Map<string, Dialog>;

sdkPackage¶

sdkPackage: "drachtio-srf";

srf¶

srf: Srf;

Methods¶

answerCall()?¶

optional answerCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipAnswerCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.answerCall

checkReadiness()?¶

optional checkReadiness(context):
  | SipReadinessResult
| Promise<SipReadinessResult>;

Parameters¶

Parameter	Type
`context`	`SipStackReadinessContext`

Returns¶

| SipReadinessResult | Promise\<SipReadinessResult>

Inherited from¶

SipStackGateway.checkReadiness

createOutboundCall()?¶

optional createOutboundCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipOutboundCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.createOutboundCall

hangupCall()?¶

optional hangupCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipHangupCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.hangupCall

rejectCall()?¶

optional rejectCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRejectCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.rejectCall

sendDtmf()?¶

optional sendDtmf(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipDtmfInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.sendDtmf

startRecording()?¶

optional startRecording(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRecordingControlInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.startRecording

stopRecording()?¶

optional stopRecording(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRecordingControlInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.stopRecording

transferCall()?¶

optional transferCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipTransferCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.transferCall

updateMediaSession()?¶

optional updateMediaSession(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipMediaSessionUpdateInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

Inherited from¶

SipStackGateway.updateMediaSession

DrachtioSrfSipStackGatewayOptions¶

Properties¶

connect?¶

optional connect?: any;

dialogs?¶

optional dialogs?: Map<string, Dialog>;

srf?¶

optional srf?: any;

ParseSipVoiceWebhookOperationInput¶

Properties¶

options?¶

optional options?: ParseSipVoiceWebhookOptions;

request¶

request: Request;

ParseSipVoiceWebhookOptions¶

Properties¶

hmacSecret?¶

optional hmacSecret?: string;

requireSharedSecret?¶

optional requireSharedSecret?: boolean;

requireSignature?¶

optional requireSignature?: boolean;

sharedSecret?¶

optional sharedSecret?: string;

sharedSecretHeader?¶

optional sharedSecretHeader?: string;

signatureAlgorithm?¶

optional signatureAlgorithm?: "sha256" | "sha1" | "sha512";

signatureHeader?¶

optional signatureHeader?: string;

timestampHeader?¶

optional timestampHeader?: string;

SipAddress¶

Properties¶

displayName?¶

optional displayName?: string;

uri¶

uri: string;

SipAnswerCallInput¶

Extends¶

SipCallReference.SipCallControlHeaders

Properties¶

answer?¶

optional answer?: SipSessionDescription;

callId¶

callId: string;

Inherited from¶

SipCallReference.callId

dialogId?¶

optional dialogId?: string;

Inherited from¶

SipCallReference.dialogId

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipCallReference.providerCallId

SipCallControlHeaders¶

Properties¶

headers?¶

optional headers?: Record<string, string>;

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

SipCallControlResult¶

Properties¶

callId¶

callId: string;

dialogId?¶

optional dialogId?: string;

headers?¶

optional headers?: Record<string, string>;

localDescription?¶

optional localDescription?: SipSessionDescription;

providerCallId?¶

optional providerCallId?: string;

raw?¶

optional raw?: unknown;

remoteDescription?¶

optional remoteDescription?: SipSessionDescription;

state?¶

optional state?: SipCallState;

SipCallReference¶

Extended by¶

SipAnswerCallInput
SipDtmfInput
SipHangupCallInput
SipMediaSessionUpdateInput
SipRecordingControlInput
SipRejectCallInput
SipTransferCallInput

Properties¶

callId¶

callId: string;

dialogId?¶

optional dialogId?: string;

providerCallId?¶

optional providerCallId?: string;

SipCallStatusWebhookEvent¶

Extends¶

Omit\<SipWebhookBaseEvent, "type">

Properties¶

callId?¶

optional callId?: string;

Inherited from¶

SipWebhookBaseEvent.callId

direction?¶

optional direction?: SipCallDirection;

from?¶

optional from?: string;

occurredAt?¶

optional occurredAt?: string;

Inherited from¶

SipWebhookBaseEvent.occurredAt

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipWebhookBaseEvent.providerCallId

raw¶

raw: SipVoiceProviderResponse;

Inherited from¶

SipWebhookBaseEvent.raw

reason?¶

optional reason?: string;

sdp?¶

optional sdp?: string;

status¶

status: SipCallState;

to?¶

optional to?: string;

type¶

type: "call.status";

SipCallTransferWebhookEvent¶

Extends¶

Omit\<SipWebhookBaseEvent, "type">

Properties¶

callId?¶

optional callId?: string;

Inherited from¶

SipWebhookBaseEvent.callId

occurredAt?¶

optional occurredAt?: string;

Inherited from¶

SipWebhookBaseEvent.occurredAt

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipWebhookBaseEvent.providerCallId

raw¶

raw: SipVoiceProviderResponse;

Inherited from¶

SipWebhookBaseEvent.raw

reason?¶

optional reason?: string;

target?¶

optional target?: string;

transferStatus¶

transferStatus: SipTransferStatus;

type¶

type: "call.transfer";

SipCredentialStatusInput¶

Properties¶

authPassword?¶

optional authPassword?: string;

authUsername?¶

optional authUsername?: string;

domain?¶

optional domain?: string;

mediaEncryption?¶

optional mediaEncryption?: SipMediaEncryption;

outboundProxyUri?¶

optional outboundProxyUri?: string;

proxyUri?¶

optional proxyUri?: string;

registrarUri?¶

optional registrarUri?: string;

srtpEnabled?¶

optional srtpEnabled?: boolean;

tlsEnabled?¶

optional tlsEnabled?: boolean;

webhookCallbackUrl?¶

optional webhookCallbackUrl?: string;

webhookHmacSecret?¶

optional webhookHmacSecret?: string;

webhookSharedSecret?¶

optional webhookSharedSecret?: string;

SipDtmfInput¶

Extends¶

SipCallReference.SipCallControlHeaders

Properties¶

callId¶

callId: string;

Inherited from¶

SipCallReference.callId

dialogId?¶

optional dialogId?: string;

Inherited from¶

SipCallReference.dialogId

digits¶

digits: string;

durationMs?¶

optional durationMs?: number;

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipCallReference.providerCallId

SipHangupCallInput¶

Extends¶

SipCallReference.SipCallControlHeaders

Properties¶

callId¶

callId: string;

Inherited from¶

SipCallReference.callId

dialogId?¶

optional dialogId?: string;

Inherited from¶

SipCallReference.dialogId

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipCallReference.providerCallId

reason?¶

optional reason?: string;

SipLiveCheckOptions¶

Properties¶

config¶

config: SipVoiceConfig;

gateway?¶

optional gateway?: Pick<SipStackGateway, "checkReadiness">;

SipMediaSessionUpdateInput¶

Extends¶

SipCallReference.SipCallControlHeaders

Properties¶

answer?¶

optional answer?: SipSessionDescription;

callId¶

callId: string;

Inherited from¶

SipCallReference.callId

dialogId?¶

optional dialogId?: string;

Inherited from¶

SipCallReference.dialogId

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

offer?¶

optional offer?: SipSessionDescription;

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipCallReference.providerCallId

reason?¶

optional reason?: "resume" | "hold" | "renegotiate";

SipOutboundCallInput¶

Extends¶

SipCallControlHeaders

Properties¶

callbackUrl?¶

optional callbackUrl?: string;

from¶

from: string | SipAddress;

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

mediaEncryption?¶

optional mediaEncryption?: SipMediaEncryption;

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

offer?¶

optional offer?: SipSessionDescription;

to¶

to: string | SipAddress;

transport?¶

optional transport?: SipTransport;

SipReadinessResult¶

Properties¶

details?¶

optional details?: SipVoiceJsonObject;

missing?¶

optional missing?: string[];

ok¶

ok: boolean;

proxyReachable?¶

optional proxyReachable?: boolean;

registered?¶

optional registered?: boolean;

registrarReachable?¶

optional registrarReachable?: boolean;

srtpReady?¶

optional srtpReady?: boolean;

tlsReady?¶

optional tlsReady?: boolean;

webhookReachable?¶

optional webhookReachable?: boolean;

SipRecordingControlInput¶

Extends¶

SipCallReference.SipCallControlHeaders

Properties¶

callId¶

callId: string;

Inherited from¶

SipCallReference.callId

dialogId?¶

optional dialogId?: string;

Inherited from¶

SipCallReference.dialogId

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipCallReference.providerCallId

recordingId?¶

optional recordingId?: string;

SipRecordingWebhookEvent¶

Extends¶

Omit\<SipWebhookBaseEvent, "type">

Properties¶

callId?¶

optional callId?: string;

Inherited from¶

SipWebhookBaseEvent.callId

durationSeconds?¶

optional durationSeconds?: number;

occurredAt?¶

optional occurredAt?: string;

Inherited from¶

SipWebhookBaseEvent.occurredAt

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipWebhookBaseEvent.providerCallId

raw¶

raw: SipVoiceProviderResponse;

Inherited from¶

SipWebhookBaseEvent.raw

recordingId?¶

optional recordingId?: string;

recordingStatus¶

recordingStatus: SipRecordingStatus;

recordingUrl?¶

optional recordingUrl?: string;

type¶

type: "recording";

SipRejectCallInput¶

Extends¶

SipCallReference.SipCallControlHeaders

Properties¶

callId¶

callId: string;

Inherited from¶

SipCallReference.callId

dialogId?¶

optional dialogId?: string;

Inherited from¶

SipCallReference.dialogId

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipCallReference.providerCallId

reason?¶

optional reason?: string;

statusCode?¶

optional statusCode?: number;

SipSessionDescription¶

Properties¶

contentType?¶

optional contentType?: "application/sdp";

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

sdp¶

sdp: string;

type¶

type: "answer" | "offer";

SipStackGateway¶

Extended by¶

DrachtioSrfSipGateway

Methods¶

answerCall()?¶

optional answerCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipAnswerCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

checkReadiness()?¶

optional checkReadiness(context):
  | SipReadinessResult
| Promise<SipReadinessResult>;

Parameters¶

Parameter	Type
`context`	`SipStackReadinessContext`

Returns¶

| SipReadinessResult | Promise\<SipReadinessResult>

createOutboundCall()?¶

optional createOutboundCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipOutboundCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

hangupCall()?¶

optional hangupCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipHangupCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

rejectCall()?¶

optional rejectCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRejectCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

sendDtmf()?¶

optional sendDtmf(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipDtmfInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

startRecording()?¶

optional startRecording(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRecordingControlInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

stopRecording()?¶

optional stopRecording(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRecordingControlInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

transferCall()?¶

optional transferCall(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipTransferCallInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

updateMediaSession()?¶

optional updateMediaSession(input, context):
  | SipCallControlResult
| Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipMediaSessionUpdateInput`
`context`	{ `config`: `SipVoiceConfig`; `signal?`: `AbortSignal`; }
`context.config`	`SipVoiceConfig`
`context.signal?`	`AbortSignal`

Returns¶

| SipCallControlResult | Promise\<SipCallControlResult>

SipStackReadinessContext¶

Properties¶

config¶

config: SipVoiceConfig;

signal?¶

optional signal?: AbortSignal;

SipTranscriptionWebhookEvent¶

Extends¶

Omit\<SipWebhookBaseEvent, "type">

Properties¶

callId?¶

optional callId?: string;

Inherited from¶

SipWebhookBaseEvent.callId

confidence?¶

optional confidence?: number;

isFinal?¶

optional isFinal?: boolean;

occurredAt?¶

optional occurredAt?: string;

Inherited from¶

SipWebhookBaseEvent.occurredAt

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipWebhookBaseEvent.providerCallId

raw¶

raw: SipVoiceProviderResponse;

Inherited from¶

SipWebhookBaseEvent.raw

speaker?¶

optional speaker?: "unknown" | "customer" | "agent" | "assistant";

text?¶

optional text?: string;

transcriptionId?¶

optional transcriptionId?: string;

transcriptionStatus¶

transcriptionStatus: SipTranscriptionStatus;

type¶

type: "transcription";

SipTransferCallInput¶

Extends¶

SipCallReference.SipCallControlHeaders

Properties¶

callId¶

callId: string;

Inherited from¶

SipCallReference.callId

dialogId?¶

optional dialogId?: string;

Inherited from¶

SipCallReference.dialogId

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

SipCallControlHeaders.headers

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

Inherited from¶

SipCallControlHeaders.metadata

mode?¶

optional mode?: "blind" | "attended";

providerCallId?¶

optional providerCallId?: string;

Inherited from¶

SipCallReference.providerCallId

replacesCallId?¶

optional replacesCallId?: string;

target¶

target: string | SipAddress;

SipVoiceClient¶

Methods¶

answerCall()¶

answerCall(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipAnswerCallInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

checkReadiness()¶

checkReadiness(context?): Promise<SipReadinessResult>;

Parameters¶

Parameter	Type
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipReadinessResult>

createOutboundCall()¶

createOutboundCall(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipOutboundCallInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

hangupCall()¶

hangupCall(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipHangupCallInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

rejectCall()¶

rejectCall(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRejectCallInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

sendDtmf()¶

sendDtmf(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipDtmfInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

startRecording()¶

startRecording(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRecordingControlInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

stopRecording()¶

stopRecording(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipRecordingControlInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

transferCall()¶

transferCall(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipTransferCallInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

updateMediaSession()¶

updateMediaSession(input, context?): Promise<SipCallControlResult>;

Parameters¶

Parameter	Type
`input`	`SipMediaSessionUpdateInput`
`context?`	{ `signal?`: `AbortSignal`; }
`context.signal?`	`AbortSignal`

Returns¶

Promise\<SipCallControlResult>

SipVoiceClientOptions¶

Properties¶

config¶

config: SipVoiceConfig;

gateway?¶

optional gateway?: SipStackGateway;

SipVoiceConfig¶

Properties¶

authPassword¶

authPassword: string;

authUsername¶

authUsername: string;

domain¶

domain: string;

localAddressOfRecord?¶

optional localAddressOfRecord?: string;

mediaEncryption?¶

optional mediaEncryption?: SipMediaEncryption;

metadata?¶

optional metadata?: SipVoiceProviderExtensionFields;

outboundProxyUri?¶

optional outboundProxyUri?: string;

proxyUri?¶

optional proxyUri?: string;

registrarUri¶

registrarUri: string;

srtpEnabled?¶

optional srtpEnabled?: boolean;

tlsEnabled?¶

optional tlsEnabled?: boolean;

transport?¶

optional transport?: SipTransport;

userAgent?¶

optional userAgent?: string;

webhookCallbackUrl?¶

optional webhookCallbackUrl?: string;

webhookHmacSecret?¶

optional webhookHmacSecret?: string;

webhookSharedSecret?¶

optional webhookSharedSecret?: string;

SipVoiceIntegrationOptions¶

Properties¶

config¶

config: SipVoiceConfig;

gateway¶

gateway: SipStackGateway;

SipVoiceJsonObject¶

Extended by¶

SipVoiceProviderExtensionFields
SipVoiceProviderResponse

Indexable¶

[key: string]: SipVoiceProviderExtensionValue

SipVoiceProviderExtensionFields¶

Extends¶

SipVoiceJsonObject

Indexable¶

[key: string]: SipVoiceProviderExtensionValue

SipVoiceProviderResponse¶

Extends¶

SipVoiceJsonObject

Indexable¶

[key: string]: SipVoiceProviderExtensionValue

SipWebhookBaseEvent¶

Properties¶

callId?¶

optional callId?: string;

occurredAt?¶

optional occurredAt?: string;

providerCallId?¶

optional providerCallId?: string;

raw¶

raw: SipVoiceProviderResponse;

type¶

type: "recording" | "transcription" | "call.status" | "call.transfer";

Type Aliases¶

SipCallDirection¶

type SipCallDirection = "inbound" | "outbound";

SipCallState¶

type SipCallState =
  | "new"
  | "inviting"
  | "ringing"
  | "answered"
  | "early-media"
  | "held"
  | "transferring"
  | "completed"
  | "failed";

SipMediaEncryption¶

type SipMediaEncryption = "none" | "srtp" | "dtls-srtp";

SipRecordingStatus¶

type SipRecordingStatus = "started" | "paused" | "resumed" | "completed" | "failed";

SipTranscriptionStatus¶

type SipTranscriptionStatus = "partial" | "completed" | "failed";

SipTransferStatus¶

type SipTransferStatus = "requested" | "accepted" | "completed" | "failed" | "cancelled";

SipTransport¶

type SipTransport = "udp" | "tcp" | "tls" | "ws" | "wss";

SipVoiceJsonPrimitive¶

type SipVoiceJsonPrimitive = string | number | boolean | null;

SipVoiceJsonValue¶

type SipVoiceJsonValue =
  | SipVoiceJsonPrimitive
  | SipVoiceJsonObject
  | readonly SipVoiceJsonValue[];

SipVoiceProviderExtensionValue¶

type SipVoiceProviderExtensionValue = SipVoiceJsonValue | object | undefined;

SipVoiceProviderPayload¶

type SipVoiceProviderPayload = SipVoiceJsonObject | object;

SipVoiceProviderQuery¶

type SipVoiceProviderQuery = Record<string, SipVoiceProviderExtensionValue>;

SipWebhookEvent¶

type SipWebhookEvent =
  | SipCallStatusWebhookEvent
  | SipCallTransferWebhookEvent
  | SipRecordingWebhookEvent
  | SipTranscriptionWebhookEvent;

Functions¶

buildSipAddress()¶

function buildSipAddress(address): string;

Parameters¶

Parameter	Type
`address`	`string` \| `SipAddress`

Returns¶

string

createDrachtioSipStackGateway()¶

function createDrachtioSipStackGateway(options?): DrachtioSrfSipGateway;

Parameters¶

Parameter	Type
`options?`	`DrachtioSrfSipStackGatewayOptions`

Returns¶

DrachtioSrfSipGateway

createSipVoiceClient()¶

function createSipVoiceClient(options): SipVoiceClient;

Parameters¶

Parameter	Type
`options`	`SipVoiceClientOptions`

Returns¶

SipVoiceClient

createSipVoiceIntegration()¶

function createSipVoiceIntegration(options): DefinedIntegration<never, unknown, never>;

Parameters¶

Parameter	Type
`options`	`SipVoiceIntegrationOptions`

Returns¶

DefinedIntegration\<never, unknown, never>

createSipVoiceLiveChecks()¶

function createSipVoiceLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        proxyReachable: boolean;
        registered: boolean;
        registrarReachable: boolean;
        srtpReady: boolean;
        tlsReady: boolean;
        webhookReachable: boolean;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options`	`SipLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { proxyReachable: boolean; registered: boolean; registrarReachable: boolean; srtpReady: boolean; tlsReady: boolean; webhookReachable: boolean; }; }>; }[]

parseSipVoiceWebhook()¶

function parseSipVoiceWebhook(request, options?): Promise<SipWebhookEvent>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`ParseSipVoiceWebhookOptions`

Returns¶

Promise\<SipWebhookEvent>

sipVoiceCredentialStatuses()¶

function sipVoiceCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`SipCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

validateSipWebhookSignature()¶

function validateSipWebhookSignature(input): boolean;

Parameters¶

Parameter	Type
`input`	{ `algorithm?`: `"sha256"` \| `"sha1"` \| `"sha512"`; `body`: `string`; `secret`: `string`; `signature`: `string`; }
`input.algorithm?`	`"sha256"` \| `"sha1"` \| `"sha512"`
`input.body`	`string`
`input.secret`	`string`
`input.signature`	`string`

Returns¶

boolean

References¶

createDrachtioSrfSipStackGateway¶

Renames and re-exports createDrachtioSipStackGateway

sipVoiceProviderManifest¶

Re-exports sipVoiceProviderManifest