Class SIPCallDescriptor

Inheritance
System.Object
SIPCallDescriptor
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SIPSorcery.SIP.App
Assembly: SIPSorcery.dll
Syntax
public class SIPCallDescriptor

Constructors

| Improve this Doc View Source

SIPCallDescriptor(ISIPAccount, String, String, String, String)

This constructor is for calls to a SIP account that the application recognises as belonging to it.

Declaration
public SIPCallDescriptor(ISIPAccount toSIPAccount, string uri, string fromHeader, string contentType, string content)
Parameters
Type Name Description
ISIPAccount toSIPAccount

The destination SP account for the call.
System.String uri

The uri can be different to the to SIP account if a dotted notation is used. For example 1234.user@sipsorcery.com.
System.String fromHeader
System.String contentType
System.String content
| Improve this Doc View Source

SIPCallDescriptor(String, String)

This constructor is for non-authenticated calls that do not require any custom headers etc.

Declaration
public SIPCallDescriptor(string dstUri, string sdp)
Parameters
Type Name Description
System.String dstUri

The destination URI to place the call to.
System.String sdp

The Session Description Protocol (SDP) body to use in the call request. Can be empty if the remote party supports SDP answers via ACK requests.
| Improve this Doc View Source

SIPCallDescriptor(String, String, String, String, String, Int32, String, String, IPAddress)

Declaration
public SIPCallDescriptor(string username, string password, string uri, string callbackNumber, string callbackPattern, int callbackPhoneType, string content, string contentType, IPAddress mangleIPAddress)
Parameters
Type Name Description
System.String username
System.String password
System.String uri
System.String callbackNumber
System.String callbackPattern
System.Int32 callbackPhoneType
System.String content
System.String contentType
System.Net.IPAddress mangleIPAddress
| Improve this Doc View Source

SIPCallDescriptor(String, String, String, String, String, String, List<String>, String, SIPCallDirection, String, String, IPAddress)

Declaration
public SIPCallDescriptor(string username, string password, string uri, string from, string to, string routeSet, List<string> customHeaders, string authUsername, SIPCallDirection callDirection, string contentType, string content, IPAddress mangleIPAddress)
Parameters
Type Name Description
System.String username
System.String password
System.String uri
System.String from
System.String to
System.String routeSet
System.Collections.Generic.List<System.String> customHeaders
System.String authUsername
SIPCallDirection callDirection
System.String contentType
System.String content
System.Net.IPAddress mangleIPAddress

Fields

| Improve this Doc View Source

ACCOUNT_CODE_KEY

Declaration
public const string ACCOUNT_CODE_KEY = "ac"
Field Value
Type Description
System.String
| Improve this Doc View Source

AccountCode

Declaration
public string AccountCode
Field Value
Type Description
System.String
| Improve this Doc View Source

AuthUsername

Declaration
public string AuthUsername
Field Value
Type Description
System.String
| Improve this Doc View Source

BranchId

A string representing the Branch part of the SIP-VIA header to identify Call-Requests and Call-Responses defaults to CreateBranchId() if not set

BranchId MUST be unique between different calls and even requests BranchId MUST start with "z9hG4bK"

Declaration
public string BranchId
Field Value
Type Description
System.String
Remarks

to avoid unexpected behaviour: BranchId should only be customized in fully controlled enclosed environments or for testing purposes

| Improve this Doc View Source

CALL_DURATION_OPTION_KEY

Declaration
public const string CALL_DURATION_OPTION_KEY = "cd"
Field Value
Type Description
System.String
| Improve this Doc View Source

CallbackNumber

Declaration
public string CallbackNumber
Field Value
Type Description
System.String
| Improve this Doc View Source

CallbackPattern

Declaration
public string CallbackPattern
Field Value
Type Description
System.String
| Improve this Doc View Source

CallbackPhoneType

Declaration
public int CallbackPhoneType
Field Value
Type Description
System.Int32
| Improve this Doc View Source

CallDirection

Declaration
public SIPCallDirection CallDirection
Field Value
Type Description
SIPCallDirection
| Improve this Doc View Source

CallDurationLimit

Declaration
public int CallDurationLimit
Field Value
Type Description
System.Int32
| Improve this Doc View Source

CallId

A string representing the Call Identifier defaults to CreateNewCallId() if not set

CallId MUST be unique between different calls

Declaration
public string CallId
Field Value
Type Description
System.String
| Improve this Doc View Source

Content

Declaration
public string Content
Field Value
Type Description
System.String
| Improve this Doc View Source

ContentType

Declaration
public string ContentType
Field Value
Type Description
System.String
| Improve this Doc View Source

CRMHeaders

Declaration
public CRMHeaders CRMHeaders
Field Value
Type Description
CRMHeaders
| Improve this Doc View Source

CustomHeaders

Declaration
public List<string> CustomHeaders
Field Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

DELAY_CALL_OPTION_KEY

Declaration
public const string DELAY_CALL_OPTION_KEY = "dt"
Field Value
Type Description
System.String
| Improve this Doc View Source

DELAYED_REINVITE_KEY

Declaration
public const string DELAYED_REINVITE_KEY = "dr"
Field Value
Type Description
System.String
| Improve this Doc View Source

DelayMRE

Declaration
public ManualResetEvent DelayMRE
Field Value
Type Description
System.Threading.ManualResetEvent
| Improve this Doc View Source

DelaySeconds

