1. API Guide
  2. Common FACE Commands
  3. Fetch Recordings

Fetch Recordings

This section describes the FACE commands for obtaining a list of recordings. The default total recording limit of response is 1000.

Get Recording Details

Example Request: 
$ curl -k -X GET https://<FACE_host_name_or_IP>/Face/audioRecording/details?token=c69864ea-3d62-4e4f-8983-27879e7db04a
Example Response: 
<?xml version="1.0" encoding="UTF-16"?>
<result><code>-1</code><message>Selection criteria insufficient to determine recording. Returning all matches.</message><matches><match><recordingId>220</recordingId><isrUcid>x-isr-ucid-1-6695@10.178.248.32</isrUcid><ingressCallId>1-6695@10.178.248.32</ingressCallId><from>sipp_sd_siprec</from><to>rss_sd_siprec</to><start>2019-12-12 03:08:43</start></match><match><recordingId>221</recordingId><isrUcid>x-isr-ucid-1-6697@10.178.248.32</isrUcid><ingressCallId>1-6697@10.178.248.32</ingressCallId><from>sipp_sd_siprec</from><to>rss_sd_siprec</to><start>2019-12-12 03:09:00</start></match>
…
</matches></result>
Example Request: 
$ curl -k -X GET https://<FACE_host_name_or_IP>/Face/audioRecording/segment/details?token=c69864ea-3d62-4e4f-8983-27879e7db04a
Example Response: 
<?xml version="1.0" encoding="UTF-16"?>
<result><code>-1</code><message>Selection criteria insufficient to determine recording. Returning all matches.</message><matches><match><segmentId>262</segmentId><recordingId>220</recordingId><filename>rss_sd_siprec-1-6695@10.178.248.32.wav</filename><start>2019-12-12 03:08:43</start><end>2019-12-12 03:08:55</end><hasVideo>false</hasVideo></match><match><segmentId>263</segmentId><recordingId>221</recordingId><filename>rss_sd_siprec-1-6697@10.178.248.32.wav</filename><start>2019-12-12 03:09:00</start><end>2019-12-12 03:09:12</end><hasVideo>false</hasVideo></match>
. . .
</matches></result>

Download Recorded Segment File by File Name

Command: 

$ curl -k -X GET "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/segment/download?token=d4cf088e-b7b8-4f62-87d4-e807dff450ae&filename=rss_sd_siprec-1-7452@10.10.248.119.wav" > rss_sd_siprec-1-7452@10.10.248.119.wav

Get Segment Details by File Name

Example Request: 
$ curl -k -X GET "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/segment/details?token=37451e58-e60d-4e9f-8a5e-95f855fef6ac&filename=rss_sd_siprec-1-7452@10.10.248.119.wav"
Example Response: 
<?xml version="1.0" encoding="UTF-16"?>
<result><code>0</code><message>ACK</message><segment><segmentId>2058</segmentId><recordingId>2056</recordingId><sequence>1</sequence><filename>rss_sd_siprec-1-7452@10.10.248.119.wav</filename><fileStatus>0</fileStatus><location>1</location><accountId>1</accountId><routeId>1</routeId><start>2018-08-30 14:51:38.31</start><end>2018-08-30 14:53:38.382</end><checksumMismatch>false</checksumMismatch><pauseLength>0</pauseLength><pausedWithSilence>false</pausedWithSilence><securedMedia>0</securedMedia><hasVideo>false</hasVideo><archived>0</archived><archivalFailCount>0</archivalFailCount><archiverMode>Primary</archiverMode><archiverAction>0</archiverAction><conversionStatus>6</conversionStatus><customDataSets/><dtmfDigits/><siprecDataSets><siprecData><session><startTime>2012-01-02 13:44:39.0</startTime><siprecCallId>1-7452@10.10.248.119</siprecCallId><siprecSessionId>sIbybsXtQ7pivcNTRvEN4A1==</siprecSessionId><extensionDataSets><extensionData><name>apkt:callerOrig</name><values><value>true</value></values></extensionData><extensionData><name>apkt:ucid</name><values><value>x-isr-ucid-1-7452@10.10.248.119</value></values></extensionData></extensionDataSets></session><participants><participant><siprecParticipantId>fhpR4z4qSy5x4H7aEzbsPg1==</siprecParticipantId><aor>sip:sipp_sd_siprec_1@10.10.248.119:5060</aor><name>sipp_sd_siprec_1</name><startTime>2012-01-02 13:44:39.0</startTime><extensionDataSets><extensionData><name>apkt:callingParty</name><values><value>true</value></values></extensionData></extensionDataSets></participant><participant><siprecParticipantId>PdDRRcWbSzl0nE7mP5W9Vg1==</siprecParticipantId><aor>sip:rss_sd_siprec@10.10.248.113:5060</aor><name>rss_sd_siprec</name><startTime>2012-01-02 13:44:39.0</startTime><extensionDataSets><extensionData><name>apkt:callingParty</name><values><value>false</value></values></extensionData></extensionDataSets></participant></participants><streams><stream><mode/><participantId>4155</participantId><siprecStreamId>4MNYDBh8R8JK+ULKGHBapw1==</siprecStreamId><startTime>2012-01-02 13:44:40.0</startTime><label>65537</label><extensionDataSets/></stream><stream><mode/><participantId>4156</participantId><siprecStreamId>vPwZND2gStZcASJPa40xhQ1==</siprecStreamId><startTime>2012-01-02 13:44:40.0</startTime><label>65536</label><extensionDataSets/></stream></streams></siprecData></siprecDataSets></segment></result>

