Export API

OverviewClosed

The Export API allows users to download or email audio and video recordings so they can be played independently of inContact WFO.

When export requests are sent to the API, it verifies that the user account not only has permissions to export calls, but also validates that the user has permission to access the phone IDs in each recording requested for export. Any that do not pass the permissions check are omitted from the export.

For more information, see API Overview.

Web Export

Web export requests provide the requested file(s) in a compressed zip archive as a direct download.

SingleExport
Description

Exports audio based on the supplied parameters. If the specified parameters are not unique and match multiple records, the most recent record is returned.
HTTP Method GET
URI

http://[ExportApiServerAddress]/api/WebExport/SingleExport
Required Parameters
  • Uniquefield – Recording ident is the most reliable value, but if there is a unique identifier in another column – such as a specific call identifier being saved to a custom user field – that value can be used instead.
  • Uniquevalue – The value to match in the column specified in the Uniquefield value.
  • Mediaformat – MP3, WAV, or CAV.
Optional Parameters
  • Encrypt – Only required for CAV encryption. Possible values are true or false.
  • Password – Only required if encrypt is specified as true
Example(s):

http://[ExportApiServerAddress]/api/WebExport/SingleExport?uniquefield=ident&uniquevalue265&mediaformat=WAV&encrypt=true&password=******
Possible Returns
  • 200 OK – Request was completed, information was returned, or element matching specified parameters was found.
  • 404 Not Found – Requested item (agent, device) could not be located due to missing body parameter(s), does not currently exist in the API tracker(s), or nothing was found that matched the criteria provided.
  • 500 Internal Server Error – Can be caused by service misconfiguration or other problems with the server outside the scope of the inContact WFO API services.
MultiExport
Description

Multiple files in one compressed zip archive.
HTTP Method POST
URI

http://[ExportApiServerAddress]/api/WebExport/MultiExport
Required Parameters
  • Mediaformat – MP3, WAV, or CAV.
Optional Parameters
  • Idents – A comma separated list of idents (the ID assigned by the inContact WFO database). The maximum URL length is 2000 characters. If exporting a large number of calls, list the idents in the request header as a comma-separated list instead of in the URL.
Example(s):

http://[ExportApiServerAddress]/api/WebExport/MultiExport?mediaformat=MP3&idents=1,5,34,767

or

http://[ExportApiServerAddress]/api/WebExport/MultiExport?mediaformat=MP3

{“idents”:”1,5,34,767”}
Possible Returns
  • 200 OK – Request was completed, information was returned, or element matching specified parameters was found.
  • 404 Not Found – Requested item (agent, device) could not be located due to missing body parameter(s), does not currently exist in the API tracker(s), or nothing was found that matched the criteria provided.
  • 500 Internal Server Error – Can be caused by service misconfiguration or other problems with the server outside the scope of the inContact WFO API services.
CombinedExport
Description

Exports multiple audio files merged into a single audio file, in order by recording ID, in a compressed zip archive.
HTTP Method POST
URI

http://[ExportApiServerAddress]/api/WebExport/CombinedExport
Required Parameters
  • Mediaformat – MP3, WAV, or CAV.
Optional Parameters
  • Idents – A comma separated list of idents (the ID assigned by the inContact WFO database). The maximum URL length is 2000 characters. If exporting a large number of calls, list the idents in the request header as a comma-separated list instead of in the URL.
Example(s):

http://[ExportApiServerAddress]/api/WebExport/CombinedExport?mediaformat=WAV&idents=1,5,6,32,7

or

http://[ExportApiServerAddress]/api/WebExport/CombinedExport?mediaformat=WAV

{“idents”:”1,5,6,32,7”}
Possible Returns
  • 200 OK – Request was completed, information was returned, or element matching specified parameters was found.
  • 404 Not Found – Requested item (agent, device) could not be located due to missing body parameter(s), does not currently exist in the API tracker(s), or nothing was found that matched the criteria provided.
  • 500 Internal Server Error – Can be caused by service misconfiguration or other problems with the server outside the scope of the inContact WFO API services.

Email Export

Email export requests provide the requested file(s) in a compressed zip archive via email to the address specified.