Declaration
public int DelaySeconds
Field Value
Type Description
System.Int32
| Improve this Doc View Source

DialPlanContextID

Declaration
public Guid DialPlanContextID
Field Value
Type Description
System.Guid
| Improve this Doc View Source

From

Declaration
public string From
Field Value
Type Description
System.String
| Improve this Doc View Source

FROM_DISPLAY_NAME_KEY

Declaration
public const string FROM_DISPLAY_NAME_KEY = "fd"
Field Value
Type Description
System.String
| Improve this Doc View Source

FROM_HOST_KEY

Declaration
public const string FROM_HOST_KEY = "fh"
Field Value
Type Description
System.String
| Improve this Doc View Source

FROM_USERNAME_KEY

Declaration
public const string FROM_USERNAME_KEY = "fu"
Field Value
Type Description
System.String
| Improve this Doc View Source

FromDisplayName

Declaration
public string FromDisplayName
Field Value
Type Description
System.String
| Improve this Doc View Source

FromURIHost

Declaration
public string FromURIHost
Field Value
Type Description
System.String
| Improve this Doc View Source

FromURIUsername

Declaration
public string FromURIUsername
Field Value
Type Description
System.String
| Improve this Doc View Source

IsGoogleVoiceCall

Declaration
public bool IsGoogleVoiceCall
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

MANGLE_MODE_OPTION_KEY

Declaration
public const string MANGLE_MODE_OPTION_KEY = "ma"
Field Value
Type Description
System.String
| Improve this Doc View Source

MangleIPAddress

Declaration
public IPAddress MangleIPAddress
Field Value
Type Description
System.Net.IPAddress
| Improve this Doc View Source

MangleResponseSDP

Declaration
public bool MangleResponseSDP
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Password

Declaration
public string Password
Field Value
Type Description
System.String
| Improve this Doc View Source

ProxySendFrom

Declaration
public string ProxySendFrom
Field Value
Type Description
System.String
| Improve this Doc View Source

RATE_CODE_KEY

Declaration
public const string RATE_CODE_KEY = "rc"
Field Value
Type Description
System.String
| Improve this Doc View Source

RateCode

Declaration
public string RateCode
Field Value
Type Description
System.String
| Improve this Doc View Source

REDIRECT_MODE_OPTION_KEY

Declaration
public const string REDIRECT_MODE_OPTION_KEY = "rm"
Field Value
Type Description
System.String
| Improve this Doc View Source

RedirectMode

Declaration
public SIPCallRedirectModesEnum RedirectMode
Field Value
Type Description
SIPCallRedirectModesEnum
| Improve this Doc View Source

ReinviteDelay

Declaration
public int ReinviteDelay
Field Value
Type Description
System.Int32
| Improve this Doc View Source

REQUEST_CALLER_DETAILS

Declaration
public const string REQUEST_CALLER_DETAILS = "rcd"
Field Value
Type Description
System.String
| Improve this Doc View Source

RequestCallerDetails

Declaration
public bool RequestCallerDetails
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

RouteSet

Declaration
public string RouteSet
Field Value
Type Description
System.String
| Improve this Doc View Source

SWITCHBOARD_CALLID_KEY

Declaration
public const string SWITCHBOARD_CALLID_KEY = "swcid"
Field Value
Type Description
System.String
| Improve this Doc View Source

SWITCHBOARD_LINE_NAME_KEY

Declaration
public const string SWITCHBOARD_LINE_NAME_KEY = "swln"
Field Value
Type Description
System.String
| Improve this Doc View Source

SWITCHBOARD_OWNER_KEY

Declaration
public const string SWITCHBOARD_OWNER_KEY = "swo"
Field Value
Type Description
System.String
| Improve this Doc View Source

To

Declaration
public string To
Field Value
Type Description
System.String
| Improve this Doc View Source

ToSIPAccount

Declaration
public ISIPAccount ToSIPAccount
Field Value
Type Description
ISIPAccount
| Improve this Doc View Source

TRANSFER_MODE_OPTION_KEY

Declaration
public const string TRANSFER_MODE_OPTION_KEY = "tr"
Field Value
Type Description
System.String
| Improve this Doc View Source

TransferMode

Declaration
public SIPDialogueTransferModesEnum TransferMode
Field Value
Type Description
SIPDialogueTransferModesEnum
| Improve this Doc View Source

Uri

Declaration
public string Uri
Field Value
Type Description
System.String
| Improve this Doc View Source

Username

Declaration
public string Username
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

CopyOf()

Declaration
public SIPCallDescriptor CopyOf()
Returns
Type Description
SIPCallDescriptor
| Improve this Doc View Source

GetFromHeader()

Declaration
public SIPFromHeader GetFromHeader()
Returns
Type Description
SIPFromHeader
| Improve this Doc View Source

ParseCallOptions(String)

Declaration
public void ParseCallOptions(string options)
Parameters
Type Name Description
System.String options
| Improve this Doc View Source

ParseCustomHeaders(String)

Declaration
public static List<string> ParseCustomHeaders(string customHeaders)
Parameters
Type Name Description
System.String customHeaders
Returns
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

SetGeneralFromHeaderFields(String, String, String)

These setting do NOT override the ones from the call options.

Declaration
public void SetGeneralFromHeaderFields(string fromDisplayName, string fromUsername, string fromHost)
Parameters
Type Name Description
System.String fromDisplayName
System.String fromUsername
System.String fromHost

Extension Methods