D14128.03—JULY 2009
82
Codec C90
System Integrator Guide
Contents
Introduction
Getting Started
Interfaces
About the API
xConfiguration
xCommand
xStatus
Cameras
Appendices
Contact us
xCommand Phonebook Contact Add
Add new contact to local phonebook. Stored internally in system.
Parameters: Required parameters are marked with (
r
):
Name(
r
): <S: 0, 255>
FolderId: <S: 0, 255>
Number: <S: 0, 255>
Protocol: <H323/SIP>
CallRate: <0..65534>
Device: <Mobile/Other/Telephone/Video>
Example:
xCom mand Phonebook Contact Add Name:John Number:12345
OK
*r PhonebookContactAddResult (status=OK):
Name: localContactId-1
** end
xCommand Phonebook Contact Modify
Modify existing contact in local phonebook.
Parameters: Required parameters are marked with (
r
):
ContactId(
r
): <S: 0, 255>
Name: <S: 0, 255>
FolderId: <S: 0, 255>
Example:
xcom mand Phonebook Contact Modify ContactId:localContactId-1 Name:john.office
OK
*r PhonebookContactModifyResult (status=OK):
** end
xCommand Phonebook Contact Delete
Delete contact from local phonebook.
Parameters: Required parameters are marked with (
r
):
ContactId(
r
): <S: 0, 255>
Example:
xCom mand Phonebook Contact Delete ContactId:localContactId-1
OK
*r PhonebookContactDeleteResult (status=OK):
*r/end
xCommand Phonebook ContactMethod Add
Specify details about how to set up call to local phonebook contact.
Parameters: Required parameters are marked with (
r
):
ContactId(
r
): <S: 0, 255>
Device: <Mobile/Other/Telephone/Video>
Number(
r
): <S: 0, 255>
Protocol: <H323/SIP>
CallRate: <0..65534>
Example:
xCom mand Phonebook ContactMethod Add ContactId:localContactId-2 Number:54321
Protocol:H323
OK
*r PhonebookContactMethodAddResult (status=OK):
Name: 1
*r/end
xCommand Phonebook ContactMethod Delete
Delete call setup details for local phonebook contact.
Parameters: Required parameters are marked with (
r
):
ContactId(
r
): <S: 0, 255>
ContactMethodId(
r
): <S: 0, 255>
Example:
xCom mand Phonebook ContactMethod Delete ContactId:localContactId-2
ContactMethodId:1
OK
*r PhonebookContactMethodDeleteResult (status=OK):
*r/end
xCommand Phonebook Folder Add
Add a folder to the local phonebook, where phonebook entries can be stored.
Parameters: Required parameters are marked with (
r
):
Name(
r
): <S: 0, 255>
ParentFolderId: <S: 0, 255>
Example:
xcom mand Phonebook Folder Add Name: locationA
OK
*r PhonebookFolderAddResult (status=OK):
Name: localGroupId-3
** end
The Phonebook commands,
cont...
The Phonebook commands
Contents
Introduction
Getting started
Interfaces
About the API
xConfiguration
xCommand
xStatus
Cameras
Appendices
Contact us
xCommand