SingleExport
Description

Emails the specified unique recording audio file in the indicated media format to the provided address within a compressed zip archive.
HTTP Method GET
URI

http://[ExportApiServerAddress]/api/EmailExport/SingleExport
Required Parameters
  • Uniquefield – Recording ident is the most reliable value, but if there is a unique identifier in another column – such as a specific call identifier being saved to a custom user field – that value can be used instead.
  • Uniquevalue – The value to match in the column specified in the Uniquefield value.
  • Mediaformat – MP3, WAV, or CAV.
  • Emailaddress – No specific character limits
Optional Parameters
  • Password – Only required if encrypt is specified as true
  • Encrypt – Only required for CAV encryption. Possible values are true or false.
Example(s):

http://[ExportApiServerAddress]/api/EmailExport/SingleExport?uniquefield=ident&uniquevalue=331&mediaformat=CAV&emailaddress=user@email.com&encrypt=true&password=******
Possible Returns
  • 200 OK – Request was completed, information was returned, or element matching specified parameters was found.
  • 404 Not Found – Requested item (agent, device) could not be located due to missing body parameter(s), does not currently exist in the API tracker(s), or nothing was found that matched the criteria provided.
  • 500 Internal Server Error – Can be caused by service misconfiguration or other problems with the server outside the scope of the inContact WFO API services.
MultiExport
Description

Collects specified unique recording audio files in the indicated media format and emails them to the specified address as separate files contained in a single compressed zip archive.
HTTP Method POST
URI

http://[ExportApiServerAddress]/api/EmailExport/MultiExport
Required Parameters
  • Mediaformat – MP3, WAV, or CAV.
  • Emailaddress – No specific character limits
Optional Parameters
  • Idents – A comma separated list of idents (the ID assigned by the inContact WFO database). The maximum URL length is 2000 characters. If exporting a large number of calls, list the idents in the request header as a comma-separated list instead of in the URL.
Example(s):

http://[ExportApiServerAddress]/api/EmailExport/MultiExport?mediaformat=WAV&emailaddress=user@email.com&idents=2,5,3,34,67,543,12

or

http://[ExportApiServerAddress]/api/EmailExport/MultiExport?mediaformat=WAV&emailaddress=user@email.com

{”idents”:”2,5,3,34,67,543,12”}
Possible Returns
  • 200 OK – Request was completed, information was returned, or element matching specified parameters was found.
  • 404 Not Found – Requested item (agent, device) could not be located due to missing body parameter(s), does not currently exist in the API tracker(s), or nothing was found that matched the criteria provided.
  • 500 Internal Server Error – Can be caused by service misconfiguration or other problems with the server outside the scope of the inContact WFO API services.
CombinedExport
Description

Merges specified unique recording audio files into a single recording file in the indicated media format in the order in which they appear in the database, then exports it via email within a compressed zip archive.
HTTP Method POST
URI

http://[ExportApiServerAddress]/api/EmailExport/CombinedExport
Required Parameters
  • Mediaformat – MP3, WAV, or CAV.
  • Emailaddress – No specific character limits
Optional Parameters
  • Idents – A comma separated list of idents (the ID assigned by the inContact WFO database). The maximum URL length is 2000 characters. If exporting a large number of calls, list the idents in the request header as a comma-separated list instead of in the URL.
Example(s):

http://[ExportApiServerAddress]/api/EmailExport/CombinedExport?mediaformat=MP3&emailaddress=user@email.com&idents=2,5,3,34,67,543,12

or

http://[ExportApiServerAddress]/api/EmailExport/CombinedExport?mediaformat=MP3&emailaddress=user@email.com

{”idents”:”2,5,3,34,67,543,12”}
Possible Returns
  • 200 OK – Request was completed, information was returned, or element matching specified parameters was found.
  • 404 Not Found – Requested item (agent, device) could not be located due to missing body parameter(s), does not currently exist in the API tracker(s), or nothing was found that matched the criteria provided.
  • 500 Internal Server Error – Can be caused by service misconfiguration or other problems with the server outside the scope of the inContact WFO API services.