Interface SipReferVerb

interface SipReferVerb {
    verb: "sip:refer";
    id?: string;
    referTo: string;
    referredBy?: string;
    referredByDisplayName?: string;
    headers?: Record<string, string>;
    actionHook?: ActionHook;
    eventHook?: ActionHook;
}

Index

Properties

verb id? referTo referredBy? referredByDisplayName? headers? actionHook? eventHook?

Properties

verb

verb: "sip:refer"

`Optional`id

id?: string

referTo

referTo: string

SIP URI or phone number to transfer to.

`Optional`referredBy

referredBy?: string

Referred-By header value.

`Optional`referredByDisplayName

referredByDisplayName?: string

Display name for Referred-By.

`Optional`headers

headers?: Record<string, string>

Custom SIP headers.

`Optional`actionHook

actionHook?: ActionHook

Webhook when REFER completes.

`Optional`eventHook

eventHook?: ActionHook

Webhook for NOTIFY progress events.