Get Single Recording Details by UCID

Example Request: 
$ curl -k -X GET "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/details?token=7653a545-9815-4e85-970a-14ff53b84a80&isrUcid=x-isr-ucid-1-7452@10.10.248.119"
Example Response: 
<?xml version="1.0" encoding="UTF-16"?>
<result><code>0</code><message>ACK</message><segment><segmentId>2058</segmentId><recordingId>2056</recordingId><sequence>1</sequence><filename>rss_sd_siprec-1-7452@10.10.248.119.wav</filename><fileStatus>0</fileStatus><location>1</location><accountId>1</accountId><routeId>1</routeId><start>2018-08-30 14:51:38.31</start><end>2018-08-30 14:53:38.382</end><checksumMismatch>false</checksumMismatch><pauseLength>0</pauseLength><pausedWithSilence>false</pausedWithSilence><securedMedia>0</securedMedia><hasVideo>false</hasVideo><archived>0</archived><archivalFailCount>0</archivalFailCount><archiverMode>Primary</archiverMode><archiverAction>0</archiverAction><conversionStatus>6</conversionStatus><customDataSets/><dtmfDigits/><siprecDataSets><siprecData><session><startTime>2012-01-02 13:44:39.0</startTime><siprecCallId>1-7452@10.10.248.119</siprecCallId><siprecSessionId>sIbybsXtQ7pivcNTRvEN4A1==</siprecSessionId><extensionDataSets><extensionData><name>apkt:callerOrig</name><values><value>true</value></values></extensionData><extensionData><name>apkt:ucid</name><values><value>x-isr-ucid-1-7452@10.10.248.119</value></values></extensionData></extensionDataSets></session><participants><participant><siprecParticipantId>fhpR4z4qSy5x4H7aEzbsPg1==</siprecParticipantId><aor>sip:sipp_sd_siprec_1@10.10.248.119:5060</aor><name>sipp_sd_siprec_1</name><startTime>2012-01-02 13:44:39.0</startTime><extensionDataSets><extensionData><name>apkt:callingParty</name><values><value>true</value></values></extensionData></extensionDataSets></participant><participant><siprecParticipantId>PdDRRcWbSzl0nE7mP5W9Vg1==</siprecParticipantId><aor>sip:rss_sd_siprec@10.10.248.113:5060</aor><name>rss_sd_siprec</name><startTime>2012-01-02 13:44:39.0</startTime><extensionDataSets><extensionData><name>apkt:callingParty</name><values><value>false</value></values></extensionData></extensionDataSets></participant></participants><streams><stream><mode/><participantId>4155</participantId><siprecStreamId>4MNYDBh8R8JK+ULKGHBapw1==</siprecStreamId><startTime>2012-01-02 13:44:40.0</startTime><label>65537</label><extensionDataSets/></stream><stream><mode/><participantId>4156</participantId><siprecStreamId>vPwZND2gStZcASJPa40xhQ1==</siprecStreamId><startTime>2012-01-02 13:44:40.0</startTime><label>65536</label><extensionDataSets/></stream></streams></siprecData></siprecDataSets></segment></result>

Get Recordings by Date

