XCC
XCC Provider Operations
The XCC (Extended Call Control) provider supports operations that allow a client application to perform call control and real-time call monitoring.
NotifyXccCallData
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callData |
CallData |
M |
Call information |
mediaEvent |
cMediaEvent |
M |
Choice of media event |
RequestXccCallMediaForking
RequestXccCallMediaSetAttributes
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callID |
string |
M |
Call identification |
mediaEventsFilter |
MediaEventsFilter |
O |
Enables media event types to be sent in an application. Turn off any media events if this element is not included in the request |
mediaForking |
MediaForkingData |
O |
Media Forking Data |
RequestXccCallRelease
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callID |
string |
M |
Call identification |
disCause |
int |
O |
Q.850 disconnect cause range [1-188] |
RequestXccConnectionAddressAnalyzeDone
RequestXccConnectionAuthorizeDone
RequestXccConnectionMediaForking
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callID |
string |
M |
Call Identification |
connID |
string |
M |
Connection Identification |
action |
cCallMediaForking |
M |
Media forking action choice |
RequestXccConnectionRelease
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callID |
string |
M |
Call Identification |
connID |
string |
M |
Connection Identification |
discCause |
int |
M |
Q.850 disconnect cause range [1 - 188] |
RequestXccControlUpdate
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
connectionEventsFilter |
ConnectionEventsFilter |
O |
List of events that shall be notified to application |
mediaEventsFilter |
MediaEventsFilter |
O |
List of media events that shall be notfied to application |
blockingEventTimeoutSec |
int |
O |
Some application responses may block. This timeout specifies how long XCC provider will wait for the response in seconds. |
blockingTimeoutHandle |
eBlockingTimeoutHandle |
O |
How XCC provider should handle the call when blocking event timeouts |
RequestXccRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
applicationData |
ApplicationData |
M |
Application sends this request |
providerData |
ProviderData |
M |
XCC provider |
connectionEventsFilter |
ConnectionEventsFilter |
O |
List of events that shall be notified to application |
mediaEventsFilter |
MediaEventsFilter |
O |
List of media events that shall be notfied to application |
blockingEventTimeoutSec |
int |
O |
Some application responses may block. This timeout specifies how long XCC provider will wait for the response in seconds. |
blockingTimeoutHandle |
eBlockingTimeoutHandle |
O |
How XCC provider should handle the call when blocking event timeouts |
RequestXccUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccCallMediaForking
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccCallMediaSetAttributes
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccCallRelease
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccConnectionAddressAnalyze
ResponseXccConnectionAddressAnalyzeDone
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccConnectionAuthorize
ResponseXccConnectionAuthorizeDone
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccConnectionMediaForking
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccConnectionRelease
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccControlUpdate
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccProbing
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
sequence |
int |
M |
Sequence number of the probing messages |
ResponseXccProviderUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXccRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
providerStatus |
eProviderStatus |
M |
Current provider status |
ResponseXccUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header the messages |
SolicitXccConnectionAddressAnalyze
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callData |
CallData |
M |
Call information |
connData |
ConnData |
M |
Connection information |
collectAddress |
AddrData |
O |
Connection collect address data |
SolicitXccConnectionAuthorize
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callData |
CallData |
M |
Call information |
connDetailData |
ConnDetailData |
M |
Connection detail information |
SolicitXccProbing
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
sequence |
int |
M |
Sequence number of the probing message |
interval |
duration |
M |
Interval between probing messages |
failureCount |
int |
M |
Counts on previous probing failures since last successful message exchange in this reigstration session |
registered |
boolean |
M |
Registration status |
providerStatus |
eProviderStatus |
M |
Provider current status |
SolicitXccProviderUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
Xcc Message Data Types
This section describes the data types and elements that are found in the Xcc Provider messages.
Xcc Composite Data Type
The following section describes the composite data structures defined within the Xcc Provider.
Alerting
(This is an empty element)
Block
|
|
|
|
blockingEventTimeoutSec |
int |
O |
Some application responses may block. This timeout specifies how long XCC provider will wait for the response in seconds. |
blockingTimeoutHandle |
eBlockingTimeoutHandle |
O |
How XCC provider should handle the call when blocking event timeouts |
CallDelivery
(This is an empty element)
CallRouteData
|
|
|
|
routeAddrData |
AddrData |
M |
terminating party address data |
connectionEventsFilter |
ConnectionEventsFilter |
O |
List of connection events shall be enabled for the new terminating connection |
ContinueProcessing
(This is an empty element)
DisableMediaForking
(This is an empty element)
Disconnected
|
|
|
|
mediaData |
MediaData |
M |
Connection media data |
discCause |
int |
M |
Q.850 disconnect cause range [1 - 188] |
statsData |
StatsData |
O |
statistics data |
jitterData |
JitterData |
O |
media jitter data |
DTMF
|
|
|
|
digit |
string |
M |
a dtmf digit |
dateTime |
string |
M |
Time when dtmf occurs |
HandoffLeave
(This is an empty element)
JitterData
Referenced by: Disconnected
|
|
|
|
roundTripDelayMSec |
int |
M |
Round trip delay (in ms) |
onTimeRvPlayMSec |
int |
M |
On time Rv Play (in ms) |
gapFillWithPredictionMSec |
int |
M |
Prediction count (in ms) |
gapFillWithInterpolationMSec |
int |
M |
Interpolation count (in ms) |
gapFillWithRedundancyMSec |
int |
M |
Redundancy count (in ms) |
lostPacketsCount |
int |
M |
Lost packets count |
earlyPacketsCount |
int |
M |
Early packets count |
latePacketsCount |
int |
M |
Late packets count |
receiveDelayMSec |
int |
M |
Receive delay (in ms) |
loWaterPlayoutDelayMSec |
int |
M |
Low water playout delay (in ms) |
hiWaterPlayoutDelayMSec |
int |
M |
Hi water playout delay (in ms) |
Release
|
|
|
|
discCause |
int |
M |
Q.850 disconnect cause range [1 - 188] |
StatsData
Referenced by: Disconnected
|
|
|
|
callDuration |
duration |
M |
call duration |
TxPacketsCount |
int |
M |
Total Tx Packets |
TxBytesCount |
int |
M |
Total Tx Bytes |
TxDurationMSec |
int |
M |
Tx Duration in milliseconds |
TxVoiceDurationMSec |
int |
M |
Tx Voice Duration in milliseconds |
RxPacketsCount |
int |
M |
Total Rx Packets |
RxBytesCount |
int |
M |
Total Rx Bytes |
RxDurationMSec |
int |
M |
Rx Duration in milliseconds |
RxVoiceDurationMSec |
int |
M |
Rx Voice Duration in milliseconds |
Xcc Choice Elements
Choice records - may contain only one field at a time
CallMediaForkingOpt - choice
Referenced by: cCallMediaForking
Enable media forking Only one of the following elements:
|
|
|
enableMediaForking |
MediaForkingData |
Enable media forking |
disableMediaForking |
Empty element |
Disable media forking |
ConnAddrAnalzDoneOpt - choice
Referenced by: cConnectionAddressAnalyzeDone
Release the connection Only one of the following elements:
|
|
|
release |
Release |
Release the connection |
continueProcessing |
Empty element |
Continue the connection processing |
callRoute |
CallRouteData |
Application specifies the call route |
ConnAddrAnalzOpt - choice
Referenced by: cConnectionAddressAnalyze
Temporary block the connection processing and wait for application for further request Only one of the following elements:
|
|
|
block |
Block |
Temporary block the connection processing and wait for application for further request |
release |
Release |
Release the connection |
continueProcessing |
Empty element |
Continue the connection processing |
callRoute |
CallRouteData |
Application specifies the call route |
ConnAuthDoneOpt - choice
Referenced by: cConnectionAuthorizeDone
Release the connection Only one of the following elements:
|
|
|
release |
Release |
Release the connection |
continueProcessing |
Empty element |
Continue the connection processing |
ConnAuthOpt - choice
Referenced by: cConnectionAuthorize
Temporary block the connection processing and wait for application for further request Only one of the following elements:
|
|
|
block |
Block |
Temporary block the connection processing and wait for application for further request |
release |
Release |
Release the connection |
continueProcessing |
Empty element |
Continue the connection processing |
ConnDataOpt - choice
Referenced by: cConnectionData
Enables connection created notify event Only one of the following elements:
|
|
|
created |
Created |
Enables connection created notify event |
callDelivery |
Empty element |
Enables call delivery notify event |
alerting |
Empty element |
Enables connection alerting notify event |
redirected |
Redirected |
Enables connection redirected notify event |
connected |
Connected |
Enables connection connected notify event |
transferred |
Transferred |
Enables connection transferred notify event |
disconnected |
Disconnected |
Enables connection disconnected notify event |
handoffLeave |
Empty element |
Enables connection handoff leave notify event |
handoffJoin |
HandoffJoin |
Enables connection handoff join notify event |
mediaForking |
MediaForkingEvent |
Updates media forking status |
MediaEventOpt - choice
Referenced by: cMediaEvent
DTMF detected Only one of the following elements:
Xcc Enumerated Elements
This section describes the enumerated elements that are found in the Xcc provider data types and Xcc provider messages.
eActivityState
Referenced by: MediaActivity
|
|
ACTIVE |
Active state |
INACTIVE |
Inactive state |
eAddrType
Referenced by: AddrData
|
|
E164 |
Address is e164 number format |
URI |
Address is URI string format |
OTHER |
Address in other formats |
eCallState
Referenced by: CallData
|
|
IDLE |
Initial state of a call. A call has zero connection |
ACTIVE |
A call has ongoing activity |
INVALID |
Final state of a call. A call in this state has one or more connections associated with |
eConnDirectionType
Referenced by: ConnDetailData
|
|
INCOMING |
Incoming connection |
OUTGOING |
Outgoing connection |
eConnectionEventsFilter
Referenced by: ConnectionEventsFilter
|
|
CREATED |
First event sent when a new connection is created |
AUTHORIZE_CALL |
Sent to request call authorization |
ADDRESS_ANALYZE |
Enables address analyze solicit event |
REDIRECTED |
Enables connection redirected notify event |
ALERTING |
Enables connection alerting notify event |
CONNECTED |
Enables connection connected notify event |
TRANSFERRED |
Enables connection transferred notify event |
CALL_DELIVERY |
Enables connection call delivery notify event |
DISCONNECTED |
Enables connection disconnected notify event |
HANDOFFLEAVE |
Enables connection handoff leave notify event |
HANDOFFJOIN |
Enables connection handoff join notify event |
eConnIntfType
Referenced by: ConnDetailData
|
|
CONN_UNKNOWN |
Unknown connection interface type |
CONN_ANALOG_EM |
Analog E n M port |
CONN_ANALOG_FXO |
Analog FXO port |
CONN_ANALOG_FXS |
Analog FXS port |
CONN_ANALOG_EFXS |
Analog eFXS port |
CONN_ANALOG_EFXO |
Analog eFXO port |
CONN_ISDN |
ISDN PRI interface |
CONN_CAS |
CAS interfacee |
CONN_BRI |
ISDN BRI interface |
CONN_R2 |
E1 R2 interface |
CONN_H323 |
H.323 interface |
CONN_SIP |
SIP interface |
CONN_TRUNKGROUP |
Trunk group |
eConnState
Referenced by: ConnData
|
|
IDLE |
Connection is idle state |
AUTHORIZE_CALL_ATTEMPT |
Connection is in authorize call attempt |
ADDRESS_COLLECT |
Connection is in collecting address state |
ADDRESS_ANALYZE |
Connection is pending for address analyze state |
CALL_DELIVERY |
Connection is in call delivery state |
ALERTING |
Connection is in alerting state |
CONNECTED |
Connection is in connected state |
DISCONNECTED |
Enables connection disconnected notify event |
eCountryType
Referenced by: MediaAddrData
|
|
COUNTRY_USA |
United States |
COUNTRY_AUSTRALIA |
Australia |
COUNTRY_GERMANY |
Germany |
COUNTRY_RUSSIA |
Russia |
COUNTRY_SPAIN |
Spain |
COUNTRY_SWITZERLAND |
Switzerland |
eMediaEventsFilter
Referenced by: MediaEventsFilterMediaEventsFilter
|
|
DTMF |
Enables inband dtmf detection |
MEDIA_ACTIVITY |
Enables media activity detection |
MODE_CHANGE |
Enables mode change notify when a mode of a call session has changed |
TONE_BUSY |
Enables busy tone detection |
TONE_DIAL |
Enables dialtone detection |
TONE_OUT_OF_SERVICE |
Enable out of service tone detection |
TONE_RINGBACK |
Enables ringback detection |
TONE_SECOND_DIAL |
Enables secondary dialtone detection |
eMediaForkingState
Referenced by: MediaForkingEvent
|
|
FORK_STARTED |
Media forking setup success |
FORK_FAILED |
Media forking setup failure |
FORK_DONE |
Media forking completed |
eMediaType
Referenced by: MediaData, ModeChange
|
|
VOICE |
Voice call |
FAX |
Fax call |
MODEM |
Modem call |
VIDEO |
Video call |
DATA |
Data call |
eToneType
Referenced by: Tone
|
|
TONE_BUSY |
busy tone detected |
TONE_DIAL |
dialtone detected |
TONE_RINGBACK |
ringback detected |
TONE_SECOND_DIAL |
secondary dialtone detected |
TONE_OUT_OF_SERVICE |
out of service detected |
XSVC
Xsvc Provider Operations
The XSVC provider monitors the trunk status, and provides real-time notification of link status and configuration change to application.
NotifyXsvcRouteConfiguration
NotifyXsvcRouteStatus
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
routeList |
RouteList |
M |
Compact form of route information |
RequestXsvcRouteData
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
routeName |
string |
M |
Route name |
routeType |
eRouteType |
M |
Route type |
RequestXsvcRouteSetFilter
RequestXsvcRouteSnapshot
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
RequestXsvcRouteStats
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
routeName |
string |
M |
Route name |
routeType |
eRouteType |
M |
Route type |
RequestXsvcUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXsvcProbing
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
sequence |
int |
M |
Sequence number of the probing messages |
ResponseXsvcProviderUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXsvcRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
providerStatus |
eProviderStatus |
M |
Current providerstatus |
ResponseXsvcRouteData
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
routeList |
RouteList |
M |
Compact form of route information |
ResponseXsvcRouteSetFilter
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXsvcRouteSnapshot
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
routeList |
RouteList |
M |
Compact form of route information |
ResponseXsvcRouteStats
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
routeList |
RouteList |
M |
Compact form of route information |
ResponseXsvcUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
SolicitXsvcProbing
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
sequence |
int |
M |
Sequence number of the probing message |
interval |
duration |
M |
Interval between probing messages |
failureCount |
int |
M |
Counts on previous probing failures since last successful message exchange in this reigstration session |
registered |
boolean |
M |
Registration status |
providerStatus |
eProviderStatus |
M |
Provider current status |
SolicitXsvcProviderUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
Xsvc Message Data Types
This section describes the data types and elements that are found in the Xsvc Provider messages.
Xsvc Composite Data Type
The following section describes the composite data structures defined within the Xsvc Provider.
CurrentStatistics
Referenced by: IntfStatisticsData
|
|
|
|
elapsedTime |
duration |
M |
The time have elapsed since the beginning of the far end current error-measurement period |
LCV |
int |
M |
Line Coding Violation Error Event |
PCV |
int |
M |
Path Coding Violation Error Event |
CSS |
int |
M |
Controlled Slip Seconds |
SEFS |
int |
M |
Severely Errored Framing Second |
LES |
int |
M |
Line Errored Seconds |
DM |
int |
M |
Degraded Minutes |
ES |
int |
M |
Errored Seconds |
BES |
int |
M |
Bursty Errored Seconds |
SES |
int |
M |
everely Errored Seconds |
UAS |
int |
M |
Unavailable Seconds |
IntfChannels
Referenced by: TrunkData
|
|
|
|
channels |
string |
O |
Channel mapping of the interface |
totalChannels |
int |
M |
Total channels on the interface |
TotalStatistics
Referenced by: IntfStatisticsData
|
|
|
|
intervalTime |
duration |
M |
The time of previous far end intervals for which data was collected |
LCV |
int |
M |
Line Coding Violation Error Event |
PCV |
int |
M |
Path Coding Violation Error Event |
CSS |
int |
M |
Controlled Slip Seconds |
SEFS |
int |
M |
Severely Errored Framing Second |
LES |
int |
M |
Line Errored Seconds |
DM |
int |
M |
Degraded Minutes |
ES |
int |
M |
Errored Seconds |
BES |
int |
M |
Bursty Errored Seconds |
SES |
int |
M |
everely Errored Seconds |
UAS |
int |
M |
Unavailable Seconds |
TrunkData
Referenced by: TrunkList
List of one or more connection events
Xsvc Enumerated Elements
This section describes the enumerated elements that are found in the Xsvc provider data types and Xsvc provider messages.
eRouteEventsFilter
Referenced by: RouteEventsFilter
|
|
ROUTE_CONF_UPDATED |
Enables route configuration updated notify event |
ROUTE_STATUS_UPDATED |
Enables route status updated notify event) |
eTrunkAlarm
Referenced by: TrunkData
|
|
NoAlarm |
No alarm present |
RcvFarEndLOF |
Far end LOF (a.k.a. Yellow Alarm) |
XmtFarEndLOF |
Near end sending LOF Indication |
RcvAIS |
Far end sending AIS |
XmtAIS |
Near end sending AIS |
LossOfFrame |
Near end LOF (a.k.a. Red Alarm) |
LossOfSignal |
Near end loss Of Signal |
LoopbackState |
Near end is looped |
T16AIS |
E1 TS16 AIS |
RcvFarEndOLMF |
Far End Send TS16 LOMF |
XmtFarEndOLMF |
Near End Send TS16 LOMF |
RcvTestCode |
Near End detects a test code |
OtherFailure |
any line status not defined here |
UnavailSigState |
Near End in Unavailable Signal State |
NetEquipOOS |
Carrier Equipment Our Of Service |
RcvPayloadAIS |
DS2 Payload AIS |
Ds2PerfThreshold |
DS2 Performance Threshold |
eTrunkType
Referenced by: TrunkData
|
|
ISDN_PRI |
- |
ISDN_BRI |
- |
ANALOG |
- |
CAS |
- |
SIPV2 |
- |
H323 |
- |
XMF
Xmf Provider Operations
The XMF (Extended Media Forking) provider supports operations that allow a client application to perform media forking and real-time call monitoring.
NotifyXmfCallData
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callData |
CallData |
M |
call information |
mediaEvent |
cMediaEvent |
M |
Choice of media event |
RequestXmfCallMediaForking
RequestXmfCallMediaSetAttributes
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callID |
string |
M |
Call Identification |
mediaEventsFilter |
MediaEventsFilter |
O |
Enables media event types to be sent to application. Turn off any media events if this element is not included in the request |
mediaForking |
MediaForkingData |
O |
Media forkig data |
RequestXmfConnectionMediaForking
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
callID |
string |
M |
Call Identification |
connID |
string |
M |
Connection Identification |
action |
cCallMediaForking |
M |
Media forking action choice |
RequestXmfControlUpdate
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
connectionEventsFilter |
ConnectionEventsFilter |
O |
List of events that shall be notified to application |
mediaEventsFilter |
MediaEventsFilter |
O |
List of media events that shall be notfied to application |
RequestXmfUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXmfCallMediaForking
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXmfCallMediaSetAttributes
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXmfConnectionMediaForking
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXmfControlUpdate
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXmfProbing
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
sequence |
int |
M |
Sequence number of the probing messages |
ResponseXmfProviderUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
ResponseXmfRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
providerStatus |
eProviderStatus |
M |
Current provider status |
ResponseXmfUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header the messages |
SolicitXmfProbing
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
sequence |
int |
M |
Sequence number of the probing message |
interval |
duration |
M |
Interval between probing messages |
failureCount |
int |
M |
Counts on previous probing failures since last successful message exchange in this reigstration session |
registered |
boolean |
M |
Registration status |
providerStatus |
eProviderStatus |
M |
Provider current status |
SolicitXmfProviderUnRegister
|
|
|
|
msgHeader |
MsgHeader |
M |
Message header common for all the messages |
Xmf Message Data Types
This section describes the data types and elements that are found in the Xmf Provider messages.
Xmf Composite Data Type
The following section describes the composite data structures defined within the Xmf Provider.
Alerting
(This is an empty element)
CallDelivery
(This is an empty element)
ConnDetailData
Referenced by: Connected , Created, HandoffJoin
|
|
|
|
connData |
ConnData |
M |
Connection information |
guid |
string |
M |
Connection guid data |
guidAltFormat |
string |
O |
Connection guid data represented in Alternate format |
callingAddrData |
AddrData |
O |
Calling party address data |
origCallingAddrData |
AddrData |
O |
orignal calling party address data |
calledAddrData |
AddrData |
O |
Called party address data |
origCalledAddrData |
AddrData |
O |
original called party address data |
redirectAddrData |
RedirectAddrData |
O |
Redirect party address data |
connIntfType |
eConnIntfType |
O |
Connection interface type |
mediaData |
MediaData |
O |
Connection media data |
connIntf |
string |
O |
Connection interface name string |
connDirectionType |
eConnDirectionType |
M |
Connection direction type |
routeName |
string |
O |
Connection interface route name string |
routeDescription |
string |
O |
Route description |
DisableMediaForking
(This is an empty element)
Disconnected
|
|
|
|
mediaData |
MediaData |
M |
Connection media data |
discCause |
int |
M |
Q.850 disconnect cause range [1 - 188] |
statsData |
StatsData |
O |
statistics data |
jitterData |
JitterData |
O |
media jitter data |
DTMF
|
|
|
|
digit |
string |
M |
a dtmf digit |
dateTime |
string |
M |
Time when dtmf occurs |
HandoffLeave
(This is an empty element)
JitterData
Referenced by: Disconnected
|
|
|
|
roundTripDelayMSec |
int |
M |
Round trip delay (in ms) |
onTimeRvPlayMSec |
int |
M |
On time Rv Play (in ms) |
gapFillWithPredictionMSec |
int |
M |
Prediction count (in ms) |
gapFillWithInterpolationMSec |
int |
M |
Interpolation count (in ms) |
gapFillWithRedundancyMSec |
int |
M |
Redundancy count (in ms) |
lostPacketsCount |
int |
M |
Lost packets count |
earlyPacketsCount |
int |
M |
Early packets count |
latePacketsCount |
int |
M |
Late packets count |
receiveDelayMSec |
int |
M |
Receive delay (in ms) |
loWaterPlayoutDelayMSec |
int |
M |
Low water playout delay (in ms) |
hiWaterPlayoutDelayMSec |
int |
M |
Hi water playout delay (in ms) |
StatsData
Referenced by: Disconnected
|
|
|
|
callDuration |
duration |
M |
call duration |
TxPacketsCount |
int |
M |
Total Tx Packets |
TxBytesCount |
int |
M |
Total Tx Bytes |
TxDurationMSec |
int |
M |
Tx Duration in milliseconds |
TxVoiceDurationMSec |
int |
M |
Tx Voice Duration in milliseconds |
RxPacketsCount |
int |
M |
Total Rx Packets |
RxBytesCount |
int |
M |
Total Rx Bytes |
RxDurationMSec |
int |
M |
Rx Duration in milliseconds |
RxVoiceDurationMSec |
int |
M |
Rx Voice Duration in milliseconds |
Xmf Choice Elements
Choice records - may contain only one field at a time
CallMediaForkingOpt - choice
Referenced by: cCallMediaForking
Enable media forking Only one of the following elements:
|
|
|
enableMediaForking |
MediaForkingData |
Enable media forking |
disableMediaForking |
Empty element |
Disable media forking |
ConnDataOpt - choice
Referenced by: cConnectionData
Enables connection created notify event Only one of the following elements:
|
|
|
created |
Created |
Enables connection created notify event |
callDelivery |
Empty element |
Enables call delivery notify event |
alerting |
Empty element |
Enables connection alerting notify event |
redirected |
Redirected |
Enables connection redirected notify event |
connected |
Connected |
Enables connection connected notify event |
transferred |
Transferred |
Enables connection transferred notify event |
disconnected |
Disconnected |
Enables connection disconnected notify event |
handoffLeave |
Empty element |
Enables connection handoff leave notify event |
handoffJoin |
HandoffJoin |
Enables connection handoff join notify event |
mediaForking |
MediaForkingEvent |
Updates media forking status |
MediaEventOpt - choice
Referenced by: cMediaEvent
DTMF detected Only one of the following elements:
Xmf Enumerated Elements
This section describes the enumerated elements that are found in the Xmf provider data types and Xmf provider messages.
eActivityState
Referenced by: MediaActivity
|
|
ACTIVE |
Active state |
INACTIVE |
Inactive state |
eAddrType
Referenced by: AddrData
|
|
E164 |
Address is e164 number format |
URI |
Address is URI string format |
OTHER |
Address in other formats |
eCallState
Referenced by: CallData
|
|
IDLE |
Initial state of a call. A call has zero connection |
ACTIVE |
A call has ongoing activity |
INVALID |
Final state of a call. A call in this state has one or more connections associated with |
eConnDirectionType
Referenced by: ConnDetailData
|
|
INCOMING |
Incoming connection |
OUTGOING |
Outgoing connection |
eConnectionEventsFilter
Referenced by: ConnectionEventsFilter
|
|
CREATED |
First event sent when a new connection is created |
REDIRECTED |
Enables connection redirected notify event |
ALERTING |
Enables connection alerting notify event |
CONNECTED |
Enables connection connected notify event |
TRANSFERRED |
Enables connection transferred notify event |
CALL_DELIVERY |
Enables connection call delivery notify event |
DISCONNECTED |
Enables connection disconnected notify event |
HANDOFFLEAVE |
Enables connection handoff leave notify event |
HANDOFFJOIN |
Enables connection handoff join notify event |
eConnIntfType
Referenced by: ConnDetailData
|
|
CONN_UNKNOWN |
Unknown connection interface type |
CONN_ANALOG_EM |
Analog E n M port |
CONN_ANALOG_FXO |
Analog FXO port |
CONN_ANALOG_FXS |
Analog FXS port |
CONN_ANALOG_EFXS |
Analog eFXS port |
CONN_ANALOG_EFXO |
Analog eFXO port |
CONN_ISDN |
ISDN PRI interface |
CONN_CAS |
CAS interfacee |
CONN_BRI |
ISDN BRI interface |
CONN_R2 |
E1 R2 interface |
CONN_H323 |
H.323 interface |
CONN_SIP |
SIP interface |
CONN_TRUNKGROUP |
Trunk group |
eConnState
Referenced by: ConnData
|
|
IDLE |
Connection is idle state |
AUTHORIZE_CALL_ATTEMPT |
Connection is in authorize call attempt |
ADDRESS_COLLECT |
Connection is in collecting address state |
ADDRESS_ANALYZE |
Connection is pending for address analyze state |
CALL_DELIVERY |
Connection is in call delivery state |
ALERTING |
Connection is in alerting state |
CONNECTED |
Connection is in connected state |
DISCONNECTED |
Enables connection disconnected notify event |
eCountryType
Referenced by: MediaAddrData
|
|
COUNTRY_USA |
United States |
COUNTRY_AUSTRALIA |
Australia |
COUNTRY_GERMANY |
Germany |
COUNTRY_RUSSIA |
Russia |
COUNTRY_SPAIN |
Spain |
COUNTRY_SWITZERLAND |
Switzerland |
eMediaEventsFilter
Referenced by: MediaEventsFilter
|
|
DTMF |
Enables inband dtmf detection |
MEDIA_ACTIVITY |
Enables media activity detection |
MODE_CHANGE |
Enables mode change notify when a mode of a call session has changed |
TONE_BUSY |
Enables busy tone detection |
TONE_DIAL |
Enables dialtone detection |
TONE_OUT_OF_SERVICE |
Enable out of service tone detection |
TONE_RINGBACK |
Enables ringback detection |
TONE_SECOND_DIAL |
Enables secondary dialtone detection |
eMediaForkingState
Referenced by: MediaForkingEvent
|
|
FORK_STARTED |
Media forking setup success |
FORK_FAILED |
Media forking setup failure |
FORK_DONE |
Media forking completed |
eMediaType
Referenced by: MediaData, ModeChange
|
|
VOICE |
Voice call |
FAX |
Fax call |
MODEM |
Modem call |
VIDEO |
Video call |
DATA |
Data call |
eToneType
Referenced by: Tone
|
|
TONE_BUSY |
busy tone detected |
TONE_DIAL |
dialtone detected |
TONE_RINGBACK |
ringback detected |
TONE_SECOND_DIAL |
secondary dialtone detected |
TONE_OUT_OF_SERVICE |
out of service detected |
Common Message Data Types
This section describes the data types and elements that are found in the Common Module messages.
Common Composite Data Type
The following section describes the composite data structures defined within the Common Module.
ApplicationData
|
|
|
|
url |
anyURI |
M |
Application url data |
name |
string |
O |
Application name |
MsgHeader
|
|
|
|
transactionID |
string |
O |
ID to identify a transaction for the message excahnge between provider and application. This filed is optional. This field is mandatory for the response message to return the same transactionID if present in the request/solicit message. |
registrationID |
string |
O |
ID to identify a registration session. This field is absent for RequestRegister and NotifyStatus messages. This field is mandatory for all the other messages. |
ProviderData
|
|
|
|
url |
anyURI |
M |
url for client application |
Common Enumerated Elements
This section describes the enumerated elements that are found in the Common Module data types.
eProviderStatus
|
|
SHUTDOWN |
Service is not running |
IN_SERVICE |
Service is enabled and running |