![]() | |
ChannelResource Class |
Namespace: VoiceElements.Client
The ChannelResource type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | Ani | This is the originating number of the last inbound call (if available). |
![]() | CallConnected |
The time the call connected
|
![]() | CallEnd |
The time the call was terminated.
|
![]() ![]() | CallerIdName | This is the originating name field of the last inbound call (if available). |
![]() | CallNumber |
The call number on the server of the current or last call.
|
![]() ![]() | CallProgress |
Gets or Sets the Call Progress Mode for this channel.
|
![]() ![]() | CallProgressOverrides |
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.
|
![]() ![]() | CallProgressTemplate |
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.
|
![]() | CallStart |
The time the call was started.
|
![]() | Conference |
Represents the Conference of which this resource is a member.
(Inherited from RoutableResource.) |
![]() | ConferenceAttributes |
Represents the Conference Attributes of a Conference to which this resource is a member.
(Inherited from RoutableResource.) |
![]() | DeviceName |
The unique name of this resource / device on the server. This is useful for following, logging a call or thread.
(Inherited from RoutableResource.) |
![]() ![]() | DialResult |
Gets the Dial Result of the last call based on the Call Progress Mode setting.
|
![]() ![]() | Dnis | This is the DNIS or the inbound number dialed of the last inbound call. |
![]() | DropError |
The Drop Error Code of a disconnected call.
|
![]() ![]() | DropTime |
A time at which the server should automatically drop the call whether it is disonnected or not. This value is Universal Time.
|
![]() ![]() | FaxResource |
Gets the fax resource associated with this channel. To get a fax resource, call Get Fax Resource Method on this channel.
|
![]() ![]() | GcCause | GC Cause code for a disconnected call if available. |
![]() ![]() | GcCauseMessage | GC Cause message for a disconnected call if available. |
![]() ![]() | GeneralCause | General Cause code for a disconnected call if available. |
![]() ![]() | GeneralCauseMessage | General Cause message for a disconnected call if available. |
![]() | Listeners |
A list of Routable Resources which are currently listening to this resource.
(Inherited from RoutableResource.) |
![]() | ListentingTo |
A Routable Resources to which this resource is currently listening.
(Inherited from RoutableResource.) |
![]() ![]() | MaximumTime |
Sets the maximum time in seconds to wait for a Dial to complete. Default is 30.
|
![]() ![]() | OriginatingPhoneNumber | This is the CallerID number sent with an oubound call when a Dial is executed. |
![]() ![]() | PortIndexer |
The one based index of this channel on the server.
|
![]() | TransferredCall |
A flag to indicate that this call was transferred from another application. If true, TransferredData may contain data passed from the other application.
|
![]() ![]() | TransferredData |
Gets the data sent from another application which has invoked the Transfer Application Method to this application.
|
![]() ![]() | VoiceResource |
The Voice Resource associated with this channel. Use this for audio functions like play, record and getting digits.
|
Name | Description | |
---|---|---|
![]() ![]() | Answer |
This method is used to pickup an inbound call received on a Channel Resource.
|
![]() ![]() | Dial |
Dials the phone number or destination specified in the phonenumber parameter.
|
![]() ![]() | Disconnect |
This method forces the Channel Resource to disconnect any current connections or calls. You may also think of this as "hanging up."
|
![]() ![]() | Disconnect(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.
|
![]() ![]() | Dispose |
This method forces a dispose of the Channel Resource object. Always do this in hang up handling to ensure clean up.
(Overrides ClientObject.Dispose(Boolean).) |
![]() ![]() | GetFaxResource |
Retreives a compatible Fax Resource for this Channel. It also sets the Fax Resource Property of the Channel.
|
![]() ![]() | IsConnected |
Returns the status of any current call. True if a call is connected, false if not connected.
|
![]() | RouteFull(TelephonyLinkInfo) |
This overload is for Voice Elements Internal Use Only! To correctly route, use the
Full Route Method.
(Inherited from RoutableResource.) |
![]() ![]() | RouteFull(RoutableResource) |
Completes a full route between two Routable Resources. Both channels then listen to each other.
(Inherited from RoutableResource.) |
![]() | RouteHalf(TelephonyLinkInfo) | This overload is for Voice Elements Internal Use Only! To correctly route, use the
Half Route Method. (Inherited from RoutableResource.) |
![]() ![]() | RouteHalf(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.) |
![]() | SetConferenceAGCLevels |
Sets the levels for the AGC in conferencing. If all values are set to negatives, then the system wide AGC applies.
(Inherited from RoutableResource.) |
![]() | SetConferenceECTailDelay |
Sets the Echo Tail Delay in conferencing.
(Inherited from RoutableResource.) |
![]() | SetConferenceFEGLevel |
Sets the front end gain in conferencing. If set to 0, front end gain is turned off.
(Inherited from RoutableResource.) |
![]() ![]() | SetMonitorData |
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.
|
![]() ![]() | SetMonitorStatus |
Sets the Monitor Status element for this channel when viewed through the Voice Elements Dashboard.
|
![]() | StopAllListeners |
Forces all Routable Resources currently listening to this resource to stop.
(Inherited from RoutableResource.) |
![]() ![]() | StopDial | Instructs the channel to stop a currently in progress dial. |
![]() | StopListener |
Forces a apecific Routable Resource currently listening to this resource to stop.
(Inherited from RoutableResource.) |
![]() | StopListening |
Forces this resource to stop listening to all Routable Resources.
(Inherited from RoutableResource.) |
![]() ![]() | TransferApplication |
Transfers the Channel Resource to a different application on the same Telephony Server.
|
Name | Description | |
---|---|---|
![]() | DialComplete |
Event Fired at the completion of a dial operation.
|
![]() ![]() | Disconnected | Fires when a call disconnects or hangs up. Do your cleanup in this event code. |
![]() ![]() | NewCall |
Fires when there is a new inbound call sent from the Voice Elements Server.
|
Name | Description | |
---|---|---|
![]() | m_DialResult |
public void ExecuteChannelMethods() { // To get a channel, you must first get a link to a Telephony Server. You may need to pass a username password here. TelephonyServer m_TelephonyServer = new TelephonyServer(); // Get your channel resource from the server ChannelResource m_ChannelResource = m_TelephonyServer.GetChannel(); // Example 1: Dial an oubound call string phoneNumber = "2135551212"; m_ChannelResource.Dial(phoneNumber); // Next, use the voice resource of the channel to do some more things // First, play an audio file m_ChannelResource.VoiceResource.Play(@"C:\Audio\Sample.wav"); // Get digits from the caller TerminationCode terminationCode = m_ChannelResource.VoiceResource.GetDigits(); string m_Digits = m_ChannelResource.VoiceResource.DigitBuffer; // Play text to speech to the caller m_ChannelResource.VoiceResource.PlayTTS("Hello, this is your application speaking. Please say whatever you like."); // Record the callers response to the file specified m_ChannelResource.VoiceResource.Record(@"C:\Audio\RecordedCall.wav"); }