Example Request: 
curl -k -X GET "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/details?token=7653a545-9815-4e85-970a-14ff53b84a80&earliestStart=2017-03-22T00:00:00&latestStart=2017-03-22T23:59:59";echo;echo
Example Response: 
<?xml version="1.0" encoding="UTF-8"?>
<result><code>-1</code><message>Selection criteria insufficient to determine recording. Returning all matches.</message><matches><match><recordingId>671</recordingId><isrUcid>x-isr-ucid-8701-24030@10.10.248.107</isrUcid><ingressCallId>8701-24030@10.10.248.107</ingressCallId><filename>dhtest.wav</filename><from>sipp_g711_ulaw</from><to>rss_g711_ulaw</to><start>2017-03-22 15:06:59</start></match><match><recordingId>672</recordingId><isrUcid>x-isr-ucid-8745-24030@10.10.248.107</isrUcid><ingressCallId>8745-24030@10.10.248.107</ingressCallId><filename>dhtest.wav</filename><from>sipp_g711_ulaw</from><to>rss_g711_ulaw</to><start>2017-03-22 15:14:18</start></match><match><recordingId>673</recordingId><isrUcid>x-isr-ucid-1-4355@10.10.248.107</isrUcid><ingressCallId>1-4355@10.10.248.107</ingressCallId><filename>startstoptest.wav</filename><from>sipp_g711_ulaw</from><to>rss_g711_ulaw</to><start>2017-03-22 16:02:17</start></match></matches></result>

Note:

The default total recording limit of response is 1000.

Get Live Recordings

inProgress parameter is used to search live/completed recordings. When true, a search is performed for currently recording files only and when false, a search is performed for completed recordings only. By default this value is false.

Example Request (inProgress as false - to fetch completed recordings):
curl -k -X GET  "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/details?token=f25
bb6bf-b325-46e0-8e55-5e3b1fda4b9a&inProgress=false"
Example Response:
<?xml version="1.0"
      encoding="UTF-16"?><result><code>-1</code><message>Selection criteria insufficient to
      determine recording. Returning all
      matches.</message><matches><match><recordingId>133</recordingId><ingressCallId>004ECF4F-943E-EB11-AD6E-C39D47FD71D4@10.166.170.217</ingressCallId><from>pattern3</from><to>latest</to><start>2020-12-17
      05:10:26</start></match><match><recordingId>134</recordingId><ingressCallId>004ECF4F-943E-EB11-AD6E-C39D47FD71D4@10.166.170.217</ingressCallId><from>pattern3</from><to>latest</to><start>2020-12-17
      05:10:46</start></match><match><recordingId>136</recordingId><ingressCallId>00517F4B-E53E-EB11-8F86-55CEF6D87006@10.166.187.204</ingressCallId><from>pattern3</from><to>latest</to><start>2020-12-17
      14:50:03</start></match></matches></result>
Example Request (inProgress as true - to fetch ongoing/live recordings):
curl -k -X GET  https://<FACE_host_name_or_IP>:8443/Face/audioRecording/details?token=f25bb
6bf-b325-46e0-8e55-5e3b1fda4b9a&inProgress=true
Example Response:
<?xml version="1.0" encoding="UTF-16"?><result><code>0</code><message>ACK</message><recording><tmpRecordingI
d>156</tmpRecordingId><ani>pattern3</ani><dnis>latest</dnis><account>1</account><duration>0</duration><startTime>
2021-01-08
11:09:38.448</startTime><route>7</route><sensitive>0</sensitive><deleteFlag>false</deleteFlag><ing
ressCallId>808DD088-1050-EB11-8E05
-A5D87DF3ADBE@10.191.219.86</ingressCallId><customDataSets/><segments><segment><tmpSegmen
tId>183</tmpSegmentId><tmpRecordingId>156</tmpRecordingId><sequence>1</sequence><filename>latest-808DD088-1050-EB11-8E05-A5D87DF3ADBE@10.191.219.86.seg0.wav</filename><fileStatus>0</fileStatus><locationId>1</locationId><accountId>1</accountId><routeId>7</routeId><start>2021-01-08
11:09:38.448</start><checksumMismatch>false</checksumMismatch><pauseLength>0</pauseLength><pausedWithSilence>false</pausedWithSilence><securedMedia>0</securedMedia><hasVideo>false</hasVideo><archived>0</archived><archivalFailCount>0</archivalFailCount><archiverMode>Primary</archiverMode><archiverAction>0</archiverAction><conversionStatus>0</conversionStatus><customDataSets/><siprecDataSets/></segment></segments></recording></result>