Click or drag to resize

SipChannel Class

Represents a SIP based channel on the Telephony Server and supports SIP speicifc fundtions like Refer, Reinvite. Inherits from Channel Resource.
Inheritance Hierarchy

Namespace:  VoiceElements.Client
Assembly:  VoiceElementsClient (in VoiceElementsClient.dll) Version: 8.6.1.1
Syntax
public class SipChannel : ChannelResource

The SipChannel type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleAni
This is the originating number of the last inbound call (if available).
(Inherited from ChannelResource.)
Public propertyCallConnected
The time the call connected
(Inherited from ChannelResource.)
Public propertyCallEnd
The time the call was terminated.
(Inherited from ChannelResource.)
Public propertyCode exampleCallerIdName
This is the originating name field of the last inbound call (if available).
(Inherited from ChannelResource.)
Public propertyCallNumber
The call number on the server of the current or last call.
(Inherited from ChannelResource.)
Public propertyCode exampleCallProgress
Gets or Sets the Call Progress Mode for this channel.
(Inherited from ChannelResource.)
Public propertyCode exampleCallProgressOverrides
A serializable object that provides override information to the call progress template. This is used to override Dialogic call progress settings for the next call.
(Inherited from ChannelResource.)
Public propertyCode exampleCallProgressTemplate
Gets or sets the call progress template to use as a basis for the next call. This is used to override Dialogic call progress settings.
(Inherited from ChannelResource.)
Public propertyCallStart
The time the call was started.
(Inherited from ChannelResource.)
Public propertyConference
Represents the Conference of which this resource is a member.
(Inherited from RoutableResource.)
Public propertyConferenceAttributes
Represents the Conference Attributes of a Conference to which this resource is a member.
(Inherited from RoutableResource.)
Public propertyDeviceName
The unique name of this resource / device on the server. This is useful for following, logging a call or thread.
(Inherited from RoutableResource.)
Public propertyDialog
Gets the current dialog for the channel. This is read-only.
Public propertyCode exampleDialResult
Gets the Dial Result of the last call based on the Call Progress Mode setting.
(Inherited from ChannelResource.)
Public propertyCode exampleDnis
This is the DNIS or the inbound number dialed of the last inbound call.
(Inherited from ChannelResource.)
Public propertyDropError
The Drop Error Code of a disconnected call.
(Inherited from ChannelResource.)
Public propertyCode exampleDropTime
A time at which the server should automatically drop the call whether it is disonnected or not. This value is Universal Time.
(Inherited from ChannelResource.)
Public propertyCode exampleFaxResource
Gets the fax resource associated with this channel. To get a fax resource, call Get Fax Resource Method on this channel.
(Inherited from ChannelResource.)
Public propertyCode exampleGcCause
GC Cause code for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyCode exampleGcCauseMessage
GC Cause message for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyCode exampleGeneralCause
General Cause code for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyCode exampleGeneralCauseMessage
General Cause message for a disconnected call if available.
(Inherited from ChannelResource.)
Public propertyIncomingSipHeaders
Gets the incoming SIP headers for the current call. This is read-only.
Public propertyIncomingSipRequestLine
Public propertyListeners
A list of Routable Resources which are currently listening to this resource.
(Inherited from RoutableResource.)
Public propertyListentingTo
A Routable Resources to which this resource is currently listening.
(Inherited from RoutableResource.)
Public propertyLocalCallControlAddress
Public propertyCode exampleMaximumTime
Sets the maximum time in seconds to wait for a Dial to complete. Default is 30.
(Inherited from ChannelResource.)
Public propertyOriginatingCallerIdName
Sets the outbound caller ID name field value.
Public propertyCode exampleOriginatingPhoneNumber
This is the CallerID number sent with an oubound call when a Dial is executed.
(Inherited from ChannelResource.)
Public propertyOutgoingSipHeaders
Sets the SIP headers for an outbound call.
Public propertyOverrideDestination
Public propertyOverrideRequestLine
Public propertyCode examplePortIndexer
The one based index of this channel on the server.
(Inherited from ChannelResource.)
Public propertyRemoteCallControlAddress
The call control address on the remote side that is handling this call. The string format is: IP Address:Port.
Public propertyRtpAddress
Returns the address of the RTP currently in use on this channel.
Public propertyRtpCodec
Returns the name of the RTP codec currently in use on this channel.
Public propertyRtpEncryptionMode
Public propertyRtpEncryptionState
Public propertyRtpPort
Returns the port being used for RTP on this channel.
Public propertyRtpSdp
Returns the SDP (Session Description Protocol)of the RTP currently in use on this channel.
Public propertyTransferredCall
A flag to indicate that this call was transferred from another application. If true, TransferredData may contain data passed from the other application.
(Inherited from ChannelResource.)
Public propertyCode exampleTransferredData
Gets the data sent from another application which has invoked the Transfer Application Method to this application.
(Inherited from ChannelResource.)
Public propertyTransportProtocol
Public propertyCode exampleVoiceResource
The Voice Resource associated with this channel. Use this for audio functions like play, record and getting digits.
(Inherited from ChannelResource.)
Top
Methods
  NameDescription
