Custom Data

This section describes the custom data commands used to get recordings using Custom Data fields and values and update Custom Data field values.

Get Recordings Using Custom Data Fields and Values

Example Request:

$ curl -k -X GET "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/details?token=6060329a-3786-4d85-a697-59845f8265fb&testCustomData1=testValue1"

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<result><code>0</code><message>ACK</message><recording><recordingId>671</recordingId><filename>dhtest.wav</filename><fileStatus>0</fileStatus><ani>sipp_g711_ulaw</ani><dnis>rss_g711_ulaw</dnis><account>1</account><duration>3551</duration><startTime>2017-03-22 15:06:59.842</startTime><rss>1</rss><archived>0</archived><route>1</route><archivalFailCount>0</archivalFailCount><archiverMode>Primary</archiverMode><sensitive>0</sensitive><pauseLength>0</pauseLength><deleteFlag>false</deleteFlag><location>1</location><archiverAction>0</archiverAction><conversionStatus>0</conversionStatus><isrUcid>x-isr-ucid-8701-24030@10.10.248.107</isrUcid><ingressCallId>8701-24030@10.10.248.107</ingressCallId><pausedWithSilence>false</pausedWithSilence><customDataSets><customData><name>testCustomData1</name><value>testValue1</value></customData></customDataSets><siprecDataSets/><dtmfDigits/></recording></result>

Add Custom Data Field Values to Recording

Example Request:

curl -k -X POST --data 'foo=recbar1' "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/details?token=d4cf088e-b7b8-4f62-87d4-e807dff450ae&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><recording><recordingId>2056</recordingId><ani>sipp_sd_siprec_1</ani><dnis>rss_sd_siprec</dnis><account>1</account><duration>120072</duration><startTime>2018-08-30 14:51:38.31</startTime><rss>1</rss><route>1</route><agentId/><sensitive>0</sensitive><deleteFlag>false</deleteFlag><isrUcid>x-isr-ucid-1-7452@10.10.248.119</isrUcid><ingressCallId>1-7452@10.10.248.119</ingressCallId><customDataSets><customData><customDataId>1</customDataId><name>foo</name><value>bar</value></customData><customData><customDataId>4</customDataId><name>foo</name><value>recbar1</value></customData></customDataSets><segments><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><customData><customDataId>2</customDataId><name>foo</name><value>segbar</value></customData><customData><customDataId>3</customDataId><name>foo</name><value>segbar1</value></customData></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></segments></recording></result>

Add Custom Data Field Values to Segment

Example Request:

$ curl -k -X POST --data 'foo=segbar1' "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/segment/details?token=d4cf088e-b7b8-4f62-87d4-e807dff450ae&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><customData><customDataId>2</customDataId><name>foo</name><value>segbar</value></customData><customData><customDataId>3</customDataId><name>foo</name><value>segbar1</value></customData></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>

Update Custom Data Value for Recording

Example Request (using <customDataId>4</customDataId>

curl -k -X POST --data 'foo[4]=recbar2' "https://<FACE_host_name_or_IP>:8443/Face/audioRecording/details?token=d4cf088e-b7b8-4f62-87d4-e807dff450ae&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><recording><recordingId>2056</recordingId><ani>sipp_sd_siprec_1</ani><dnis>rss_sd_siprec</dnis><account>1</account><duration>120072</duration><startTime>2018-08-30 14:51:38.31</startTime><rss>1</rss><route>1</route><agentId/><sensitive>0</sensitive><deleteFlag>false</deleteFlag><isrUcid>x-isr-ucid-1-7452@10.10.248.119</isrUcid><ingressCallId>1-7452@10.10.248.119</ingressCallId><customDataSets><customData><customDataId>1</customDataId><name>foo</name><value>bar</value></customData><customData><customDataId>4</customDataId><name>foo</name><value>recbar2</value></customData></customDataSets><segments><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><customData><customDataId>2</customDataId><name>foo</name><value>segbar</value></customData><customData><customDataId>3</customDataId><name>foo</name><value>segbar1</value></customData></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></segments></recording></result>