TeamResource—Get Phone Books

This API allows an agent or supervisor to get phone books and the first associated contacts for the team, based on the defined range (1 to 6000). Contacts are retrieved from the global phone books first, followed by the team phone books, up to the maximum limit of 6000. For more information about the PhoneBook object, see PhoneBook.

Note

Cisco Finesse Release 12.6(2) onward, this API gets the list of phone books even when the range is not specified. This lists all the phone book records with the maximum limit of 6000.

URI:

https://<FQDN>/finesse/api/TeamResource/<teamId>/PhoneBooks

Example URI:

https://finesse1.xyz.com/finesse/api/TeamResource/1234/PhoneBooks

Security Constraints:

Agents and supervisors who are part of the team can use this API.

To get the phone book for the team, the user must be signed in or provide valid authorization credentials.

Additional Headers:

"Range: objects=1­6000"

The range of contacts to retrieve.

HTTP Method:

GET

Content Type:

—

Input/Output Format:

XML

HTTP Request:

—

HTTP Response:

200: Success

206: Partial Content

400: Bad Request (the request body is invalid)

400: Finesse API error (for example, the object does not exist, the object is stale, or violation of the DB constraint)

401: Authorization Failure

401: Invalid Authorization

404: Not Found (for example, the teamId does not exist or has been deleted)

416: Invalid Range Specified. Range must be 1– 6000 objects

500: Internal Server Error

Example Response: 

<PhoneBooks>
   <PhoneBook>
      <name>PhoneBook1</name>
      <type>GLOBAL</type>
      <Contacts>
         <Contact>
            ...Full Contact Object...
         </Contact>
            ...Full Contact Object...
         </Contact>
      </Contacts>
   </PhoneBook>
   <PhoneBook>
      <name>PhoneBook2</name>
      <type>TEAM</type>
      <Contacts>
         <Contact>
            ...Full Contact Object...
         </Contact>
         <Contact>
            ...Full Contact Object...
         </Contact>
      </Contacts>
   </PhoneBook>
</PhoneBooks>

Example Failure Response:

Example
<ApiErrors>
  <ApiError>
    <ErrorType>Authorization Failure</ErrorType>
    <ErrorMessage>UNAUTHORIZED</ErrorMessage>
    <ErrorData>1234</ErrorData>
  </ApiError>
</ApiErrors>
Example

<ApiErrors>
  <ApiError>
    <ErrorType>Invalid Input</ErrorType>
    <ErrorData></ErrorData>
    <ErrorMessage>Invalid range header format. Format: objects=1-6000</ErrorMessage>
  </ApiError>
</ApiErrors>>
Example

<ApiErrors>
  <ApiError>
    <ErrorType>Invalid Input</ErrorType>
    <ErrorData></ErrorData>
    <ErrorMessage>Maximum number of contacts cannot exceed 6000</ErrorMessage>
  </ApiError>
</ApiErrors>