Public methodAcceptCall
Accepts an incoming call by sending a Session Progress Message.
Public methodCode exampleAnswer
This method is used to pickup an inbound call received on a Channel Resource.
(Inherited from ChannelResource.)
Public methodChangeAudio(RtpType)
Changes the RTP Type.
Public methodChangeAudio(StreamDuplex)
Changes the Stream Duplex of the audio stream. Use StreamDuplex.SendOnly to place a call on hold. Use StreamDuplex.Both to take off hold.
Public methodChangeAudio(String, Int32)
Reinvites the audio stream to a new Host and Port specified.
Public methodChangeAudio(String, Int32, RtpType)
Reinvite the audio stream to a new Host, Port with a new RTP Type.
Public methodChangeAudio(String, Int32, RtpType, StreamDuplex)
Reinvite the audio stream to a new Host, Port with a new RTP Type and Stream Duplex.
Public methodChangeAudio(String, Int32, RtpType, StreamDuplex, Boolean)
Reinvite the audio stream to a new Host, Port with a new RTP Type, Stream Duplex and RFC2833 DTMF switch.
Public methodChangeAudio(String, Int32, RtpType, StreamDuplex, Boolean, Int32)
Reinvite the audio stream to a new Host, Port with a new RTP Type, Stream Duplex, RFC2833 DTMF switch and packet time.
Public methodCode exampleDial(String)
Dials the phone number or destination specified in the phonenumber parameter.
(Inherited from ChannelResource.)
Public methodDial(String, DestinationGroup)
Dials out using the specified DestinationGroup
Public methodCode exampleDisconnect
This method forces the Channel Resource to disconnect any current connections or calls. You may also think of this as "hanging up."
(Inherited from ChannelResource.)
Public methodCode exampleDisconnect(Int32)
This method forces the Channel Resource to disconnect any current connections or calls. You may also think of this as "hanging up." This overload of the method requires you to specify a numeric cause code to the carrier telling the reason for the disconnect.
(Inherited from ChannelResource.)
Protected methodCode exampleDispose
This method forces a dispose of the Channel Resource object. Always do this in hang up handling to ensure clean up.
(Inherited from ChannelResource.)
Public methodCode exampleGetFaxResource
Retreives a compatible Fax Resource for this Channel. It also sets the Fax Resource Property of the Channel.
(Inherited from ChannelResource.)
Public methodCode exampleIsConnected
Returns the status of any current call. True if a call is connected, false if not connected.
(Inherited from ChannelResource.)
Public methodRedirect(String)
Redirects an incoming call to an alternate address specified with the format: <sip:500@162.18.13.4>.
Public methodRedirect(String)
Redirects an incoming call to all alternate addresses specified in an array with the format: <sip:500@162.18.13.4>.
Public methodRefer(SipChannel)
Performs an attended transfer of the current call to the target Sip Channel.
Public methodRefer(String, String)
Performs an unattended transfer of the current call to the target IP Address / Phone Number.
Public methodReinvite(SipChannel)
Reinvite this Sip Channel and specified Sip Channel to send RTP streams directly to each other. Note that both streams must have the same codec.
Public methodReinvite(String, String, UInt32, String)
Issues a reinvite for the current call. This allows you to redirect the RTP traffic to a different address and is used to reduce latency in the audio stream.
Public methodReinviteHome
Reinvite audio back to the server from another endpoint.
Public methodReinviteRefresh
Issue a refresh reinvite to ensure callers are still talking.
Public methodRouteFull(TelephonyLinkInfo)
This overload is for Voice Elements Internal Use Only! To correctly route, use the Full Route Method.
(Inherited from RoutableResource.)
Public methodCode exampleRouteFull(RoutableResource)
Completes a full route between two Routable Resources. Both channels then listen to each other.
(Inherited from RoutableResource.)
Public methodRouteHalf(TelephonyLinkInfo)
This overload is for Voice Elements Internal Use Only! To correctly route, use the Half Route Method.
(Inherited from RoutableResource.)
Public methodCode exampleRouteHalf(RoutableResource)
Completes a half route between two Routable Resources. The channel calling this method listens to the one in the parameter, the second cannot hear.
(Inherited from RoutableResource.)
Public methodSendSipNotifyRequest
Send a NOTIFY request
Public methodSendSipSubscribeRequest
Send a SUBSCRIBE request
Public methodSetConferenceAGCLevels
Sets the levels for the AGC in conferencing. If all values are set to negatives, then the system wide AGC applies.
(Inherited from RoutableResource.)
Public methodSetConferenceECTailDelay
Sets the Echo Tail Delay in conferencing.
(Inherited from RoutableResource.)
Public methodSetConferenceFEGLevel
Sets the front end gain in conferencing. If set to 0, front end gain is turned off.
(Inherited from RoutableResource.)
Public methodCode exampleSetMonitorData
Sets the Monitor Data element for this channel when viewed through the Voice Elements Dashboard. This is a collection of data elements you define to communicate from your application through the VE Dashboard.
(Inherited from ChannelResource.)
Public methodCode exampleSetMonitorStatus
Sets the Monitor Status element for this channel when viewed through the Voice Elements Dashboard.
(Inherited from ChannelResource.)
Public methodStopAllListeners
Forces all Routable Resources currently listening to this resource to stop.
(Inherited from RoutableResource.)
Public methodCode exampleStopDial
Instructs the channel to stop a currently in progress dial.
(Inherited from ChannelResource.)
Public methodStopListener
Forces a apecific Routable Resource currently listening to this resource to stop.
(Inherited from RoutableResource.)
Public methodStopListening
Forces this resource to stop listening to all Routable Resources.
(Inherited from RoutableResource.)
Public methodCode exampleTransferApplication
Transfers the Channel Resource to a different application on the same Telephony Server.
(Inherited from ChannelResource.)
Top
Events
  NameDescription
Public eventCallProgressEvent
Triggered when a Call Progress Event is received
Public eventDialComplete
Event Fired at the completion of a dial operation.
(Inherited from ChannelResource.)
Public eventCode exampleDisconnected
Fires when a call disconnects or hangs up. Do your cleanup in this event code.
(Inherited from ChannelResource.)
Public eventCode exampleNewCall
Fires when there is a new inbound call sent from the Voice Elements Server.
(Inherited from ChannelResource.)
Public eventQosEvent
Triggered when QOS(Quiality of Service) Events occur on an ongoing Sip call.
Public eventStreamingStateEvent
Triggered when a Streaming State Event is received
Top
Fields
  NameDescription
Protected fieldm_DialResult (Inherited from ChannelResource.)
Top
Remarks
Documentation In Development

We are constantly adding features and new capabilities to The Voice Elements Platform. Therefore, our documentation of individual methods, properties and other elements is constantly being developed and improved. If you would like to know more about this element, please help us perfect our documentation and help you develop your application by doing one or more of the following:

Thank you for your continued support of Voice Elements.

See Also