The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Indicates the call for which the one way media path is setup. This is
always the same value passed in as the CallId action parameter.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine. This field will only be populated if the partition of the script
instance is configured to Reserve Media Early.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all subsequent
Media Control API operations. Before using with most Media Control
actions, this connection must still be fully connected with
CreateConnection or by answering the call. This field will only be
populated if the partition of the script instance is configured to
Reserve Media Early.
mediaRxIP
java.lang.String mediaRxIP
The IP address that the Rx RTP stream must be sent to for this
connection. This field will only be populated if the partition of the
script instance is configured to Reserve Media Early.
mediaRxPort
java.lang.Long mediaRxPort
The IP address that the Rx RTP stream must be sent to for this
connection. This field will only be populated if the partition of the
script instance is configured to Reserve Media Early.
failReason
java.lang.String failReason
Indicates the reason for failure of the execution of this API. Valid
values are as follows:
NoFail - Indicates that the API call is successful.
RemoteMediaNotAvailable - Indicates that media information of the
remote side is not available and so could not setup
media session from the media engine. The call may not
need to be terminated for this condition and it can be
followed by AnswerCall, RejectCall, etc.
EarlyMediaNotSet - Indicates that Reserve Media Early is not set to
true on the partition of the script instance and so
media session would not be setup. The call may not need
to be terminated for this condition and it can be
followed by AnswerCall, RejectCall, etc.
InternalError - Indicates that API execution failed due to some error
conditions and the call should be terminated.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Indicates the call that was accepted. This is always the same value
passed in as the CallId action parameter.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine. This field will only be populated if the partition of the script
instance is configured to Reserve Media Early.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all subsequent
Media Control API operations. Before using with most Media Control
actions, this connection must still be fully connected with
CreateConnection or by answering the call. This field will only be
populated if the partition of the script instance is configured to
Reserve Media Early.
mediaRxIP
java.lang.String mediaRxIP
The IP address that the Rx RTP stream must be sent to for this
connection. This field will only be populated if the partition of the
script instance is configured to Reserve Media Early.
mediaRxPort
java.lang.Long mediaRxPort
The IP address that the Rx RTP stream must be sent to for this
connection. This field will only be populated if the partition of the
script instance is configured to Reserve Media Early.
The ID of the media engine to create the connection on. If no MmsId is
specified when using AnswerCall, a media engine with the most available
resources is dynamically selected from the Media Resource Group associated
with the partition of the script instance from which AnswerCall is invoked.
proxyDTMFCallId
java.lang.String proxyDTMFCallId
The CallId to establish a proxy relationship with. Any digits received on
one call leg will be proxied to the other.
Indicates what degree of media negotiation must be established before the
call is considered answered. An answered call results in the successful
completion of the AnswerCall action. Valid values are as follows:
None - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is
answered, regardless of the state of media negotiation.
Tx - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is answered
and the remote endpoint has specified the properties of the audio
stream that it wants transmitted to it.
Rx - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is answered
and the application server has specified the properties of the audio
stream that it wants transmitted to the media engine.
TxRx - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is
answered, the remote endpoint has specified the properties of the
audio stream that it wants transmitted to it, and the application
server has specified the properties of the audio stream that it
wants transmitted to the media engine.
. Note that depending on the value chosen, the result data parameters
relating to the negotiated media information may not be valid yet because
the media negotiation may not yet be completed.
conference
java.lang.Boolean conference
Indicates that this call is to be placed in a conference. If a ConferenceId
is not specified or is set to 0, then a new conference is created on the
media engine and the ConferenceId is the unique identifier for that new
conference (assuming WaitForMedia is the default TxRx). If a ConferenceId
is specified, then the connection created for this call is moved into the
existing conference as soon as the media channels for the call have been
fully established.
conferenceId
java.lang.String conferenceId
The ConferenceId of the conference to add this call to. Specify no value or
0 if this is to be a new conference. This field is ignored if Conference is
false.
hairpin
java.lang.Boolean hairpin
Indicates that the new conference should be optimized for two parties. A
hairpinned conference does not use any conference resources. However, a
hairpin conference will be 'promoted', or converted to a true media
conference, if a 3rd participant is added to the conference or if a voice
operation is performed on the conference itself. In either case, this will
cause each participant and conferenced voice operation to use one
conference resource. True conferences also have a slightly increased
latency over a hairpinned conference.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Indicates the call that was accepted. This is always the same value
passed in as the CallId action parameter.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all subsequent
Media Control API operations. This connection may not be fully connected,
and therefore not ready to use in most Media Control API by the time it
is returned to the script if WaitForMedia is not the default TxRx.
conferenceId
java.lang.String conferenceId
Unique identifier for the conference that this connection was placed in.
This field is valid only if Conference was specified as true in the
action. In the case that Conference was set to true, and if the
ConferenceId action parameter was specified, this event parameter will be
that same value. If the ConferenceId action parameter was not specified,
then this will be a new ID for the new conference.
mediaTxIP
java.lang.String mediaTxIP
The IP address that the media engine connection should send audio to.
This field can only be relied on if WaitForMedia has been set to a value
of Tx or TxRx. However, regardless if this field is available as a result
data parameter, the application server will associate the correct value
for this parameter to the connection created for this call when it
becomes available at the protocol layer.
mediaTxPort
java.lang.Long mediaTxPort
The port that the media engine connection should send audio to. This
field can only be relied on if WaitForMedia has been set to a value of Tx
or TxRx. However, regardless if this field is available as a result data
parameter, the application server will associate the correct value for
this parameter to the connection created for this call when it becomes
available at the protocol layer.
mediaTxCodec
java.lang.String mediaTxCodec
The codec that the media engine connection should use when sending audio.
This field can only be relied on if WaitForMedia has been set to a value
of Tx or TxRx. However, regardless if this field is available as a result
data parameter, the application server will associate the correct value
for this parameter to the connection created for this call when it
becomes available at the protocol layer.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize that the media engine connection should use when sending
audio. This field can only be relied on if WaitForMedia has been set to a
value of Tx or TxRx. However, regardless if this field is available as a
result data parameter, the application server will associate the correct
value for this parameter to the connection created for this call when it
becomes available at the protocol layer.
mediaRxIP
java.lang.String mediaRxIP
The IP address chosen by the application server for the Rx RTP stream for
this connection. This field can only be relied on if WaitForMedia has
been set to a value of Rx or TxRx. However, regardless if this field is
available as a result data parameter, the application server will
associate the correct value for this parameter to the connection created
for this call when it becomes available at the protocol layer.
mediaRxPort
java.lang.Long mediaRxPort
The port chosen by the application server for the Rx RTP stream for this
connection. This field can only be relied on if WaitForMedia has been set
to a value of Rx or TxRx. However, regardless if this field is available
as a result data parameter, the application server will associate the
correct value for this parameter to the connection created for this call
when it becomes available at the protocol layer.
mediaRxCodec
java.lang.String mediaRxCodec
The codec chosen by the application server for the Rx RTP stream for this
connection. This field can only be relied on if WaitForMedia has been set
to a value of Rx or TxRx. However, regardless if this field is available
as a result data parameter, the application server will associate the
correct value for this parameter to the connection created for this call
when it becomes available at the protocol layer.
mediaRxFramesize
java.lang.Long mediaRxFramesize
The framesize chosen by the application server for the Rx RTP stream for
this connection. This field can only be relied on if WaitForMedia has
been set to a value of Rx or TxRx. However, regardless if this field is
available as a result data parameter, the application server will
associate the correct value for this parameter to the connection created
for this call when it becomes available at the protocol layer.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Unique identifier used to identify this call in all subsequent Call
Control operations.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all subsequent
Media Control API operations. A value is returned only if MediaRxIP and
MediaRxPort were not specified.
mediaTxIP
java.lang.String mediaTxIP
The IP address that the barging in party should send audio to. If a
connection was created by this action, this value is already associated
with that connection.
mediaTxPort
java.lang.Long mediaTxPort
The port that the barging in party should send audio to. If a connection
was created by this action, this value is already associated with that
connection.
mediaTxCodec
java.lang.String mediaTxCodec
The codec that the barging in party should use. If a connection was
created by this action, this value is already associated with that
connection.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize that the barging in party should use. If a connection was
created by this action, this value is already associated with that
connection.
mediaRxIP
java.lang.String mediaRxIP
Unique identifier used to identify this connection in all subsequent
Media Control API operations. A value is returned only if MediaRxIP and
MediaRxPort were not specified.
mediaRxPort
java.lang.Long mediaRxPort
The IP address that the Rx RTP stream must be sent to for this
connection. A value is returned only if MediaRxIP and MediaRxPort were
not specified.
mediaRxCodec
java.lang.String mediaRxCodec
The codec that the Rx RTP stream is using for this connection.
mediaRxFramesize
java.lang.Long mediaRxFramesize
The framesize that the Rx RTP stream is using for this connection.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Unique identifier used to identify the media engine in control of both
connections. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with these two connections are all
created on the same media engine. This correlation is necessary because
all connections in a single conference must all reside on the same media
engine.
connectionId
java.lang.String connectionId
Unique identifier used to identify the connection created for the call
specified in the CallId action parameter. All subsequent Media Control
API operations can use this connection.
peerConnectionId
java.lang.String peerConnectionId
Unique identifier used to identify the connection created for the other
call leg than that specified by the CallId action parameter. All
subsequent Media Control API operations can use this connection.
conferenceId
java.lang.String conferenceId
The ConferenceID of the conference created for these two connections.
mediaRxIP
java.lang.String mediaRxIP
The IP address chosen by the application server for the Rx RTP stream for
the ConnectionId result data parameter.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Indicates the call for which remote media inforamtion is retrieved. This
is always the same value passed in as the CallId action parameter.
mediaTxIP
java.lang.String mediaTxIP
The IP address that the media engine connection should send audio to.
This field can only be relied on if WaitForMedia has been set to a value
of Tx or TxRx. However, regardless if this field is available as a result
data parameter, the application server will associate the correct value
for this parameter to the connection created for this call when it
becomes available at the protocol layer.
mediaTxPort
java.lang.Long mediaTxPort
The port that the media engine connection should send audio to. This
field can only be relied on if WaitForMedia has been set to a value of Tx
or TxRx. However, regardless if this field is available as a result data
parameter, the application server will associate the correct value for
this parameter to the connection created for this call when it becomes
available at the protocol layer.
mediaTxCodec
java.lang.String mediaTxCodec
The codec that the media engine connection should use when sending audio.
This field can only be relied on if WaitForMedia has been set to a value
of Tx or TxRx. However, regardless if this field is available as a result
data parameter, the application server will associate the correct value
for this parameter to the connection created for this call when it
becomes available at the protocol layer.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize that the media engine connection should use when sending
audio. This field can only be relied on if WaitForMedia has been set to a
value of Tx or TxRx. However, regardless if this field is available as a
result data parameter, the application server will associate the correct
value for this parameter to the connection created for this call when it
becomes available at the protocol layer.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Unique identifier used to identify this call leg in all subsequent Call
Control API operations, such as RejectCall, AnswerCall, Redirect, or
AcceptCall.
from
java.lang.String from
The calling party number for this call.
to
java.lang.String to
The called number for this call. This number may not correspond to the
number the remote endpoint initially dialed.
originalTo
java.lang.String originalTo
The original number which was dialed. This will be the same as the To field
unless the call has been redirected, transferred, or translated while being
routed.
displayName
java.lang.String displayName
The caller's friendly name.
stackToken
java.lang.String stackToken
The ID of the call used by underlying protocol stack
partition
java.lang.String partition
Name of the partition from which the event is triggered.
The ID of the media engine to create the connection on. If no MmsId is
specified when using MakeCall, a media engine with the most available
resources is dynamically selected from the Media Resource Group associated
with the partition of the script instance from which MakeCall is invoked.
peerCallId
java.lang.String peerCallId
The CallId of an unanswered incoming call that has triggered a script
instance via the IncomingCall event. Once the call placed by this MakeCall
is completed, the call specified by this action parameter is automatically
answered by the application server and the media streams are established in
a peer-to-peer relationship.
proxyDTMFCallId
java.lang.String proxyDTMFCallId
The CallId to establish a proxy relationship with. Any digits received on
one call leg will be proxied to the other. If ProxyDTMFCallId is not set
and PeerCallId is, then the call specified by PeerCallId will be used for
this action parameter.
Indicates what degree of media negotiation must be established before the
call is considered completed. A completed call results in the
MakeCall_Complete event being fired. Valid values are as follows:
None - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is
answered, regardless of the state of media negotiation.
Tx - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is answered
and the remote endpoint has specified the properties of the audio
stream that it wants transmitted to it.
Rx - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is answered
and the application server has specified the properties of the audio
stream that it wants transmitted to the media engine.
TxRx - Indicates that the call should be considered completed as soon as
the call control signaling has indicated that the call is
answered, the remote endpoint has specified the properties of the
audio stream that it wants transmitted to it, and the application
server has specified the properties of the audio stream that it
wants transmitted to the media engine.
Note that depending on the value chosen, MakeCall_Complete event parameters
relating to the negotiated media information may not be valid yet because
the media negotiation may not yet be completed.
conference
java.lang.Boolean conference
Indicates that this call is to be placed in a conference. If a ConferenceId
is not specified or is set to 0, then a new conference is created on the
media engine and the ConferenceId in the MakeCall_Complete event is the
unique identifier for that new conference (assuming WaitForMedia is the
default TxRx). If a ConferenceId is specified, then the connection created
for this call is moved into the existing conference as soon as the media
channels for the call have been fully established.
conferenceId
java.lang.String conferenceId
The ConferenceId of the conference to add this call to. Specify no value or
0 if this is to be a new conference. This field is ignored if Conference is
false.
hairpin
java.lang.Boolean hairpin
Indicates that the new conference should be optimized for two parties. A
hairpinned conference does not use any conference resources. However, a
hairpin conference will be 'promoted', or converted to a true media
conference, if a 3rd participant is added to the conference or if a voice
operation is performed on the conference itself. In either case, this will
cause each participant and conferenced voice operation to use one
conference resource. True conferences also have a slightly increased
latency over a hairpinned conference.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Unique identifier used to identify this call in all subsequent Call
Control API operations. This is the same value that will be returned as
the event parameter CallId in the MakeCall_Complete event or in the
MakeCall_Failed event.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine. This event parameter will not be populated if the call is in a
peer-to-peer relationship.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
to
java.lang.String to
The final called number for this call. If the call was redirected,
transferred, or otherwise translated during call routing, this field should
reflect the final called number.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
from
java.lang.String from
The calling number, or caller ID, for this call.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
originalTo
java.lang.String originalTo
The originally dialed number for this call.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all subsequent Media
Control API operations. This connection may not be fully connected, and
therefore not ready to use in most Media Control API by the time it is
returned to the script if WaitForMedia is not the default TxRx. This event
parameter will not be populated if the call is in a peer-to-peer
relationship.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
conferenceId
java.lang.String conferenceId
Unique identifier for the conference that this connection was placed in.
This field is valid only if Conference was specified as true in the action.
In the case that Conference was set to true and the ConferenceId action
parameter was specified, this event parameter will be that same value. If
the ConferenceId action parameter was not specified, then this will be a
new ID for the new conference.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
mediaTxIP
java.lang.String mediaTxIP
The IP address that the media engine connection should send audio to. This
field can only be relied on if WaitForMedia has been set to a value of Tx
or TxRx. However, regardless if this field is available as an event
parameter, the application server will associate the correct value for this
parameter to the connection created for this call when it becomes available
at the protocol layer.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
mediaTxPort
java.lang.Long mediaTxPort
The port that the media engine connection should send audio to. This field
can only be relied on if WaitForMedia has been set to a value of Tx or
TxRx. However, regardless if this field is available as an event parameter,
the application server will associate the correct value for this parameter
to the connection created for this call when it becomes available at the
protocol layer.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
mediaTxCodec
java.lang.String mediaTxCodec
The codec that the media engine connection should use when sending audio.
This field can only be relied on if WaitForMedia has been set to a value of
Tx or TxRx. However, regardless if this field is available as an event
parameter, the application server will associate the correct value for this
parameter to the connection created for this call when it becomes available
at the protocol layer.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize that the media engine connection should use when sending
audio. This field can only be relied on if WaitForMedia has been set to a
value of Tx or TxRx. However, regardless if this field is available as an
event parameter, the application server will associate the correct value
for this parameter to the connection created for this call when it becomes
available at the protocol layer.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".
endReason
java.lang.String endReason
The condition which caused the call leg to fail to complete. Note that the
underlying protocol puts inherent limitations on how well each EndReason is
supported. Possible values for EndReason are as follows:
Normal -
Ringout - Indicates that the call rang until a ring timeout was reached.
Busy - Indicates that the call could not be completed because the
destination is already engaged in a call.
Unreachable - Indicates that the specified To destination could not be
routed to.
InternalError - Indicates that the underlying protocol stack had a fatal
error that forced termination of the call.
Unknown - Indicates that the call was terminated for an unexpected or
unknown reason.
This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Failed".
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Unique identifier used to identify the call leg that was hung up by the
remote endpoint
endReason
java.lang.String endReason
The condition which caused the call leg to terminate. Note that the
underlying protocol puts inherent limitations on how well each EndReason is
supported. Possible values for EndReason are as follows:
Normal - .
Ringout - .
Busy - .
Unreachable - .
InternalError - .
Unknown - .
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
Unique identifier used to identify the call leg that the application server
has designated receive information for.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all Media Control
operations.
mediaRxIP
java.lang.String mediaRxIP
The IP address that the media engine should receive audio on. This value is
already associated with the connection associated with the call.
mediaRxPort
java.lang.Long mediaRxPort
The port that the media engine should receive audio on. This value is
already associated with the connection associated with the call.
mediaRxCodec
java.lang.String mediaRxCodec
The codec that the remote endpoint should use when sending audio to the
media engine. This value is already associated with the connection
associated with the call.
mediaRxFramesize
java.lang.Long mediaRxFramesize
The framesize that the remote endpoint should use when sending audio to the
media engine. This value is already associated with the connection
associated with the call.
Unique identifier used to identify the call leg that has received transmit
information from the remote endpoint.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine. This event parameter will not be populated if the call is in a
peer-to-peer relationship.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all Media Control API
operations. This event parameter will not be populated if the call is in a
peer-to-peer relationship.
mediaTxIP
java.lang.String mediaTxIP
The IP address that the application server should send audio to. If a
connection is associated with this call, this value is already associated
with that connection.
mediaTxPort
java.lang.Long mediaTxPort
The port that the application server should send audio to. If a connection
is associated with this call, this value is already associated with that
connection.
mediaTxCodec
java.lang.String mediaTxCodec
The codec that the application server should use when sending audio. If a
connection is associated with this call, this value is already associated
with that connection.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize that the application server should use when sending audio. If
a connection is associated with this call, this value is already associated
with that connection.
Unique identifier used to identify the call leg that received the command
to stop sending media.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine. This event parameter will not be populated if the call is in a
peer-to-peer relationship.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all Media Control API
operations. This event parameter will not be populated if the call is in a
peer-to-peer relationship.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is 'Timeout'. The value must be a literal
value in milliseconds.
The Type action parameter can be used to restrict the query to devices not
matching a particular type. Valid values are as follows:
Cisco7905
Cisco7912
Cisco7920
Cisco7940
Cisco7941
Cisco7941G
Cisco7960
Cisco7961G
Cisco7970
Cisco7971
IPCommunicator
name
java.lang.String name
The Name action parameter can be used to restrict the query to devices not
matching the specified name.
description
java.lang.String description
The Description action parameter can be used to restrict the query to
devices not matching the specified description.
searchSpace
java.lang.String searchSpace
The SearchSpace action parameter can be used to restrict the query to
devices with a configured CallingSearchSpace not matching the specified
value.
pool
java.lang.String pool
The Pool action parameter can be used to restrict the query to devices with
a configured Device Pool not matching the specified value.
iP
java.lang.String iP
The IP action parameter can be used to restrict the query to devices not
matching the specified IP address.
userName
java.lang.String userName
The UserName action parameter can be used to restrict the query to devices
not matching the specified UserName.
physicalAddress
java.lang.String physicalAddress
The PhysicalAddress action parameter can be used to restrict the query to
devices not matching the specified Physical(MAC) address.
extn
java.lang.String extn
The Extn action parameter can be used to restrict the query to devices not
matching the specified Extension.
extnInetAddress
java.lang.String extnInetAddress
The ExtnInetAddress action parameter can be used to restrict the query to
devices not matching the specified Extn Inet Address.
The Status action parameter can used to restrict the query to devices not
matching the specified status value. Note that in Cisco Unified
Communications Manager 5.x/6.x, only Registered and FoundAndUnregistered
devices are returned so this field has less value for those versions since
NotFound is not supported.
NotFound - The device is configured in the Cisco Unified Communications
Manager database, but is not registered or connected in any
way.
Registered - The device is registered to the Cisco Unified Communications
Manager. Only for this status should one expect a valid
value for the IP address of the device.
FoundAndUnregistered - The device is or recently was connected to the
Cisco Unified Communications Manager, but is not
registered.
callManagerIP
java.lang.String callManagerIP
The CallManagerIP action parameter can be used to restrict the query to
devices not matching the specified Cisco Unified Communications Manager
publisher IP address.
A .NET System.Data.DataTable that contains rows and columns corresponding
to the devices and attributes returned for the query.
Info: The original type 'System.Data.DataTable' is replaced by etchType 'DeviceListData'.
The Type action parameter can be used to restrict the query to only devices
of a particular type. Valid values are as follows:
Cisco7905
Cisco7912
Cisco7920
Cisco7940
Cisco7941
Cisco7941G
Cisco7960
Cisco7961G
Cisco7970
Cisco7971
IPCommunicator
name
java.lang.String name
The Name action parameter can be used to restrict the query to devices
matching the specified name.
description
java.lang.String description
The Description action parameter can be used to restrict the query to
devices matching the specified description.
searchSpace
java.lang.String searchSpace
The SearchSpace action parameter can be used to restrict the query to
devices with a configured CallingSearchSpace matching the specified value.
pool
java.lang.String pool
The Pool action parameter can be used to restrict the query to devices with
a configured Device Pool matching the specified value.
iP
java.lang.String iP
The IP action parameter can be used to restrict the query to devices
matching the specified IP address.
userName
java.lang.String userName
The UserName action parameter can be used to restrict the query to devices
matching the specified UserName.
physicalAddress
java.lang.String physicalAddress
The PhysicalAddress action parameter can be used to restrict the query to
devices matching the specified Physical Address.
extn
java.lang.String extn
The Extn action parameter can be used to restrict the query to devices
matching the specified Extension.
extnInetAddress
java.lang.String extnInetAddress
The ExtnInetAddress action parameter can be used to restrict the query to
devices matching the specified Extn InetAddress.
The Status action parameter can used to restrict the query to devices
matching the specified status value. Note that in Cisco Unified
Communications Manager 5.x/6.x, only Registered and FoundAndUnregistered
devices are returned so this field has less value for those versions since
NotFound is not supported.
NotFound - The device is configured in the Cisco Unified Communications
Manager database, but is not registered or connected in any
way.
Registered - The device is registered to the Cisco Unified Communications
Manager. Only for this status should one expect a valid
value for the IP address of the device.
FoundAndUnregistered - The device is or recently was connected to the
Cisco Unified Communications Manager, but is not
registered.
callManagerIP
java.lang.String callManagerIP
The CallManagerIP action parameter can be used to restrict the query to
devices matching the specified Cisco Unified Communications Manager
publisher IP address.
A .NET System.Data.DataTable that contains rows and columns corresponding
to the devices and attributes returned for the query.
Info: The original type 'System.Data.DataTable' is replaced by etchType 'DeviceListData'.
The name of the profile to apply to the device. If not specified, then the
UserId specified must already have a device profile associated with that
account.
timeout
java.lang.Integer timeout
The amount of time in seconds to lease this device for. Once the amount of
seconds has elapsed, the Extension Mobility service will log the user and
accompanying device profile out of the device.
This error code maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error codes. The one
exception is if the service returns 0, which is returned by this action
if the Extension Mobility service did not respond back to the Cisco
Unified Application Server with response XML or if the action was unable
to communication with the service.
errorMessage
java.lang.String errorMessage
This error message maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error messages. The one
exception is if the service returns null, which is returned by this
action if the Extension Mobility service did not respond back to the
Cisco Unified Application Server with response XML or if the action was
unable to communication with the service.
This error code maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error codes. The one
exception is if the service returns 0, which is returned by this action
if the Extension Mobility service did not respond back to the Cisco
Unified Application Server with response XML or if the action was unable
to communication with the service.
errorMessage
java.lang.String errorMessage
This error message maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error messages. The one
exception is if the service returns null, which is returned by this
action if the Extension Mobility service did not respond back to the
Cisco Unified Application Server with response XML or if the action was
unable to communication with the service.
This error code maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error codes. The one
exception is if the service returns 0, which is returned by this action
if the Extension Mobility service did not respond back to the Cisco
Unified Application Server with response XML or if the action was unable
to communication with the service.
errorMessage
java.lang.String errorMessage
This error message maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error messages. The one
exception is if the service returns null, which is returned by this
action if the Extension Mobility service did not respond back to the
Cisco Unified Application Server with response XML or if the action was
unable to communication with the service.
A complex variable type containing the data returned by this action. It
is populated only on success. It can be parsed easily by using the
GetDeviceStatus action.
Info: The original type 'Metreos.Types.CiscoExtensionMobility.DeviceProfileResponse' is replaced by etchType 'QueryUsersResultData'.
errorMessage
java.lang.String errorMessage
This error message maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error messages. The one
exception is if the service returns null, which is returned by this
action if the Extension Mobility service did not respond back to the
Cisco Unified Application Server with response XML or if the action was
unable to communication with the service.
A complex variable type containing the data returned by this action. It
is populated only on success. It can be parsed easily by using the
GetDeviceStatus action.
Info: The original type 'Metreos.Types.CiscoExtensionMobility.UserResponse' is replaced by etchType 'QueryDevicesResultData'.
errorMessage
java.lang.String errorMessage
This error message maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error messages. The one
exception is if the service returns null, which is returned by this
action if the Extension Mobility service did not respond back to the
Cisco Unified Application Server with response XML or if the action was
unable to communication with the service.
A complex variable type containing the data returned by this action. It
is populated only on success. It can be parsed easily by using the
GetUserDevices action.
Info: The original type 'Metreos.Types.CiscoExtensionMobility.DeviceResponse' is replaced by etchType 'QueryUsersResultData'.
errorMessage
java.lang.String errorMessage
This error message maps almost exactly to the standard Cisco Unified
Communications Manager Extension Mobility API error messages. The one
exception is if the service returns null, which is returned by this
action if the Extension Mobility service did not respond back to the
Cisco Unified Application Server with response XML or if the action was
unable to communication with the service.
use: optional; allowMultiple: false;
The name of the directory entry to show as a selectable item on the phone
screen.
telephone
java.lang.String telephone
use: optional; allowMultiple: false;
The telephone number that is associated with the Name of this
directory entry. When the user selects this directory entry with the Dial
softkey, the phone will dial this number.
use: optional; allowMultiple: false;
The index of the icon.
height
java.lang.Short height
use: optional; allowMultiple: false;
The height of the icon (in pixels). This value should only be specified
if one is saving the ResultData to IconMenu.
width
java.lang.Short width
use: optional; allowMultiple: false;
The width of the icon (in pixels). This value should only be specified
if one is saving the ResultData to IconMenu.
depth
java.lang.Short depth
use: optional; allowMultiple: false;
The color depth of the image. This value should only be specified if one
is saving the ResultData to IconMenu.
data
java.lang.String data
use: optional; allowMultiple: false;
The image data to be displayed. There are no utilities to help format
this data. Refer to the Cisco IP Phone Developer documentation. This value
should only be specified if one is saving the ResultData to
IconMenu.
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL of the PNG image to display. This URL must be accessible to the
phone. This value should only be specified if one is saving the ResultData
to IconFileMenu.
use: optional; allowMultiple: false;
The text displayed on the phone for this input item.
queryStringParam
java.lang.String queryStringParam
use: optional; allowMultiple: false;
When the user hits the Submit softkey, the Cisco IP Phone
will add a query parameter to the URL defined by CreateInput,
with the value specified by the user for this input item.
defaultValue
java.lang.String defaultValue
use: optional; allowMultiple: false;
A default value to pre-populate the input item prompt.
inputFlags
java.lang.String inputFlags
use: optional; allowMultiple: false;
Cisco IP Phone-specific flags that are used to dictate what content can
be entered into the prompt.
use: optional; allowMultiple: false;
An index into the list of icon items to indicate which icon should be shown
next to this menu item. This field is valid only when used with a IconMenu
or IconFileMenu XML object.
name
java.lang.String name
use: optional; allowMultiple: false;
The name of the menu item. This field is displayed with a menu or an icon
menu XML object. With a graphic menu or graphic file menu, it is used
as the title of the subsequent XML screen if the item is selected and if
the subsequent screen does not specify a title. This field is valid with
Menu, IconMenu, IconFileMenu, GraphicMenu,
and GraphicFileMenu.
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL that the phone will request if this menu item is selected. This
field is valid with Menu, IconMenu, IconFileMenu,
IconFileMenu, GraphicMenu, and GraphicFileMenu.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
touchAreaX1
java.lang.Short touchAreaX1
use: optional; allowMultiple: false;
The left side of the touch area associated with this menu item. This field
is valid only when used with a GraphicFileMenu XML object
and with phones that have touch-sensitive displays (in pixels).
touchAreaX2
java.lang.Short touchAreaX2
use: optional; allowMultiple: false;
The right side of the touch area associated with this menu item. This
field is valid only when used with a GraphicFileMenu XML object
and with phones that have touch-sensitive displays (in pixels).
touchAreaY1
java.lang.Short touchAreaY1
use: optional; allowMultiple: false;
The top side of the touch area associated with this menu item. This field
is valid only when used with a GraphicFileMenu XML object
and with phones that have touch-sensitive displays (in pixels).
touchAreaY2
java.lang.Short touchAreaY2
use: optional; allowMultiple: false;
The bottom side of the touch area associated with this menu item. This
field is valid only when used with a GraphicFileMenu XML object
and with phones that have touch-sensitive displays (in pixels).
use: optional; allowMultiple: false;
The display name of the softkey item.
position
java.lang.Short position
use: optional; allowMultiple: false;
The 1-indexed position of the softkey item.
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL that the phone will request if this softkey item is selected.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL. Does not apply to
'URLDown' parameter.
uRLDown
java.lang.String uRLDown
use: optional; allowMultiple: false;
The command that the phone should execute when the softkey button is depressed.
One must always save this result data into one of the following: a Text, Menu, Directory,
Image,
Input,
ImageFile,
IconMenu,
IconFileMenu,
GraphicMenu,
or GraphicFileMenu
XML type variable.
use: optional; allowMultiple: false;
The title of the directory XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
The first command that the phone should execute.
url2
java.lang.String url2
use: optional; allowMultiple: false;
The second command that the phone should execute.
url3
java.lang.String url3
use: optional; allowMultiple: false;
The third command that the phone should execute.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL(s)
specified. This may involve modifications being made to the URL(s).
priority1
java.lang.Short priority1
use: optional; allowMultiple: false;
The priority with which to treat the URL1 action parameter.
priority2
java.lang.Short priority2
use: optional; allowMultiple: false;
The priority with which to treat the URL2 action parameter.
priority3
java.lang.Short priority3
use: optional; allowMultiple: false;
The priority with which to treat the URL3 action parameter.
use: optional; allowMultiple: false;
The title of the graphic file menu XML object. This will be displayed
on the Cisco IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL of the PNG image to display. This URL must be accessible to the
phone.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
The title of the graphic menu XML object. This will be displayed on the
Cisco IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
height
java.lang.Short height
use: optional; allowMultiple: false;
The height of the image (in pixels).
width
java.lang.Short width
use: optional; allowMultiple: false;
The width of the image (in pixels).
depth
java.lang.Short depth
use: optional; allowMultiple: false;
The color depth of the image.
data
java.lang.String data
use: optional; allowMultiple: false;
The image data to be displayed. There are no utilities to help format
this data. Refer to the Cisco IP Phone Developer documentation.
use: optional; allowMultiple: false;
The title of the icon menu XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
The title of the icon menu XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
The title of the image file XML object. This will be displayed on the
Cisco IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL of the PNG image to display. This URL must be accessible to the
phone.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
The title of the image XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
height
java.lang.Short height
use: optional; allowMultiple: false;
The height of the image (in pixels).
width
java.lang.Short width
use: optional; allowMultiple: false;
The width of the image (in pixels).
depth
java.lang.Short depth
use: optional; allowMultiple: false;
The color depth of the image.
data
java.lang.String data
use: optional; allowMultiple: false;
The image data to be displayed. There are no utilities to help format
this data. Refer to the Cisco IP Phone Developer documentation.
use: optional; allowMultiple: false;
The title of the input XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The base URL that the phone will use to generate the request when the user
hits Submit on their Cisco IP Phone. This URL is prepended
to any query parameters defined by input items.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
The title of the text XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
A single line of text to show on the status XML object. This will be displayed
on the Cisco IP Phone.
timer
java.lang.Short timer
use: optional; allowMultiple: false;
The timer seed value (in seconds). If specified, a timer will be displayed
on the status bar.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL of the PNG image to display on the status bar. This URL must be
accessible to the phone.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
A single line of text to show on the status XML object. This will be displayed
on the Cisco IP Phone.
timer
java.lang.Short timer
use: optional; allowMultiple: false;
The timer seed value (in seconds). If specified, a timer will be displayed
on the status bar.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image within the status bar (in pixels).
height
java.lang.Short height
use: optional; allowMultiple: false;
The height of the image within the status bar (in pixels).
width
java.lang.Short width
use: optional; allowMultiple: false;
The width of the image within the status bar (in pixels).
depth
java.lang.Short depth
use: optional; allowMultiple: false;
The color depth of the image within the status bar.
data
java.lang.String data
use: optional; allowMultiple: false;
The image data to be displayed. There are no utilities to help format
this data. Refer to the Cisco IP Phone Developer documentation.
use: optional; allowMultiple: false;
The title of the text XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
text
java.lang.String text
use: optional; allowMultiple: false;
The content of the of the text XML object. This will be displayed on the
Cisco IP Phone.
use: optional; allowMultiple: false;
The title of the directory XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
The first command that the phone should execute.
url2
java.lang.String url2
use: optional; allowMultiple: false;
The second command that the phone should execute.
url3
java.lang.String url3
use: optional; allowMultiple: false;
The third command that the phone should execute.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL(s)
specified. This may involve modifications being made to the URL(s).
priority1
java.lang.Short priority1
use: optional; allowMultiple: false;
The priority with which to treat the URL1 action parameter.
priority2
java.lang.Short priority2
use: optional; allowMultiple: false;
The priority with which to treat the URL2 action parameter.
priority3
java.lang.Short priority3
use: optional; allowMultiple: false;
The priority with which to treat the URL3 action parameter.
use: optional; allowMultiple: false;
The title of the graphic file menu XML object. This will be displayed
on the Cisco IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL of the PNG image to display. This URL must be accessible to the
phone.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
The title of the graphic menu XML object. This will be displayed on the
Cisco IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
height
java.lang.Short height
use: optional; allowMultiple: false;
The height of the image (in pixels).
width
java.lang.Short width
use: optional; allowMultiple: false;
The width of the image (in pixels).
depth
java.lang.Short depth
use: optional; allowMultiple: false;
The color depth of the image.
data
java.lang.String data
use: optional; allowMultiple: false;
The image data to be displayed. There are no utilities to help format
this data. Refer to the Cisco IP Phone Developer documentation.
use: optional; allowMultiple: false;
The title of the icon menu XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
The title of the icon menu XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
The title of the image file XML object. This will be displayed on the
Cisco IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL of the PNG image to display. This URL must be accessible to the
phone.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
The title of the image XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
height
java.lang.Short height
use: optional; allowMultiple: false;
The height of the image (in pixels).
width
java.lang.Short width
use: optional; allowMultiple: false;
The width of the image (in pixels).
depth
java.lang.Short depth
use: optional; allowMultiple: false;
The color depth of the image.
data
java.lang.String data
use: optional; allowMultiple: false;
The image data to be displayed. There are no utilities to help format
this data. Refer to the Cisco IP Phone Developer documentation.
use: optional; allowMultiple: false;
The title of the input XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The base URL that the phone will use to generate the request when the user
hits Submit on their Cisco IP Phone. This URL is prepended
to any query parameters defined by input items.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
The title of the text XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
use: optional; allowMultiple: false;
A single line of text to show on the status XML object. This will be displayed
on the Cisco IP Phone.
timer
java.lang.Short timer
use: optional; allowMultiple: false;
The timer seed value (in seconds). If specified, a timer will be displayed
on the status bar.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image (in pixels).
uRL
java.lang.String uRL
use: optional; allowMultiple: false;
The URL of the PNG image to display on the status bar. This URL must be
accessible to the phone.
formatURL
java.lang.Boolean formatURL
use: optional; allowMultiple: false;
Indicates that URL format validation should be performed on the URL specified.
This may involve modifications being made to the URL.
use: optional; allowMultiple: false;
A single line of text to show on the status XML object. This will be displayed
on the Cisco IP Phone.
timer
java.lang.Short timer
use: optional; allowMultiple: false;
The timer seed value (in seconds). If specified, a timer will be displayed
on the status bar.
locationX
java.lang.Short locationX
use: optional; allowMultiple: false;
The X-coordinate of the image (in pixels).
locationY
java.lang.Short locationY
use: optional; allowMultiple: false;
The Y-coordinate of the image within the status bar (in pixels).
height
java.lang.Short height
use: optional; allowMultiple: false;
The height of the image within the status bar (in pixels).
width
java.lang.Short width
use: optional; allowMultiple: false;
The width of the image within the status bar (in pixels).
depth
java.lang.Short depth
use: optional; allowMultiple: false;
The color depth of the image within the status bar.
data
java.lang.String data
use: optional; allowMultiple: false;
The image data to be displayed. There are no utilities to help format
this data. Refer to the Cisco IP Phone Developer documentation.
use: optional; allowMultiple: false;
The title of the text XML object. This will be displayed on the Cisco
IP Phone.
prompt
java.lang.String prompt
use: optional; allowMultiple: false;
The prompt to the user to indicate the action that needs to be taken.
This will de displayed on the Cisco IP Phone.
text
java.lang.String text
use: optional; allowMultiple: false;
The content of the of the text XML object. This will be displayed on the
Cisco IP Phone.
The content of the request. If the Method is a POST, then one can
initialize a FormCollection with this event parameter, in order to access
the useful utilities found in the FormCollection type.
host
java.lang.String host
Host portion of the request URI of the form 'IP:PORT'. 'PORT' in this case
is always 8000, because it is not configurable.
hostname
java.lang.String hostname
The host portion of the request URI. Port information is not contained
within this parameter.
port
java.lang.Integer port
The port portion of the request URI.
query
java.lang.String query
The query string portion of the request URI, always starting with the
initial '?' after the Url portion of the URI, and ending with the last
character in the URI. One can initialize a QueryParamCollection with this
event parameter, in order to access the useful utilities found in the
QueryParamCollection type.
method
java.lang.String method
The request method, such as GET or POST.
url
java.lang.String url
The path portion of the request URI, always starting with the initial '/'
after the Host portion parameter of the URI, and ending with the last
character in the URI or, if '?' is present in the URI, the character before
the first occurrence of '?'.
remoteHost
java.lang.String remoteHost
The IP address and port of the remote client, of the form IP:PORT.
remoteIpAddress
java.lang.String remoteIpAddress
The IP address of the remote client.
partition
java.lang.String partition
Name of the partition from which the event is triggered.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The line number on the device that has gone off-hook.
deviceName
java.lang.String deviceName
The name of the device that has gone off-hook.
stackToken
java.lang.String stackToken
The JTAPI protocol call ID.
jTapiCallId
java.lang.String jTapiCallId
The JTapi internal call Id. This can be used to co-relate the originating
and the terminating ends of the call.
callControlCause
java.lang.String callControlCause
The JTAPI protocol CallControlCause for the call. Please refer to the JTAPI
documentation for the complete list of Cause and CallControlCause reasons.
callId
java.lang.Long callId
Unique identifier used to identify this call leg in all subsequent
3rd-Party JTAPI API operations, such as JTapiRejectCall, JTapiAnswerCall,
JTapiRedirect.
partition
java.lang.String partition
Name of the partition from which the event is triggered.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The destination to which the call forward is set. This value is only
valid if CallForwardType is set to Unconditional.
callForwardType
java.lang.String callForwardType
CallForwardType indicates the current forwarding status of the phone:
No Call Forward Set - The specified line is not set to 'Call Forward
All' in the Cisco Unified Communications Manager. Note
that the line in question could have 'Call Forward
Busy', 'No Answer', or other call forward conditions set
in the actual Cisco Unified Communications Manager
configuration of this line, and still return this
condition for CallForwardType. In other words, since
this action only supports querying the 'Call Forward
All' status, No Call Forward Set refers to that status
of that condition specifically.
Unconditional - The specified line is set to 'Call Forward All' in the
Cisco Unified Communications Manager. Refer to the
Digits result data parameter in order to determine the
actual destination of the forward, if applicable.
"" - Unknown.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The current status of the queried device. Possible values are:
Idle - The phone is not in a call. It could be either on hook or off
hook.
Active - The phone is in a call, and is actively talking (not on hold).
Alerting - The phone is ringing.
Held - The phone is in a call, and is not actively talking (is on
hold).
Unknown - Undefined.
resultCode
java.lang.String resultCode
Describes the result of the action with a textual success or error
message.
Indicates which party in the call pressed the digit.
Local - The device specified by the DeviceName event parameter was the
originating device of the digit(s).
Remote - The party in the call pressed the digit(s).
stackToken
java.lang.String stackToken
The JTAPI protocol call ID.
jTapiCallId
java.lang.String jTapiCallId
The JTapi internal call Id. This can be used to co-relate the originating
and the terminating ends of the call.
callId
java.lang.Long callId
Unique identifier used to identify which device has entered digits.
The JTAPI protocol cause for the call ending. Please refer to the JTAPI
documentation for the complete list of Cause and CallControlCause end
reasons.
deviceName
java.lang.String deviceName
The name of the device that has the ended call.
jTapiCallId
java.lang.String jTapiCallId
The JTapi internal call Id. This can be used to co-relate the originating
and the terminating ends of the call.
callControlCause
java.lang.String callControlCause
The JTAPI protocol CallControlCause for the call ending. Please refer to
the JTAPI documentation for the complete list of Cause and CallControlCause
end reasons.
stackToken
java.lang.String stackToken
The JTAPI protocol call ID.
callId
java.lang.Long callId
Unique identifier used to identify which call has ended.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The called number for this call. This number may not correspond to the
number the remote endpoint initially dialed.
callControlCause
java.lang.String callControlCause
The JTAPI protocol CallControlCause for the call. Please refer to the JTAPI
documentation for the complete list of Cause and CallControlCause reasons.
callId
java.lang.Long callId
Unique identifier used to identify this call leg in all subsequent
3rd-Party JTAPI API operations, such as JTapiRejectCall, JTapiAnswerCall,
or JTapiRedirect.
deviceName
java.lang.String deviceName
The name of the device that has received the call.
from
java.lang.String from
The calling party number for this call.
originalTo
java.lang.String originalTo
The original number which was dialed. This will be the same as the To field
unless the call has been redirected, transferred, or translated while being
routed.
stackToken
java.lang.String stackToken
The JTAPI protocol call ID.
jTapiCallId
java.lang.String jTapiCallId
The JTapi internal call Id. This can be used to co-relate the originating
and the terminating ends of the call.
partition
java.lang.String partition
Name of the partition from which the event is triggered.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
listenerDevicePool
java.lang.String listenerDevicePool
The name of the device pool containing application server-controlled
devices. If specified, also specify RxIP and RxPort, but do not specify
ListenerDeviceName and ListenerLineDN.
listenerDeviceName
java.lang.String listenerDeviceName
The device name of a device that should receive the monitor call. If
specified, also specify ListenerLineDN, but do not specify
ListenerDevicePool.
rxIP
java.lang.String rxIP
The IP address that the monitored audio should be sent to. If specified,
also specify ListenerDevicePool and RxPort, but do not specify
ListenerDeviceName and ListenerLineDN.
rxPort
java.lang.Long rxPort
The port that the monitored audio should be sent to. If specified, also
specify ListenerDevicePool and RxIP, but do not specify ListenerDeviceName
and ListenerLineDN.
The direction in which a recording indicator tone will be played. If not
specified, no tone will be played. Valid values area as follows:
PlayToneNoLocalOrRemote - No tones are generated.
PlayToneLocalOnly - The user being monitored hears a periodic tone.
PlayToneRemoteOnly - The listener hears a periodic tone.
PlayToneBothLocalAndRemote - Both local and remote tones are generated.
Describes the result of the action. If a failure occured, will indicate
the cause of the failure. The following are possible values:
Success -
No DevicePoolName and DeviceName specified - ListenerDevicePool or
ListenerDeviceName must be specified.
Failed to get Device for the specified DevicePool - The specified
ListenerDevicePool had no available devices.
DevicePool does not exist - The specified ListenerDevicePool does not
exist.
Device is not monitored - The specified TargetDeviceName is not
currently JTAPI-controlled by the application server.
Device type is not CtiMonitored - The specified TargetDeviceName is not
controllable with JTAPI.
Failed to get specified call - The specified TargetCallId does not
exist.
Internal Error: Failed to add Call - No Description.
Internal Error: Timed out waiting for response - No Description.
Internal Error: Failed to send message to JTAPI Service - No
Description.
InvalidDeviceName - The TargetDeviceName device name was invalid.
Originates from JTAPI.
InvalidDeviceType - The type of device represented by TargetDeviceName
was invalid. Originates from JTAPI.
UnknownMessageType - Originates from JTAPI.
InvalidDN - The TargetLineDN does not exist on TargetDeviceName.
Originates from JTAPI.
NoProvider - Originates from JTAPI.
GeneralFailure - Originates from JTAPI.
CallIdUnknown - The TargetCallId specified was invalid. Originates from
JTAPI.
CodecNotSupported - Originates from JTAPI.
MissingField - Originates from JTAPI.
InvalidDestination - Originates from JTAPI.
PlatformException - Originates from JTAPI.
DeviceNotMonitored - The device is not currently monitored. Originates
from JTAPI.
MethodNotSupported - Originates from JTAPI.
callId
java.lang.String callId
Unique identifier used to identify this call in all subsequent Call
Control API operations.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
The codec to use for the RTP stream outbound from the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified and if the
connection has not yet had its transmit properties set with
CreateConnection, the media engine configuration file defines the codec to
use, which by default is G711u. If not specified and the connection has had
its transmit properties set, the MediaTxCodec already defined for the
connection is respected.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize (in milliseconds) to use for the RTP stream outbound from the
media engine. If not specified and if the connection has not yet had its
transmit properties set with CreateConnection, the media engine
configuration file defines the framesize to use, which by default is 20ms.
If not specified and the connection has had its transmit properties set,
the MediaTxCodec already defined for the connection is respected.
hairpin
java.lang.Boolean hairpin
Indicates that the new conference should be optimized for two parties. A
hairpinned conference does not use any conference resources. However, a
hairpin conference will be 'promoted', or converted to a true media
conference, if a 3rd participant is added to the conference or if a voice
operation is performed on the conference itself. In either case, this will
cause each participant and conferenced voice operation to use one
conference resource. True conferences also have a slightly increased
latency over a hairpinned conference.
monitor
java.lang.Boolean monitor
Indicates that this participant can only listen to the conference, and does
not use a conference resource. All Monitor participants share 1 voice
resource. Monitor participants are not truly in the conference. To place a
currently Monitor connection into conference such that other participants
can hear them, you must remove that connection from the conference by
removing the connection from conference, and placing it back in with
Monitor set to false.
tariffTone
java.lang.Boolean tariffTone
Indicates whether this connection should hear a periodic tone while in a
true, on non-hairpinned, conference.
coach
java.lang.Boolean coach
Causes this connection to only be audible by a connection marked as the
pupil.
pupil
java.lang.Boolean pupil
Indicates whether this connection can hear audio originating from the
coach.
receiveOnly
java.lang.Boolean receiveOnly
The specified connection can hear others in the conference, but can not
transmit back to the conference.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The codec to use for the RTP stream inbound to the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the MediaRxCodec
already defined for the connection is respected.
mediaRxFramesize
java.lang.Long mediaRxFramesize
The framesize (in milliseconds) to use for the RTP stream inbound to the
media engine. If not specified, the MediaRxFramesize already defined for
the connection is respected.
mediaTxIP
java.lang.String mediaTxIP
The IP address that the Tx RTP stream will transmit audio to. This must be
specified if the ConnectionId specified was created by a ReserveConnection
and has not yet had its Tx properties set with CreateConnection.
mediaTxPort
java.lang.Long mediaTxPort
The port that the Tx RTP stream will transmit audio to. This must be
specified if the ConnectionId specified was created by a ReserveConnection
and has not yet had its transmit properties set with CreateConnection.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
conferences. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
The same value as the ConnectionId passed in as an action parameter.
conferenceId
java.lang.String conferenceId
Unique identifier used to identify this conference in all subsequent
Media Control operations.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
conference. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
mediaRxIP
java.lang.String mediaRxIP
The IP address that the Rx RTP stream must be sent to for this
connection.
mediaRxPort
java.lang.Long mediaRxPort
The port that the Rx RTP stream must be sent to for this connection.
mediaRxControlIP
java.lang.String mediaRxControlIP
The RTCP IP address of the media engine which is in control of this
connection.
The codec to use for the RTP stream outbound from the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the media engine
configuration file defines the codec to use, which by default is G711u.
mmsId
java.lang.Long mmsId
The ID of the media engine to create the connection on. This field is only
relevant if CreateConnection is being used to create a new connection; not
if being used to fully establish a connection that was previously created
by ReserveConnection. If no MmsId is specified when using CreateConnection,
a media engine with the most available resources is dynamically selected
from the Media Resource Group associated with the partition of the script
instance from which CreateConnection is invoked.
The codec to use for the RTP stream inbound to the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the media engine
configuration file defines the codec to use, which by default is G711u.
mediaRxFramesize
java.lang.Long mediaRxFramesize
The framesize (in milliseconds) to use for the RTP stream inbound to the
media engine. If not specified, the media engine configuration file defines
the framesize to use, which by default is 20ms.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize (in milliseconds) to use for the RTP stream outbound from the
media engine. If not specified, the media engine configuration file defines
the framesize to use, which by default is 20ms.
callId
java.lang.Long callId
The CallId of the call associated with this connection (hairpin only).
The IP address that the Rx RTP stream must be sent to for this
connection.
mediaRxPort
java.lang.Long mediaRxPort
The port that the Rx RTP stream must be sent to for this connection.
mediaRxControlIP
java.lang.String mediaRxControlIP
The RTCP IP address of the media engine which is in control of this
connection.
mediaRxControlPort
java.lang.Long mediaRxControlPort
The RTCP port of the connection.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all subsequent
Media Control operations.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
Indicates a command timeout value (in milliseconds). If this condition is
met, the DetectNonSilence command will result in the
DetectNonSilence_Complete event with a TerminationCondition of timeout.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The value of the ConnectionId result data is the same as that specified
as an action parameter. This ConnectionId is what one would later specify
in StopMediaOperation if one were to abort the command programmatically.
operationId
java.lang.String operationId
A unique identifier to this DetectNonSilence operation. This identifier
can later be used by the StopMediaOperation action to stop just this
particular operation on a connection, even if multiple media operations
are concurrently executing on that connection.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
terminationCondition
java.lang.String terminationCondition
Describes the condition which caused the operation to complete.
This is a parameter from asyncCallback event "Metreos.MediaControl.DetectNonSilence_Complete".
Indicates a command timeout value (in milliseconds). If this condition is
met, the DetectSilence command will result in the DetectSilence_Complete
event with a TerminationCondition of timeout.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
connectionId
java.lang.String connectionId
The value of the ConnectionId result data is the same as that specified
as an action parameter. This ConnectionId is what one would later specify
in StopMediaOperation if one were to abort the command programmatically.
operationId
java.lang.String operationId
A unique identifier to this DetectSilence operation. This identifier can
later be used by the StopMediaOperation action to stop just this
particular operation on a connection, even if multiple media operations
are concurrently executing on that connection.
terminationCondition
java.lang.String terminationCondition
Describes the condition which caused the operation to complete.
This is a parameter from asyncCallback event "Metreos.MediaControl.DetectSilence_Complete".
Indicates a command timeout value (in milliseconds). If this condition is
met, the GatherDigits command will result in the GatherDigits_Complete
event with a TerminationCondition of timeout.
termCondMaxTime
java.lang.Long termCondMaxTime
The amount of time (in milliseconds) that can elapse before terminating the
GatherDigits operation. If this condition is met, the GatherDigits command
will result in the GatherDigits_Complete event with a TerminationCondition
of maxtime.
termCondMaxDigits
java.lang.Long termCondMaxDigits
The number of digits that will cause the GatherDigits operation to
terminate. If this condition is met, the GatherDigits command will result
in the GatherDigits_Complete event with a TerminationCondition of
maxdigits.
termCondDigit
java.lang.String termCondDigit
A specific digit that will cause the GatherDigits operation to terminate.
If this condition is met, the GatherDigits command will result in the
GatherDigits_Complete event with a TerminationCondition of digit.
termCondDigitList
java.lang.String termCondDigitList
A list of digits that will cause the GatherDigits operation to terminate,
if any one of the digits in the list is inputted. The list has no
delimiters. If this condition is met, the GatherDigits command will result
in the GatherDigits_Complete event with a TerminationCondition of
digitlist.
termCondDigitPattern
java.lang.String termCondDigitPattern
A specific sequence of digits that will cause the GatherDigits operation to
terminate. If this condition is met, the GatherDigits command will result
in the GatherDigits_Complete event with a TerminationCondition of
digitpattern.
termCondInterDigitDelay
java.lang.Long termCondInterDigitDelay
The amount of time between digits which will cause the GatherDigits
operation to terminate. If this condition is met, the GatherDigits command
will result in the GatherDigits_Complete event with a TerminationCondition
of interdigdelay.
state9
java.lang.String state9
Optional user state information which is guaranteed present as the State
event parameter in GatherDigits_Complete or GatherDigits_Failed.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The value of the ConnectionId result data is the same as that specified
as an action parameter. This ConnectionId is what one would later specify
in StopMediaOperation if one were to abort the command programmatically.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
operationId
java.lang.String operationId
A unique identifier to this GatherDigits operation. This identifier can
later be used by the StopMediaOperation action to stop just this
particular operation on a connection, even if multiple media operations
are concurrently executing on that connection.
The condition which caused the GatherDigits to stop. Possible values for
termination condition are as follows:
digitlist - One of the digits specified by TermCondDigitList has
occurred.
maxtime - The amount of time specified by TermCondMaxTime has elapsed (in
milliseconds).
maxdigits - The number of digits specified by TermCondMaxDigits has
occurred.
digit - The digit specified by TermCondDigit has occurred.
interdigdelay - The amount of time specified by TermCondInterDigitDelay
has elapsed after the last occurring digit (in
milliseconds).
digitpattern - The sequence of digits specified by TermCondNonSilence has
occurred.
userstop - The StopMediaOperation was used on operation to abort it.
autostop - The Call Control API ended the operation due to the call
ending that was associated with the connection. The normal
reasons a call may end are Hangup or BlindTransfer.
timeout - The amount of time specified by CommandTimeout has elapsed (in
milliseconds).
This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".
elapsedTime
java.lang.Integer elapsedTime
The amount of time taken to perform the GatherDigits (in milliseconds).
This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".
digits
java.lang.String digits
The digits gathered from the buffer at the start of the GatherDigits, as
well as those that occurred throughout the duration of the action (from
GatherDigits until GatherDigits_Complete. Any digits that contributed to
the termination condition are included.
This is a parameter from asyncCallback event "Metreos.MediaControl.GatherDigits_Complete".
Indicates whether this connection can hear audio originating from the
coach.
coach
java.lang.Boolean coach
Causes this connection to only be audible by a connection marked as the
pupil.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
mediaRxFramesize
java.lang.Long mediaRxFramesize
The framesize (in milliseconds) to use for the RTP stream inbound to the
media engine. If not specified, the MediaRxFramesize already defined for
the connection is respected.
tariffTone
java.lang.Boolean tariffTone
Indicates whether this connection should hear a periodic tone while in a
true, on non-hairpinned, conference.
receiveOnly
java.lang.Boolean receiveOnly
The specified connection can hear others in the conference, but can not
transmit back to the conference.
The codec to use for the RTP stream inbound to the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the MediaRxCodec
already defined for the connection is respected.
mediaTxIP
java.lang.String mediaTxIP
The IP address that the Tx RTP stream will transmit audio to. This must be
specified if the ConnectionId specified was created by a ReserveConnection
and has not yet had its Tx properties set with CreateConnection.
mediaTxPort
java.lang.Long mediaTxPort
The port that the Tx RTP stream will transmit audio to. This must be
specified if the ConnectionId specified was created by a ReserveConnection
and has not yet had its transmit properties set with CreateConnection.
The codec to use for the RTP stream outbound from the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified and if the
connection has not yet had its transmit properties set with
CreateConnection, the media engine configuration file defines the codec to
use, which by default is G711u. If not specified and the connection has had
its transmit properties set, the MediaTxCodec already defined for the
connection is respected.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize (in milliseconds) to use for the RTP stream outbound from the
media engine. If not specified and if the connection has not yet had its
transmit properties set with CreateConnection, the media engine
configuration file defines the framesize to use, which by default is 20ms.
If not specified and the connection has had its transmit properties set,
the MediaTxCodec already defined for the connection is respected.
callId
java.lang.Long callId
The ID of the call associated with this connection (hairpin only).
hairpin
java.lang.Boolean hairpin
Indicates that the new conference should be optimized for two parties. A
hairpinned conference does not use any conference resources. However, a
hairpin conference will be 'promoted', or converted to a true media
conference, if a 3rd participant is added to the conference or if a voice
operation is performed on the conference itself. In either case, this will
cause each participant and conferenced voice operation to use one
conference resource. True conferences also have a slightly increased
latency over a hairpinned conference.
monitor
java.lang.Boolean monitor
Indicates that this participant can only listen to the conference, and does
not use a conference resource. All Monitor participants share 1 voice
resource. Monitor participants are not truly in the conference. To place a
currently Monitor connection into conference such that other participants
can hear them, you must remove that connection from the conference by
removing the connection from conference, and placing it back in with
Monitor set to false.
The RTCP IP address of the media engine which is in control of this
connection.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
connectionId
java.lang.String connectionId
The same value as the ConnectionId passed in as an action parameter.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
conference. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
mediaRxPort
java.lang.Long mediaRxPort
The port that the Rx RTP stream must be sent to for this connection.
mediaRxControlPort
java.lang.Long mediaRxControlPort
The RTCP port of the connection.
mediaRxIP
java.lang.String mediaRxIP
The IP address that the Rx RTP stream must be sent to for this
connection.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
Indicates a command timeout value (in milliseconds).
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
operationId
java.lang.String operationId
A unique identifier to this ManageGrammar operation.
This is a parameter from asyncCallback event "Metreos.MediaControl.ManageGrammar_Complete".
connectionId
java.lang.String connectionId
The same value as the ConnectionId passed in as an action parameter.
This is a parameter from asyncCallback event "Metreos.MediaControl.ManageGrammar_Complete".
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The codec to use for the RTP stream inbound to the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the media engine
configuration file defines the codec to use, which by default is G711u.
mediaRxFramesize
java.lang.Long mediaRxFramesize
The framesize (in milliseconds) to use for the RTP stream inbound to the
media engine. If not specified, the media engine configuration file defines
the framesize to use, which by default is 20ms.
The codec to use for the RTP stream outbound from the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the media engine
configuration file defines the codec to use, which by default is G711u.
mediaTxFramesize
java.lang.Long mediaTxFramesize
The framesize (in milliseconds) to use for the RTP stream outbound from the
media engine. If not specified, the media engine configuration file defines
the framesize to use, which by default is 20ms.
callId
java.lang.Long callId
The ID of the call associated with this connection (hairpin only).
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
connection. A common use for this ID is to ensure that other connections
which will ultimately be conferenced with this connection are all created
on the same media engine. This correlation is necessary because all
connections in a single conference must all reside on the same media
engine.
mediaRxControlIP
java.lang.String mediaRxControlIP
The RTCP IP address of the media engine which is in control of this
connection.
mediaRxControlPort
java.lang.Long mediaRxControlPort
The RTCP port of the connection.
connectionId
java.lang.String connectionId
Unique identifier used to identify this connection in all subsequent
Media Control operations. This will always be same as the supplied action
parameter ConnectionId.
mediaRxIP
java.lang.String mediaRxIP
The IP address that the Rx RTP stream must be sent to for this
connection.
mediaRxPort
java.lang.Long mediaRxPort
The port that the Rx RTP stream must be sent to for this connection.
The amount of non-silence (in milliseconds) to observe before terminating
the Play operation. If this condition is met, the Play command will result
in the Play_Complete event with a TerminationCondition of nonsilence.
prompts
java.lang.String[] prompts
Promopts
commandTimeout
java.lang.Long commandTimeout
Indicates a command timeout value (in milliseconds). If this condition is
met, the Play command will result in the Play_Complete event with a
TerminationCondition of timeout.
volume
java.lang.Integer volume
The amount by which to modify the volume (in decibels) of audio playback.
Valid values range from -10 to 10.
speed
java.lang.Integer speed
The amount by which to modify the speed of audio playback. Valid values
range from -10 to 10.
state7
java.lang.String state7
Arbitrary, user-defined state information which is passed back as the State
event parameter in Play_Complete or Play_Failed.
termCondMaxTime
java.lang.Long termCondMaxTime
The amount of time (in milliseconds) that can elapse before terminating the
play operation. If this condition is met, the Play command will result in
the Play_Complete event with a TerminationCondition of maxtime.
termCondMaxDigits
java.lang.Long termCondMaxDigits
The number of digits that will cause the play operation to terminate. If
this condition is met, the Play command will result in the Play_Complete
event with a TerminationCondition of maxdigits. Note that this termination
condition is only valid if one is playing to a ConnectionId.
termCondDigit
java.lang.String termCondDigit
A specific digit that will cause the play operation to terminate. If this
condition is met, the Play command will result in the Play_Complete event
with a TerminationCondition of digit. If you wish to know what digit or
digits were pushed, use GatherDigits after Play_Complete, which will
process the digits collected into the digit buffer as the Play command was
executing. Note that this termination condition is only valid if one is
playing to a ConnectionId.
termCondDigitList
java.lang.String termCondDigitList
A list of digits that will cause the play operation to terminate, if any
one of the digits in the list is inputted. The list has no delimiters. If
this condition is met, the Play command will result in the Play_Complete
event with a TerminationCondition of digitlist. Note that this termination
condition is only valid if one is playing to a ConnectionId.
termCondSilence
java.lang.Long termCondSilence
The amount of silence (in milliseconds) to observe before terminating the
Play operation. If this condition is met, the Play command will result in
the Play_Complete event with a TerminationCondition of silence.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
audioFileSampleRate
java.lang.Long audioFileSampleRate
The sample rate of the audio file (in kHz). Valid values are 6, 8, or 11.
11 should be avoided as it has a higher impact on the media engine. If not
specified, the media engine configuration file defines the sample rate to
use, which by default is 8.
audioFileSampleSize
java.lang.Long audioFileSampleSize
The sample size used in the audio file (in bits). Valid values are 4, 8, or
16. 4 and 16 should be avoided as both have a higher impact on the media
engine. If not specified, the media engine configuration file defines the
sample size to use, which by default is 8.
The encoding of the audio file: ulaw, alaw, pcm, or adpcm. Pcm and adpcm
should be avoided as each has a higher impact on the media engine. If not
specified, the media engine configuration file defines the file encoding to
use, which by default is ulaw.
In the case of a Play to a connection, the value of the ConnectionId
result data is the same as that specified as an action parameter. In the
case of a Play to a conference, the value of the ConnectionId result data
is the value of the new connection added to conference. In either case,
this ConnectionId is what one would later specify in StopMediaOperation
if one were to abort the command programmatically.
operationId
java.lang.String operationId
A unique identifier to this Play operation. This identifier can later be
used by the StopMediaOperation action to stop just this particular
operation on a connection, even if multiple media operations are
concurrently executing on that connection. In the case that the Play was
specified to a conference, there is no reason to store OperationId, since
the ConnectionId returned as a result data will only ever have this Play
action operating on it.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
elapsedTime
java.lang.Integer elapsedTime
The amount of time taken to perform the Play (in milliseconds).
This is a parameter from asyncCallback event "Metreos.MediaControl.Play_Complete".
The condition which caused the Play to stop. Possible values for
termination condition are as follows:
eod - The prompt(s) were played in their entirety.
maxtime - The amount of time specified by TermCondMaxTime has elapsed (in
milliseconds).
maxdigits - The number of digits specified by TermCondMaxDigits has
occurred.
digit - The digit specified by TermCondDigit has occurred.
silence - The amount of continuous silence specified by TermCondSilence
has elapsed (in milliseconds).
nonsilence - The amount of continuous non-silence specified by
TermCondNonSilence has elapsed (in milliseconds).
userstop - The StopMediaOperation was used on operation to abort it.
autostop - The Call Control API ended the operation due to the call
ending that was associated with the connection. The normal
reasons a call may end are Hangup or BlindTransfer.
timeout - The amount of time specified by CommandTimeout has elapsed (in
milliseconds).
This is a parameter from asyncCallback event "Metreos.MediaControl.Play_Complete".
Optional user state information which is guaranteed present as the State
event parameter in PlayTone_Complete or PlayTone_Failed.
termCondMaxTime
java.lang.Long termCondMaxTime
The amount of time (in milliseconds) that can elapse before terminating the
PlayTone operation. If this condition is met, the PlayTone command will
result in the PlayTone_Complete event with a TerminationCondition of
maxtime.
termCondDigit
java.lang.String termCondDigit
A specific digit that will cause the PlayTone operation to terminate. If
this condition is met, the PlayTone command will result in the
PlayTone_Complete event with a TerminationCondition of digit. Note that
this termination condition is only valid if one is playing a tone to a
ConnectionId.
termCondSilence
java.lang.Long termCondSilence
The amount of silence (in milliseconds) to observe before terminating the
PlayTone operation. If this condition is met, the PlayTone command will
result in the PlayTone_Complete event with a TerminationCondition of
silence.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
termCondNonSilence
java.lang.Long termCondNonSilence
The amount of non-silence (in milliseconds) to observe before terminating
the PlayTone operation. If this condition is met, the PlayTone command will
result in the PlayTone_Complete event with a TerminationCondition of
nonsilence.
In the case of a PlayTone to a connection, the value of the ConnectionId
result data is the same as that specified as an action parameter. In the
case of a PlayTone to a conference, the value of the ConnectionId result
data is the value of the new connection added to conference. In either
case, this ConnectionId is what one would later specify in
StopMediaOperation if one were to abort the command programmatically.
operationId
java.lang.String operationId
A unique identifier to this PlayTone operation. This identifier can later
be used by the StopMediaOperation action to stop just this particular
operation on a connection, even if multiple media operations are
concurrently executing on that connection. In the case that the PlayTone
was specified to a conference, there is no reason to store OperationId,
since the ConnectionId returned as a result data will only ever have this
PlayTone action operating on it.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
The condition which caused the PlayTone to stop. Possible values for
termination condition are as follows:
eod - The tone was played in its entirety; the amount of time specified
by Duration has elapsed (in milliseconds).
maxtime - The amount of time specified by TermCondMaxTime has elapsed (in
milliseconds).
digit - The digit specified by TermCondDigit has occurred.
silence - The amount of continuous silence specified by TermCondSilence
has elapsed (in milliseconds).
nonsilence - The amount of continuous non-silence specified by
TermCondNonSilence has elapsed (in milliseconds).
userstop - The StopMediaOperation was used on operation to abort it.
autostop - The Call Control API ended the operation due to the call
ending that was associated with the connection. The normal
reasons a call may end are Hangup or BlindTransfer.
timeout - The amount of time specified by in the media engine
configuration file for default command timeout has elapsed (in
milliseconds).
This is a parameter from asyncCallback event "Metreos.MediaControl.PlayTone_Complete".
The amount of non-silence (in milliseconds) to observe before terminating
the Record operation. If this condition is met, the Record command will
result in the Record_Complete event with a TerminationCondition of
nonsilence.
termCondMaxTime
java.lang.Long termCondMaxTime
The amount of time (in milliseconds) that can elapse before terminating the
Record operation. If this condition is met, the Record command will result
in the Record_Complete event with a TerminationCondition of maxtime.
termCondDigit
java.lang.String termCondDigit
A specific digit that will cause the Record operation to terminate. If this
condition is met, the Record command will result in the Record_Complete
event with a TerminationCondition of digit. If you wish to know what digit
or digits were pushed, use GatherDigits after Record_Complete, which will
process the digits collected into the digit buffer as the Record command
was executing. Note that this termination condition is only valid if one is
recording a ConnectionId.
connectionId
java.lang.String connectionId
The connection to perform the Record on. If specified, ConferenceId must
not be specified.
conferenceId
java.lang.String conferenceId
The conference to perform the Record on. If specified, ConnectionId must
not be specified.
termCondSilence
java.lang.Long termCondSilence
The amount of silence (in milliseconds) to observe before terminating the
Record operation. If this condition is met, the Record command will result
in the Record_Complete event with a TerminationCondition of silence.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
audioFileSampleRate
java.lang.Long audioFileSampleRate
The sample rate of the audio file (in kHz). Valid values are 6, 8, or 11.
11 should be avoided as it has a higher impact on the media engine. If not
specified, the media engine configuration file defines the sample rate to
use, which by default is 8.
audioFileSampleSize
java.lang.Long audioFileSampleSize
The sample size used in the audio file (in bits). Valid values are 4, 8, or
16. 4 and 16 should be avoided as both have a higher impact on the media
engine. If not specified, the media engine configuration file defines the
sample size to use, which by default is 8.
The encoding of the audio file: ulaw, alaw, pcm, or adpcm. Pcm and adpcm
should be avoided as each has a higher impact on the media engine. If not
specified, the media engine configuration file defines the file encoding to
use, which by default is ulaw.
The format of the audio file: wav or vox. If not specified, the media
engine configuration file defines the file format to use, which by default
is vox.
commandTimeout
java.lang.Long commandTimeout
Indicates a command timeout value (in milliseconds). If this condition is
met, the Record command will result in the Record_Complete event with a
TerminationCondition of timeout.
state15
java.lang.String state15
Optional user state information which is guaranteed present as the State
event parameter in Record_Complete or Record_Failed.
A unique identifier to this Record operation. This identifier can later
be used by the StopMediaOperation action to stop just this particular
operation on a connection, even if multiple media operations are
concurrently executing on that connection. In the case that the Record
was specified to a conference, there is no reason to store OperationId,
since the ConnectionId returned as a result data will only ever have this
Record action operating on it.
url
java.lang.String url
The URL to the recorded audio file.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
connectionId
java.lang.String connectionId
In the case of a Record to a connection, the value of the ConnectionId
result data is the same as that specified as an action parameter. In the
case of a Record to a conference, the value of the ConnectionId result
data is the value of the new connection added to conference. In either
case, this ConnectionId is what one would later specify in
StopMediaOperation if one were to abort the command programmatically.
filename
java.lang.String filename
The filename used to save the recording. The filename is relative to the
root of the media engine audio path.
elapsedTime
java.lang.Integer elapsedTime
The amount of time taken to perform the Record (in milliseconds).
This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".
The condition which caused the Record to stop. Possible values for
termination condition are as follows:
maxtime - The amount of time specified by TermCondMaxTime has elapsed (in
milliseconds).
digit - The digit specified by TermCondDigit has occurred.
silence - The amount of continuous silence specified by TermCondSilence
has elapsed (in milliseconds).
nonsilence - The amount of continuous non-silence specified by
TermCondNonSilence has elapsed (in milliseconds).
userstop - The StopMediaOperation was used on operation to abort it.
autostop - The Call Control API ended the operation due to the call
ending that was associated with the connection. The normal
reasons a call may end are Hangup or BlindTransfer.
timeout - The amount of time specified by CommandTimeout has elapsed (in
milliseconds).
This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".
The codec to use for the RTP stream inbound to the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the media engine
configuration file defines the codec to use, which by default is G711u.
The codec to use for the RTP stream outbound from the media engine. Valid
values are G711u, G711a, G723, and G729. If not specified, the media engine
configuration file defines the codec to use, which by default is G711u.
mmsId
java.lang.Long mmsId
The ID of the media engine to reserve the connection on. If no MmsId is
specified when using ReserveConnection, a media engine with the most
available resources is dynamically selected from the Media Resource Group
associated with the partition of the script instance from which
ReserveConnection is invoked.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
Unique identifier used to identify this connection in all subsequent
Media Control API operations. Before using with most Media Control
actions, this connection must still be fully connected with
CreateConnection.
mediaRxControlIP
java.lang.String mediaRxControlIP
The RTCP IP address of the media engine which is in control of this
connection.
mediaRxIP
java.lang.String mediaRxIP
The IP address that the Rx RTP stream must be sent to for this
connection.
mediaRxPort
java.lang.Long mediaRxPort
The port that the Rx RTP stream must be sent to for this connection.
mmsId
java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this
new connection. A common use for this ID is to ensure that other
connections which will ultimately be conferenced with this connection are
all created on the same media engine. This correlation is necessary
because all connections in a single conference must all reside on the
same media engine.
mediaRxControlPort
java.lang.Long mediaRxControlPort
The RTCP port of the connection.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The HTTP-accessible URI of the dynamic grammar. This can then be used by
VoiceRecognition and ManageGrammar when specifying the grammar name.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
Causes this connection to only be audible by the connection marked as a
pupil. If a coach has already been designated for this conference, the
coach designation moves to this connection.
pupil
java.lang.Boolean pupil
Indicates whether this connection can hear audio originating from the
coach.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
Indicates that this action should not return until the operation has fully
completed. It is recommended that the default of true by used.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
The amount of non-silence (in milliseconds) to observe before terminating
the voice recognition operation. If this condition is met, the
VoiceRecognition command will result in the VoiceRecognition_Complete
event.
grammars
java.lang.String[] grammars
Grammars
commandTimeout
java.lang.Long commandTimeout
Indicates a command timeout value (in milliseconds).
volume
java.lang.Integer volume
The amount by which to modify the volume (in decibels) of audio playback.
Valid values range from -10 to 10.
speed
java.lang.Integer speed
The amount by which to modify the speed of audio playback. Valid values
range from -10 to 10.
state8
java.lang.String state8
Optional user state information which is guaranteed present as the State
event parameter in VoiceRecognition_Complete or VoiceRecognition_Failed.
termCondSilence
java.lang.Long termCondSilence
The amount of silence (in milliseconds) to observe before terminating the
record operation. If this condition is met, the VoiceRecognition command
will result in the >VoiceRecognition_Complete event with a
TerminationCondition of silence.
audioFileSampleRate
java.lang.Long audioFileSampleRate
The sample rate of the audio file (in kHz). Valid values are 6, 8, or 11.
11 should be avoided as it has a higher impact on the media engine. If not
specified, the media engine configuration file defines the sample rate to
use, which by default is 8.
audioFileSampleSize
java.lang.Long audioFileSampleSize
The sample size used in the audio file (in bits). Valid values are 4, 8, or
16. 4 and 16 should be avoided as each has a higher impact on the media
engine.
The encoding of the audio file: ulaw, alaw, pcm, or adpcm. Pcm and adpcm
should be avoided as each has a higher impact on the media engine. If not
specified, the media engine configuration file defines the file encoding to
use, which by default is ulaw.
prompts
java.lang.String[] prompts
Prompts
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
termCondMaxTime
java.lang.Long termCondMaxTime
The amount of time (in milliseconds) that can elapse before terminating the
voice recognition operation. If this condition is met, the VoiceRecognition
command will result in the VoiceRecognition_Complete event.
A unique identifier to this VoiceRecognition operation. This identifier
can later be used by the StopMediaOperation action to stop just this
particular operation on a connection, even if multiple media operations
are concurrently executing on that connection.
resultCode
java.lang.String resultCode
A numeric code indicating the result status of the operation. A '0'
indicates success; a positive number indicates an error. Please reference
the Media Control Error Codes table for descriptions on specific error
codes.
connectionId
java.lang.String connectionId
The value of the ConnectionId result data is the same as that specified
as an action parameter. This ConnectionId is what one would later specify
in StopMediaOperation if one were to abort the command programmatically.
meaning
java.lang.String meaning
The top-match phrase recognized by Nuance OSR.
This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".
Describes the condition which caused the operation to complete.
This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".
score
java.lang.Integer score
The confidence score of the Meaning. The value can be between 0 - 1000.
With VR_XMLResult, scores can be between 0 - 100.
This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".
vR_XMLResult
java.lang.String vR_XMLResult
The full recognition result in XML format of the action. All scores and
meanings are returned in this XML content. To help parse through the full
result data, a number of helper actions exist:
null - Returns the number of matching results.
null - Returns the score and meaning of a result at a specified index.
null - Returns any results matching the specified string matching
criteria for meaning.
null - Returns any results matching the specified criteria for scores.
null - Allows one to specify user-defined XPath expressions to allow
custom parsing of the results.
Each of the VoiceRecResult methods take the XML content as a
VoiceRecResultList, so in general one should create a local variable of
type VoiceRecResultList initialized with this action parameter. The
XmlQuery action takes the XML content as a String, so if you intend to use
the XmlQuery action, you should make a String variable that initializes
with this action parameter. It is also valid to have two variables of
different types that both initialize with the same action parameter.
This is a parameter from asyncCallback event "Metreos.MediaControl.VoiceRecognition_Complete".
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The result code of the subscribe operation. The following are the
possible values:
0 - Success
1 - Failure
2 - Duplicate Subscription
3 - Missing Parameter Subscriber
4 - Missing Parameter RequestUri
5 - Missing Parameter Password
6 - Unused
7 - Bad Subscriber Format
8 - Bad RequestUri Format
9 - Missing Registrar Info
10 - Missing Domain Name
11 - Unknown Domain Name
12 - No Subscription
13 - Service Not Available
14 - Timeout
15 - Unauthorized
16 - Authentication Failed
The notification message from presence server. This event parameter can
either be used to initialize a string variable, in which case the
application will need to manually parse the resulting message, or a
PresenceNotification native type, which is a stongly-typed variable with
members that represent the data of interest in the message.
partition
java.lang.String partition
Name of the partition from which the event is triggered.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The result code of the subscribe operation. The following are the
possible values:
0 - Success
1 - Failure
2 - Duplicate Subscription
3 - Missing Parameter Subscriber
4 - Missing Parameter RequestUri
5 - Missing Parameter Password
6 - Unused
7 - Bad Subscriber Format
8 - Bad RequestUri Format
9 - Missing Registrar Info
10 - Missing Domain Name
11 - Unknown Domain Name
12 - No Subscription
13 - Service Not Available
14 - Timeout
15 - Unauthorized
16 - Authentication Failed
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The result code of the subscribe operation. The following are the
possible values:
0 - Success
1 - Failure
2 - Duplicate Subscription
3 - Missing Parameter Subscriber
4 - Missing Parameter RequestUri
5 - Missing Parameter Password
6 - Unused
7 - Bad Subscriber Format
8 - Bad RequestUri Format
9 - Missing Registrar Info
10 - Missing Domain Name
11 - Unknown Domain Name
12 - No Subscription
13 - Service Not Available
14 - Timeout
15 - Unauthorized
16 - Authentication Failed
An opaque token used to allow distinguishable timer events to be raised.
The value specified here will be sent back in the TimerFire event as an
event parameter. For the non-triggering timer, this value can be used to
associate data with the timer since the function handling the TimerFire
event will be able to pull the value back out into a variable using
InitializeWith.
timeout
java.lang.Integer timeout
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The ID of the timer, which is generated by the Timer Provider. This value
can be used later to cancel the timer with the RemoveTimer action.
timerUserData
java.lang.String timerUserData
This is the same value specified in the TimerUserData action parameter in
the AddTriggerTimer or AddNonTriggerTimer actions.
This is a parameter from asyncCallback event "Metreos.Providers.TimerFacility.TimerFire".
partition
java.lang.String partition
Name of the partition from which the event is triggered.
This is a parameter from asyncCallback event "Metreos.Providers.TimerFacility.TimerFire".
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.
The Timeout property specifies to the Application Runtime Environment how
long to wait for a response from the provider for the current action. The
ReturnValue returned in this case is Timeout. The value must be a literal
value in milliseconds.