The SIP object model contains both objects that correspond directly to SIP headers and objects that correspond to common information that occurs in multiple headers. The common objects can be viewed as being embedded in the other SIP header objects and can be accessed as properties of the SIP header objects.
Indicates the content types that are accepted.
Array
Array of SipContentType objects.
Identifies a particular invitation or all registrations of a particular client.
String
Local ID portion of the call ID. For example, 1234 in 1234@host.com.
String
Host name portion of the call ID.
Accepts any Contact header value and provides parsing and serialization.
Boolean
True if the object represents the special value * for a Contact header.
Array
Array of SipNameAddr objects corresponding to the list of contact values.
Indicates the type of content in the message.
String
Content type. For example, application in application/sdp.
String
Content subtype. For example, sdp in application/sdp.
String
Optional attribute. For example, level in application/sdp;level=1.
Indicates the order of transactions within a dialog, provides a means to uniquely identify transactions, and differentiates between new requests and retransmissions.
Integer
Cseq integer value. For example, 1 in 1 INVITE.
String
Method value. For example, INVITE in 1 INVITE.
Methods
NA
Increments the Value field of the Cseq header and leaves the method unchanged.
Indicates the initiator of the request, which can be different from the initiator of the dialog.
String
Display Name field in the SIP message.
SipUrl
URL in the SIP message.
String
Tag field in the SIP message.
String
Display Name field in the SIP message.
SipUrl
URL in the SIP message.
String
Tag field in the SIP message.
Note
A SipNameAddr entity consists of an optional display name followed by a mandatory URL. SipNameAddr entities appear in many SIP headers.
Inserted by proxies in a request to force future requests in the dialog to be routed through the proxy.
Array
Array of SipNameAddr objects corresponding to the Record-Route entries.
Used to manipulate the Request-URI of the SIP request message.
SipUrl
URL included in the request.
String
Protocol used for the request.
String
Version of protocol used for the request.
Used with an error response to indicate how long the service is expected to be unavailable to the requesting client.
Date
ECMAScript date object corresponding to the date, if provided, in the header.
Integer
Value of the duration parameter in the SIP message.
Integer
Delta-seconds value, if provided, in the header.
String
Comment field in the SIP message.
Used to force routing for a request through the listed set of proxies.
Array
Array of SipNameAddr objects corresponding to the Record-Route entries.
Specifies the logical recipient of the request.
String
Display Name field in the SIP message.
SipUrl
URL in the SIP message.
String
Tag field in the SIP message.
Indicates an address that conforms to the SIP addressing scheme and represents the location of the user agent or service.
String
Prefix of the URL. For example, sip, tel, etc.
String
User name in the URL. For example, john in john:example@company.com.
String
Password in the URL. For example, example in john:example@company.com.
Integer
Host name in the URL. For example, company.com in john:example@company.com.
String
Port number in the URL. For example, 5060 in company.com:5060.
String
Tag parameter in the URL, if present.
String
User parameter in the URL, if present.
String
Maddr parameter in the URL, if present.
String
Transport parameter in the URL, if present. For example, udp in john@company.com;transport=udp.
String
Time to live parameter in the URL, if present.
String
Method parameter in the URL, if present.
String
Phone number in the URL, which is valid only if user=phone is a URL parameter. For example, +15551212 in sip:+15551212@company.com;user=phone.
String
Postd parameter in the URL, if present.
String
Isub parameter in the URL, if present.
Array
Array of strings corresponding to the parameters found in the URL (other than those parameters already mentioned).
Array
Array of strings corresponding to the headers found in the URL.
String
Carrier Identification Code.
String
Destination Trunk Group.
String
Particular SIP message type of INVITE, ACK, BYE, CANCEL, REGISTER, or OPTIONS.
String
Originating Line Information.
String
Originating Trunk Group.
Indicates the path taken by the request so far and the path that should be followed in routing responses.
String
Branch parameter on the Via.
String
Comment field, if present.
String
Protocol used for the message.
String
Transport protocol.
String
Version of protocol used for the message.
Array
Key/value pairs of all parameters other than branch.
String
Host part of the message.
Number
Port part of the message.
String
Array of SipVia objects.