Segmentation Use Cases: Get Recordings

Use Case 1

Segmentation Enabled/Disabled

- Only one recording (with multiple segments) in DB

Example Request:

curl -k -X GET https://10.184.18.144:8443/Face/audioRecording/details?token=9c866ba8-4516-405c-86ac-d941b57de4b8"

- Multiple recordings in DB, filtered to a particular recording with multiple segments

Example Request:

curl -k -X GET https://10.184.18.144:8443/Face/audioRecording/details?token=9c866ba8-4516-405c-86ac-d941b57de4b8&recordingId=128"

Response fields are the same in all scenarios above.

Example Response:

<?xml version="1.0" encoding="UTF-16"?>

<result><code>0</code><message>ACK</message><recording><recordingId>128</recordingId><ani>pattern3</ani>
<dnis>calldnis</dnis><account>1</account><duration>8651</duration><startTime>2021-09-04 21:53:42.925</startTime>
<route>1</route><sensitive>0</sensitive><deleteFlag>false</deleteFlag><ingressCallId>0007B88F-9E1A-EC11-99E6-
0806A2B19C96@10.76.48.215</ingressCallId><customDataSets/><segments><segment><segmentId>186</segmentId>
<recordingId>128</recordingId><sequence>1</sequence><filename>calldnis-0007B88F-9E1A-EC11-99E6-
0806A2B19C96@10.76.48.215.seg0.wav</filename><fileStatus>0</fileStatus><locationId>3</locationId><accountId>1</accountId>
<routeId>1</routeId><start>2021-09-04 21:53:42.925</start><end>2021-09-04 21:53:46.762</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>0</conversionStatus><customDataSets/>
<dtmfDigits/><siprecDataSets/></segment><segment><segmentId>187</segmentId><recordingId>128</recordingId>
<sequence>2</sequence><filename>calldnis-0007B88F-9E1A-EC11-99E6-0806A2B19C96@10.76.48.215.seg1.wav</filename>
<fileStatus>0</fileStatus><locationId>3</locationId><accountId>1</accountId><routeId>1</routeId><start>2021-09-04 
21:53:46.762</start><end>2021-09-04 21:53:51.576</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>0</conversionStatus><customDataSets/><dtmfDigits/><siprecDataSets/>
</segment></segments></recording></result>

Use Case 2

Segmentation Enabled

- Only one recording (with a single segment) in DB

Example Request:

curl -k -X GET "https://10.184.18.144:8443/Face/audioRecording/details?token=9c866ba8-4516-405c-86ac-d941b57de4b8"

- Multiple recordings, filtered to a particular recording with a single segment

Example Request:

curl -k -X GET "https://10.184.18.144:8443/Face/audioRecording/details?token=9c866ba8-4516-405c-86ac-d941b57de4b8&recordingId=129"

Response fields are the same in all scenarios above.

<?xml version="1.0" encoding="UTF-16"?>

<result><code>0</code><message>ACK</message><recording><recordingId>129</recordingId><ani>pattern3</ani>
<dnis>calldnis</dnis><account>1</account><duration>3017</duration><startTime>2021-09-04 21:57:55.849</startTime>
<route>1</route><agentId/><sensitive>0</sensitive><deleteFlag>false</deleteFlag><ingressCallId>80F0B527-9F1A-EC11-99E8-
0806A2B19C96@10.76.48.215</ingressCallId><customDataSets/><segments><segment><segmentId>188</segmentId>
<recordingId>129</recordingId><sequence>1</sequence><filename>calldnis-80F0B527-9F1A-EC11-99E8-
0806A2B19C96@10.76.48.215.seg0.wav</filename><fileStatus>0</fileStatus><locationId>3</locationId><accountId>1</accountId>
<routeId>1</routeId><start>2021-09-04 21:57:55.849</start><end>2021-09-04 21:57:58.866</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>0</conversionStatus><customDataSets/>
<dtmfDigits/><siprecDataSets/></segment></segments></recording></result>

Use Case 3

Segmentation Disabled

- Only one recording, with a single segment, in DB

Example Request:

curl -k -X GET "https://10.184.18.144:8443/Face/audioRecording/details?token=9c866ba8-4516-405c-86ac-d941b57de4b8"

- Multiple recordings, filtered to a particular recording with a single segment

Example Request:

curl -k -X GET "https://10.184.18.144:8443/Face/audioRecording/details?token=9c866ba8-4516-405c-86ac-d941b57de4b8&recordingId=129"

Response fields are the same in all scenarios above.

Example Response:

<?xml version="1.0" encoding="UTF-16"?>

<result><code>0</code><message>ACK</message><recording><recordingId>129</recordingId><filename>calldnis-80F0B527-9F1A-EC11-
99E8-0806A2B19C96@10.76.48.215.seg0.wav</filename><fileStatus>0</fileStatus><ani>pattern3</ani><dnis>calldnis</dnis>
<account>1</account><duration>3017</duration><startTime>2021-09-04 21:57:55.849</startTime><rss>2</rss><archived>0</archived>
<route>1</route><archivalFailCount>0</archivalFailCount><agentId/><archiverMode>Primary</archiverMode><sensitive>0</sensitive>
<pauseLength>0</pauseLength><deleteFlag>false</deleteFlag><location>3</location><archiverAction>0</archiverAction>
<conversionStatus>0</conversionStatus><ingressCallId>80F0B527-9F1A-EC11-99E8-0806A2B19C96@10.76.48.215</ingressCallId>
<pausedWithSilence>false</pausedWithSilence><hasVideo>false</hasVideo><checksumMismatch>false</checksumMismatch>
<customDataSets/><siprecDataSets/><dtmfDigits/></recording></result>