Cisco TelePresence SX20 Codec Reference Manual page 101

Cisco TelePresence SX20 Codec
Contents Introduction
xCommand Message Echo
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"
xCommand Message FarendMessage
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
SX20 Codec API Reference Guide TC7.0, JANUARY 2014.
D14949.08
About the API xConfiguration
Phonebook commands
xCommand Phonebook Folder Add
Phonebook entries can be stored in folders. Use this command to add a folder to the local phonebook.
The command returns the FolderId, which is a unique string that identifies the folder; typically the format
is "localGroupId-n".
Name(r): The name of the folder.
ParentFolderId: The unique identifier for the parent folder. The identifier will be returned by an
xCommand Phonebook Search command. It was also returned when the xCommand Phonebook Folder
Add command was issued to make the parent folder.
Requires user role: USER
Parameters:
Example:
101
xCommand xCommand
Name(r): <S: 0, 255>
ParentFolderId: <S: 0, 255>
xCommand Phonebook Folder Add Name: "New York Office"
OK
*r PhonebookFolderAddResult (status=OK):
Name: localGroupId-3
** end
API Reference Guide
xStatus Appendices
Copyright © 2014 Cisco Systems, Inc. All rights reserved.