Click or drag to resize

SipChannel Methods

The SipChannel type exposes the following members.

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
See Also