D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.
Copyright © 2017 Cisco Systems, Inc. All rights reserved.
141
Cisco TelePresence MX700 and MX800
API Reference Guide
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
ContactId:
String (0, 255)
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.
Name:
String (0, 255)
The name of the contact.
FolderId:
String (0, 255)
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.
ImageURL:
String (0, 255)
Currently not in use.
Title:
String (0, 255)
The title of the contact.
Tag:
Untagged/Favorite
Tag the contact as a Favorite, or untag an already tagged contact.
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 and on the web
interface.
Requires user role: ADMIN, USER
USAGE:
xCommand Phonebook ContactMethod Add ContactId: "
ContactId
" [Device:
Device
]
Number: "
Number
" [Protocol:
Protocol
] [CallRate:
CallRate
] [CallType:
CallType
]
where
ContactId:
String (0, 255)
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.
Device:
Mobile/Other/Telephone/Video
Set which type of device to call to.
Number:
String (0, 255)
The phone number or address of the contact.
Protocol:
Auto/H320/H323/SIP/Spark
Select protocol.
CallRate:
Integer (0..6000)
Set a call rate. The default is set to 0.
CallType:
Audio/Video
Select a call type (audio or video).
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xCommand
