The retrieveMetaDataByHour api allows you to retrieve a list of recordings for any one hour period.
This api is useful if you want to download recordings on a regular basis.
You should be aware that Noojee Contact may split the recording of a call into multiple ‘legs’ and as such you may need to retrieve multiple entries each leg for each a recording.
The api takes a date and an hour. When considering which recordings to retrieve it returns any recordings legs that ‘ended’ in that one hour block. As these are legs the entire recording may not have completed when you retrieve a leg. You should normally wait at until a few minutes after the hour before requesting the hour.
...
The hour uses a 24 hour clock so to get the calls for 1pm to 2pm pass in hour=13 just after 2pm.
Rate limited
The api is rate limited to a max of 1 per minute. You will receive an error if you attempt to make the call more frequently.
If the call is successfully the http code 200 will be returned otherwise an appropriate http error code is returned.
RetrieveMetaDataByHour
NOTE: This is a POST not a get.
curl -X POST 'https://<fqdn>/njadmin/rest/RecordingAPI/retrieveMetaDataByHour?apiKey=xxxxxxxxxxxxx&date=2021/09/14&hour=15'
| Code Block |
|---|
https://<fqdn>/njadmin/rest/RecordingAPI/retrieveMetaDataByHour?apiKey=xxxxxxxxx&date=2021/09/14&hour=15 |
The method returns a json encoded array/map containing any matching calls. There will be an entry in the array for each recording that ended during the hour.
...