Xcommand Phonebook Contact Modify; Xcommand Phonebook Contactmethod Add - Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Introduction

xCommand Phonebook Contact Modify

Modify contact details of an existing contact in the local phonebook. The following parameters
can be changed using this command: Name, FolderId, ImageURL and Title. You must use the
xCommand Phonebook ContactMethod Modify command to change the other parameters:
Number, Protocol, CallRate, CallType and Device.
Requires user role: ADMIN, USER
USAGE:
xCommand Phonebook Contact Modify ContactId: "ContactId" [Name: "Name"]
[FolderId: "FolderId"] [ImageURL: "ImageURL"] [Title: "Title"] [Tag: Tag]
where
: String (0, 255)
ContactId
The unique identifier for the contact you want to modify. The identifier will be returned
by an xCommand Phonebook Search command. It was also returned when the
xCommand Phonebook Contact Add command was issued to make the contact.
: String (0, 255)
Name
The name of the contact.
: String (0, 255)
FolderId
A unique identifier for the 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.
: String (0, 255)
ImageURL
Currently not in use.
: String (0, 255)
Title
The title of the contact.
: Untagged/Favorite
Tag
Tag the contact as a Favorite, or untag an already tagged contact.
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API
xConfiguration
xCommand
xCommand

xCommand Phonebook ContactMethod Add

Add contact details for an existing contact in the local phonebook. The command returns the
ContactMethodId, which is a unique string that identifies the contact method; typically the
format is "n".
You can add several contact methods to a contact. Note that only the first contact method
will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact
method may have been created when issuing the xCommand Phonebook Contact Add
command to make the contact. All contact methods are available in the API, on the web inter-
face and when using the remote control.
Requires user role: ADMIN, USER
USAGE:
xCommand Phonebook ContactMethod Add ContactId: "ContactId" [Device: Device]
Number: "Number" [Protocol: Protocol] [CallRate: CallRate] [CallType: CallType]
where
: String (0, 255)
ContactId
The unique identifier for the contact that you want to add a contact method to. The
identifier will be returned by an xCommand Phonebook Search command. It was also
returned when the xCommand Phonebook Contact Add command was issued to make
the contact.
: Mobile/Other/Telephone/Video
Device
Set which type of device to call to.
: String (0, 255)
Number
The phone number or address of the contact.
: Auto/H320/H323/SIP/Spark
Protocol
Select protocol.
: Integer (0..6000)
CallRate
Set a call rate.
: Audio/Video
CallType
Select a call type (audio or video).
129
API Reference Guide
xStatus
Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents