ListAddressbookNames command

The ListAddressbookNames command returns with all the addressbooks that can be found in Ozeki 10.

Request parameters

Parameter name Example value Description Mandatory
Username admin The username of the account. The username and password parameters are used to authenticate the user. yes
Password abc123 Specifies the password. The username and password parameters are used to authenticate the user. yes

Response parameters

Parameter name Example value Description Mandatory
Code 200 Returns the status code of the response. yes
Message Command successfully executed Returns the description of the response code. yes
Addressbooks It contains <Name> nodes. Between a <Name> node the name of an addressbook is shown. yes
NotificationName CallConnected Name of the notification request type. no

Example request and response

URL request

http://127.0.0.1:9509/api?command=ListAddressbookNames&Username=HTTP_User_1&Password=qwe123

Response

<?xml version="1.0"?>
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Code>200</Code>
  <Message>Command successfully executed</Message>
  <Addressbooks>
    <Addressbook>address_book_1</Addressbook>
    <Addressbook>address_book_2</Addressbook>
  </Addressbooks>
</Response>

More information