Cisco TelePresence System Codec C20 Reference Manual page 98

Cisco TelePresence System Codec C20
Contents Introduction
xCommand Message Prompt Clear
Remove the window displayed using the xCommand Message Alert Display command.
Use the xFeedback commands to monitor the feedback from the user. Read more about the
xFeedback commands in the API introduction section in this guide.
FeedbackId: The FeedbackId corresponds to the FeedbackId given by the xCommand Message
Prompt Display command.
Requires user role: ADMIN
Parameters:
FeedbackId: <S: 0, 255>
Example:
xCommand Message Prompt Clear
OK
*r MessagePromptClearResult (status=OK):
** end
xCommand Message Prompt Response
Give a response to the xCommand Message Prompt Display.
Use the xFeedback commands to monitor the feedback from the user. Read more about the
xFeedback commands in the API introduction section in this guide.
FeedbackId: The FeedbackId corresponds to the FeedbackId given by the xCommand Message
Prompt Display command.
OptionId: The OptionId corresponds to the OptionIds given as possible responses in the xCommand
Message Prompt Display command.
Requires user role: USER
Parameters:
FeedbackId: <S: 0, 255>
OptionId(r): <1..5>
Example:
xCommand Message Prompt Response OptionId: 1
OK
*r MessagePromptResponseResult (status=OK):
** end
Codec C20 API Reference Guide TC7.0, JANUARY 2014.
D14869.11
About the API xConfiguration
xCommand Message Echo
xCommand Message FarendMessage
98
xCommand xCommand
Issuing the command makes the API raise a message-echo event. The command has no other
impact on the codec. Usage can be to poll the codec from a control system or any external device/
system to check for connectivity. To monitor the feedback use the xFeedback command. You can
read more about the xFeedback command in the general API introduction section.
Text: Enter the text to be echoed.
Requires user role: ADMIN
Parameters:
Text: <S: 0, 255>
Example:
xCommand Message Echo Text:" MyEchoListner99"
*** end
* e Message Echo Text: "MyEchoListner99"
This command is used to send generic messages to the participants in a conference. Not in use in
this software version.
CallId: The remote participant to whom the message needs to be sent.
Type: Type of the message.
Text: Enter the text line to be displayed.
Requires user role: USER
Parameters:
CallId(o): <0..65534>
Type(r): <S: 0, 255>
Text(r): <S: 1, 1450>
LocalEcho(o): <On/Off>
Example:
xCommand Message FarendMessage CallId: 3 Type: 3 Text: Hello
*r FarendMessageResult (status=Error):
Reason: Generic Message mode not enabled
** end
API Reference Guide
xStatus Appendices
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.