Report Formats are used to define the settings of a CDR such as what information is included, what type of file it is, the delimiter, etc. Currently the Configuration API supports List and Get List Info methods. Create, Update, Read and Delete are not yet supported.

Get Format List Info

Description: Gets metadata for a list of Report Formats configured for a client.

User Roles: Sysadmin or IT User

Method: GET /configuration/reportFormats/info[?client={client}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)NoRestricts the list to entries that are specifically associated with this particular Client.

Body:

None

Response Code:  200 OK

Body:

Key or AttributeTypeMandatory?Description
sizeIntegerYesTotal number of entries in the list.
lastModifiedDateTimeNoThe last date & time that the list was updated. This information might not be available. This is formatted according to the definition of dateTime in the XML Schema specification. For JSON responses, it is represented as the number of milliseconds since midnight on January 1, 1970 (GMT).

Get the metadata for a list of Reports configured for a Client

#Request
GET /configuration/reportFormats/info?client=4199
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
200 OK
Content-Type: application/json

{
   "size": 15,
   "lastModified": 1374258114000
}
CODE

List Formats

Description: Lists Agents configured for a Client.

Response includes all Report Formats configured for the client plus the three standard LiveVox Report Formats.

User Roles: Sysadmin or IT User

Method: GET /configuration/reportFormats?[client={client}&]offset={n}&count={n}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)NoSpecifies the Client for which you want to retrieve the list of Agents
offsetnIntegerYesSpecifies the offset from 0, based on count, to start listing from.
countnIntegerYesSpecifies the number of items to return in the list. There is a hard cap of 1000 items.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
nextURINoA URI for the next page of entries. If next is not present, or blank, then there are no pages after this one.
formatArrayNo

A container for a page of Report Format entries. The page size is controlled via count and offset in the request.

KeyTypeMandatory?Description
idInteger (ID)YesLiveVox Report Format ID
nameStringYesName of the Report Format
descriptionStringNoDescription of the Report Format

Get a list of Report Formats for a Client

#Request (JSON)
GET /configuration/reportFormats?client=4199&offset=0&count=10
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
200 OK
Content-Type: application/json

{
   "format":    [
            {
         "id": 60046,
         "name": "CA CDR",
         "description": null
      },
            {
         "id": 10115,
         "name": "Expanded Delimited Report",
         "description": "Expanded Delimited Report"
      },
            {
         "id": 18242,
         "name": "LV_StandardTab_A",
         "description": "Standard Livevox Tab CDR Layout"
      },
...
            {
         "id": 32827,
         "name": "LV_Latitude_A",
         "description": "Latitude Report"
      },
            {
         "id": 43940,
         "name": "Test CDR",
         "description": "Test CDR"
      },
            {
         "id": 65267,
         "name": "CA Compliance CDR",
         "description": null
      }
   ],
   "next": "configuration/reportFormats?client=4199&offset=10&count=10"
}
CODE

Top of Page