{"info":{"_postman_id":"809d92ca-95c0-4c98-a14a-87e494127e27","name":"BPCC Interaction Content API","description":"

With the BPCC Interaction Content API you currently can:

Obtain general metadata for a service voice call.
Obtain a regular audio recording of a service voice call in GSM format (a regular recording includes all call segments and voices of all call participants).
Obtain audio recordings of individual participants in uncompressed PCM format (such recordings will be available if the multichannel call recording capability is enabled for your contact center).

This document specifies the corresponding REST API methods, with example requests and responses. You can load this API into the Postman API Development Environment to interact with the API with your own access tokens.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6711197","collectionId":"809d92ca-95c0-4c98-a14a-87e494127e27","publishedId":"S1EUtb1f","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-04-22T22:19:45.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Access Token","id":"0bc6e70d-12fc-4185-8556-25801b9f578d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"","description":"

Username of a BP user authorized to export recordings via API.

\n","type":"text"},{"key":"client_secret","value":"","description":"

API secret key generated for the above user.

\n","type":"text"},{"key":"scope","value":"","description":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text"},{"key":"grant_type","value":"","description":"

Grant type. Must be set to client_credentials.

\n","type":"text"}]},"url":"https://:tenant_url/configapi/v2/oauth/token","description":"

Returns an access token that will be used to authenticate each subsequent request made via this API.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","oauth","token"],"query":[],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"","key":"tenant_url"}]}},"response":[{"id":"f2bf3029-f2a2-4f55-965d-76124fafb828","name":"Get Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"admin","description":"[Username](https://help.brightpattern.com/5.2:Contact-center-administrator-guide/Users#Username) of a BP user authorized to [export recordings via API](https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Privileges#Allow_recording_export_API_access). \n","type":"text"},{"key":"client_secret","value":"X0vhlwMc6YoEbQDDqQGM9nOw8p7v9110rjTL1COxGBnpIAZvY6ryrrBQT5N28qS9","description":"API secret key generated for the above user.","type":"text"},{"key":"scope","value":"sasha.brightpattern.com","description":"Your contact center domain name, e.g., *example.brightpattern.com*.","type":"text"},{"key":"grant_type","value":"client_credentials","description":"Grant type. Must be set to *client_credentials*.","type":"text"}]},"url":{"raw":"https://:tenant_url/configapi/v2/oauth/token","protocol":"https","port":"tenant_url","path":["configapi","v2","oauth","token"],"variable":[{"key":"tenant_url","value":"sasha.brightpattern.com","description":"Your contact center domain name, e.g., example.brightpattern.com."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 22 Apr 2019 03:22:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"242"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"F25D3BD6FCF559A63CAA5BBE5021C238B0F1B57D3D7D3EA3C9B4FA779B549A20\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"3600\",\n \"scope\": \"sasha.brightpattern.com\"\n}"}],"_postman_id":"0bc6e70d-12fc-4185-8556-25801b9f578d"}],"id":"a300539f-5129-4a94-9d42-e1086b7d9eb3","description":"

The OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API. The authenticated user is checked for having appropriate privileges to perform the requested operation. The complete list of privileges can be found here. Privileges are assigned to users via one or more Roles.

To obtain an access token:

Login to your BPCC configuraiton portal.
Navigate to Users page.
Select or create a user with privilege Allow recording export API access.
Click the Generate button to generate an API secret key. Copy the generated key and note the username for the next steps.
Use the Get Access Token method to obtain an access token. Set the client_id to the username and client_secret to the generated API secrect key.
Use the value of access_token returned in the response to set the Authorization: Bearer [access token] header of each subsequent request made via this API.

\n","event":[{"listen":"prerequest","script":{"id":"830434b2-fdf6-4177-acf1-6ecaaa137df8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6541e414-87ee-4fbb-a0fc-359229bd1659","type":"text/javascript","exec":[""]}}],"_postman_id":"a300539f-5129-4a94-9d42-e1086b7d9eb3"},{"name":"Regular Call Recordings","item":[{"name":"Get Regular Recording Audio File","id":"e1142905-68c0-42e5-ad1b-e20e62ea9986","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://:tenant_url/configapi/v2/recordings/audio?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepid=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA&=","description":"

Returns an audio file with voices of all participants for the specified call recording in the GSM format.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","recordings","audio"],"query":[{"description":{"content":"

Global interaction identifier.

\n","type":"text/plain"},"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A"},{"description":{"content":"

Identifier of the step of the interaction for which the recording is to be retrieved. Can be obtained via scenario variable $(item.interactionStepId) or the callee_interaction_step_id field of the call_detail table of the Reporting Database.

\n","type":"text/plain"},"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA"},{"key":"","value":""}],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"","key":"tenant_url"}]}},"response":[{"id":"8d458bdc-3d87-4905-880c-b572610edb9f","name":"Get Audio File","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://:tenant_url/configapi/v2/recordings/audio?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepid=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA&=","protocol":"https","port":"tenant_url","path":["configapi","v2","recordings","audio"],"query":[{"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A","description":"[Global interaction identifier](https://help.brightpattern.com/5.2:Reporting-reference-guide/GlobalInteractionIdentifier)."},{"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","description":"Identifier of the step of the interaction for which the recording is to be retrieved. Can be obtained via scenario variable *$(item.interactionStepId)* or the *caller_interaction_step_id* field of the *call_detail* table of the Reporting Database."},{"key":"","value":""}],"variable":[{"key":"tenant_url","value":"sasha.brightpattern.com","description":"Your contact center domain name, e.g., example.brightpattern.com."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e1142905-68c0-42e5-ad1b-e20e62ea9986"},{"name":"Get Interaction Metadata","id":"c95712ce-7049-4885-8ac3-2edaabc1b5ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://:tenant_url/configapi/v2/recordings/metadata?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepid=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","description":"

Returns the following metadata for the specified interaction:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data Item	Description
Start Time	Interaction start time
Agent loginId	Username of the agent who last handled this call
Agent First Name	First name of the agent who last handled this call
Agent Last Name	Last name of the agent who last handled this call
Customer phone	Customer’s phone number (technically, the phone number of the party opposite to the above agent)
Direction	Call direction relative to the above agent, Inbound or Outbound
Service	Name of the service or campaign associated with this call
Disposition	Disposition selected by the agent for this interaction
Notes	Notes entered by the agent for this interaction
Voice Signature	Indicates whether the recording contains a vocie signature.
Flagged	Indicates whether the interaction was flagged by the agent.
Talk Time	Overall call duration.
RecordingId	Name of the file that contains the recording of this interaction.
Review URL	Link for direct access to the recording via the Contact Center Administrator application (login required).
Screen Recording	Indicates whether an agent screen recording is available for this interaction.

","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","recordings","metadata"],"query":[{"description":{"content":"

Global interaction identifier.

\n","type":"text/plain"},"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A"},{"description":{"content":"

Identifier of the step of the interaction for which metadata is being requested. Can be obtained via scenario variable $(item.interactionStepId) or the callee_interaction_step_id field of the call_detail table of the Reporting Database.

\n","type":"text/plain"},"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA"}],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"","key":"tenant_url"}]}},"response":[{"id":"2a3924d9-6e99-4096-b486-0536d01979da","name":"Metadata for a call with a live agent","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://:tenant_url/configapi/v2/recordings/metadata?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepid=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","protocol":"https","port":"tenant_url","path":["configapi","v2","recordings","metadata"],"query":[{"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A","description":"[Global interaction identifier](https://help.brightpattern.com/5.2:Reporting-reference-guide/GlobalInteractionIdentifier)."},{"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","description":"Identifier of the interaction step to be retrieved. Can be obtained via scenario variable *$(item.interactionStepId)* or the *caller_interaction_step_id* field of the *call_detail* table of the Reporting Database."}],"variable":[{"description":"Your contact center domain name, e.g., *example.brightpattern.com*.","key":"tenant_url","value":"sasha.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Fri, 15 Mar 2019 20:21:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"603"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Start Time\": \"03/15/2019 07:49:31 PM UTC +00:00\",\n \"Agent loginId\": \"navarro\",\n \"Agent First Name\": \"Jose\",\n \"Agent Last Name\": \"Navarro\",\n \"Customer phone\": \"Restricted\",\n \"Direction\": \"INBOUND\",\n \"Service\": \"Support\",\n \"Disposition\": \"Solved\",\n \"Notes\": \"\",\n \"Voice Signature\": \"0\",\n \"Flagged\": \"0\",\n \"Talk Time\": \"0:38\",\n \"RecordingId\": \"20190315124931_Restricted_navarro_C6A1ECF16C4E4D13B848718273ECB0CA.wav\",\n \"Global Interaction ID\": \"A44B62DE-75FB-47CD-A103-8F778CD1032A\",\n \"Review URL\": \"https://sasha.brightpattern.com/admin?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepId=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA\",\n \"Screen Recording\": \"0\"\n}"},{"id":"9137fc94-3e21-4345-a5fa-b6c4553a9c97","name":"Metadata of IVR-only Call","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://:tenant_url/configapi/v2/recordings/metadata?giid=9F63B008-4BA3-4022-90F7-A8B99ED1A3E8&stepid=89B5E090-F584-4AAA-973A-02C0524BF9CB","protocol":"https","port":"tenant_url","path":["configapi","v2","recordings","metadata"],"query":[{"key":"giid","value":"9F63B008-4BA3-4022-90F7-A8B99ED1A3E8","description":"[Global interaction identifier](https://help.brightpattern.com/5.2:Reporting-reference-guide/GlobalInteractionIdentifier)."},{"key":"stepid","value":"89B5E090-F584-4AAA-973A-02C0524BF9CB","description":"Identifier of the interaction step to be retrieved. Can be obtained via scenario variable *$(item.interactionStepId)* or the *caller_interaction_step_id* field of the *call_detail* table of the Reporting Database."}],"variable":[{"description":"Your contact center domain name, e.g., *example.brightpattern.com*.","key":"tenant_url","value":"sasha.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Fri, 15 Mar 2019 19:41:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"583"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Start Time\": \"02/27/2019 01:04:52 AM UTC +00:00\",\n \"Agent loginId\": null,\n \"Agent First Name\": null,\n \"Agent Last Name\": null,\n \"Customer phone\": \"Restricted\",\n \"Direction\": \"INBOUND\",\n \"Service\": \"Sales\",\n \"Disposition\": \"No agent\",\n \"Notes\": \"\",\n \"Voice Signature\": \"0\",\n \"Flagged\": \"0\",\n \"Talk Time\": \"0:11\",\n \"RecordingId\": \"20190226170452_Restricted_89B5E090F5844AAA973A02C0524BF9CB.wav\",\n \"Global Interaction ID\": \"9F63B008-4BA3-4022-90F7-A8B99ED1A3E8\",\n \"Review URL\": \"https://sasha.brightpattern.com/admin?giid=9F63B008-4BA3-4022-90F7-A8B99ED1A3E8&stepId=89B5E090-F584-4AAA-973A-02C0524BF9CB\",\n \"Screen Recording\": \"0\"\n}"}],"_postman_id":"c95712ce-7049-4885-8ac3-2edaabc1b5ad"},{"name":"Erase Call Recordings","id":"891e387b-ee31-4782-b128-8d593ba73816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https:///configapi/v2/recordings/audio?giid=&reason=","description":"

This method erases locally stored call recordings; the interaction’s Global Interaction Identifier (GIID) must be included as a query parameter in the request URL

Notes

Reason is an optional query parameter.
This method applies to locally stored recordings only.
If multiple recordings are associated with the specified GIID, all of them will be erased.
The erasure of recordings is:
- Tracked via the Audit Log
- Reflected in Interaction Records Search Results
- Reflected in case activity history
\n

\n","urlObject":{"protocol":"https","path":["configapi","v2","recordings","audio"],"host":[""],"query":[{"description":{"content":"

The interaction's Global Interaction Identifier

\n","type":"text/plain"},"key":"giid","value":""},{"description":{"content":"

(Optional) The reason for erasing the recording(s)

\n","type":"text/plain"},"key":"reason","value":""}],"variable":[]}},"response":[{"id":"9b52795c-4909-4e1b-97f3-181f220a70ca","name":"Erase Call Recordings","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/recordings/audio?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&reason=credit_card_info","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","recordings","audio"],"query":[{"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A"},{"key":"reason","value":"credit_card_info"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"891e387b-ee31-4782-b128-8d593ba73816"}],"id":"ee890919-33af-4876-a45e-86798ac31aef","description":"

These methods enable retrieval of regular voice recordings (i.e., recordings where voices of all participating parties are recorded in the same audio file) and the related call metadata. Both audio files and metadata can be retrieved immediately upon call termination. Parameters required for recording identificaiton can be obtained via scenario variables $(item.globalInteractionId) and $(item.interactionStepId).\nRegular call recordings are exported in GSM format.

\n","event":[{"listen":"prerequest","script":{"id":"8fc0f216-e6cf-44c9-974b-f55430e3236c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"45640944-0074-4b65-b880-ce0eae67a921","type":"text/javascript","exec":[""]}}],"_postman_id":"ee890919-33af-4876-a45e-86798ac31aef"},{"name":"Multichannel Call Recordings","item":[{"name":"Get Multichannel Recording Structure","id":"64930044-62e3-4e02-82e2-a97433cbac7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://:tenant_url/configapi/v2/multi_channel_recordings?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A","description":"

This method is used to get information about the structure of a specific multichannel call recording. The call is identified by the Global Interaction Identifier (GIID). This article describes the various ways the GIID of a call can be obtained.

The API response is an array of objects, where each object contains the metadata for a specific interaction related to the GIID.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
_id	Internal use only.
tenant_id	Internal use only.
global_interaction_id	The GIID of this interaction. (The same GIID that was used to get this metadata.)
interaction_id	The GIID may refer to several related interactions (for example, a primary customer-agent call and a related consult call). Thus, in addition to the GIID, each interaction has a globally unique interaction_id. Each interaction has a list of parties.
parties	An array of Party Objects, where each object contains information about a participant in the call. See the Party Object structure below.

Party Object

The parties array contains one or more Party Objects.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
party_id	Identifier of a party within the interaction identified by the interaction_id. Note that this identifier is used exclusively for retrieval of the party's audio via the Get Party Audio File method and is not intended to be used for any other purposes.
party_type	USER - the given party is a configured BPCC user (typically, an agent); CONTACT - the given party is a known customer; UNIDENTIFIED - the given party could not be identified as either a BPCC user or a known customer.
first_name	Party's first name if available.
last_name	Party's last name if available.
phone	Party's phone number used for the given call if available.
user_id	Internal use only.
recordings	An array of Recording Segment Objects. Because call recording can be stopped and started, each party can have multiple segments. See the Recording Segment Object structure below.

Recording Segment Object

The recordings array contains one or more Recording Segment Objects.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
duration	The duration of this specific recording segment, in seconds (returned as a string).
start_time	The UTC timestamp for when the recording segment began, in ISO 8601 format.

","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","multi_channel_recordings"],"query":[{"description":{"content":"

Global interaction identifier.

\n","type":"text/plain"},"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A"}],"variable":[]}},"response":[{"id":"6e9052fb-7a85-4be7-95f8-fcd8ced306fb","name":"Multichannel recording description for a simple call","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://:tenant_url/configapi/v2/multi_channel_recordings?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A","protocol":"https","port":"tenant_url","path":["configapi","v2","multi_channel_recordings"],"query":[{"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A","description":"[Global interaction identifier](https://help.brightpattern.com/5.2:Reporting-reference-guide/GlobalInteractionIdentifier)."}],"variable":[{"key":"tenant_url","value":"sasha.brightpattern.com","description":"Your contact center domain name, e.g., *example.brightpattern.com*."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Fri, 15 Mar 2019 21:22:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n{\n \"_id\": \"685a29343a36e54583e5952c\",\n \"tenant_id\": \"C809D1F5-84C2-447E-AA03-E3D5000BA779\",\n \"global_interaction_id\": \"6F5D2671-0574-46F8-8417-EB0EA985A751\",\n \"interaction_id\": \"0FABD496-A231-4411-82BD-C68262862F36\",\n \"parties\": [\n {\n \"first_name\": \"Susan\",\n \"last_name\": \"Mallorie\",\n \"party_id\": \"6C631399-D74A-4F6E-AF17-523A286817DA\",\n \"party_type\": \"USER\",\n \"phone\": \"1000\",\n \"recordings\": [\n {\n \"duration\": \"37\",\n \"start_time\": \"2025-06-24T04:26:32.427Z\"\n }],\n \"user_id\": \"0EB98877-9517-4CB6-87C3-4A46EF6E6087\"\n },\n {\n \"first_name\": \"Allen\",\n \"last_name\": \"Hartzell\",\n \"party_id\": \"AB694080-1C65-4C5D-B893-0FEEE9CBCFDA\",\n \"party_type\": \"USER\",\n \"phone\": \"2042\",\n \"recordings\": [\n {\n \"duration\": \"37\",\n \"start_time\": \"2025-06-24T04:26:32.427Z\"\n }],\n \"user_id\": \"390FE1FC-1FBE-43C2-A527-32B39BD63036\"\n }]\n}]"}],"_postman_id":"64930044-62e3-4e02-82e2-a97433cbac7c"},{"name":"Get Multichannel Recording Segment Audio File","id":"c1afb3f6-202e-49e0-955e-9aa48772d08c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer 4AE7486E2E7BCFB2D977D3829D0781357A7D831D9C92B32ACF5863CDF2C2CC05","type":"text"}],"url":"https://:tenant_url/configapi/v2/multi_channel_recordings/audio?giid=B3178008-47BA-4CAB-B620-CB3C8864BCB6&iid=A274FC70-770E-45B0-AC77-491EF6CD8E05&party=98141181&recid=0","description":"

Gets the desired segment of a multichannel recording identified by the GIID, interaction ID, party ID, and optionally the ordinal number of the desired segement. The latter is essential only if according to your practices recording may be stopped and started again while a call is in progress.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","multi_channel_recordings","audio"],"query":[{"description":{"content":"

Global interaction identifier. Letters in the GIID must be in uppercase.

\n","type":"text/plain"},"key":"giid","value":"B3178008-47BA-4CAB-B620-CB3C8864BCB6"},{"description":{"content":"

Identifier of the interaction for which a recording is being requested. (Returned by the Get Multi-channel Recording Metadata method.) Letters in the identifier must be in uppercase.

\n","type":"text/plain"},"key":"iid","value":"A274FC70-770E-45B0-AC77-491EF6CD8E05"},{"description":{"content":"

Identifier of the party whose audio recording is being requested. (Returned by the Get Multi-channel Recording Metadata method.)

\n","type":"text/plain"},"key":"party","value":"98141181"},{"description":{"content":"

Ordinal number (starting from 0) of the desired recording segment of the above party. Optional; if not specified, the first segment in the array is returned.

\n","type":"text/plain"},"key":"recid","value":"0"}],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"","key":"tenant_url"}]}},"response":[],"_postman_id":"c1afb3f6-202e-49e0-955e-9aa48772d08c"}],"id":"508f3a7f-0813-4b6b-99a6-9db8b1901a23","description":"

These methods are used to extract individual segments of multichannel call recordings (i.e., recordings where voice of each paricipating party is recorded into a separate audio file).

The Get Multichannel Recording Structure method should be used first to obtain the Interaction IDs, Party IDs, and optionally segments, to be used in the subsequent Get Multichannel Recording Segment Audio File requests.

Segments of multichannel recordings are available for export immediately upon call termination.

Segments of multichannel recordings are exported in uncompressed PCM format for maximun speech quality. Note that because of the large size of multichannel PCM recording files, they are typically stored in the system for a limited amount of time. Check with your service provider about your limits, and consider overnight export of selected recordings for the previous working day.

\n","event":[{"listen":"prerequest","script":{"id":"1540d080-5b84-44c0-b20e-96c1cae68231","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0cee1497-0d59-4190-a62c-1c6416b2faaf","type":"text/javascript","exec":[""]}}],"_postman_id":"508f3a7f-0813-4b6b-99a6-9db8b1901a23"},{"name":"Error Codes","item":[],"id":"cd778b47-9f11-4ca4-9f16-d289a617f18e","description":"

400 Bad Request - Indicates that the requested operation cannot be performed either because it violates data integrity rules or not supported by the API. The body of the error message may contain information about a specific element of the request (e.g., a specific object property) that is causing the request to be rejected.
\n
401 Authentication Failed
\n
403 Not Authorized - The user is authenticated but does not have sufficient privileges to perform the requested operation.
\n
404 Not Found - For GET methods, indicates that the requested interaction or audio file cannot be found.
\n
415 Unsupported Media Type - The media type is either not specified or specified incorrectly.
\n
500 Request Failed - Incorrect endpoint specification.
\n

\n","event":[{"listen":"prerequest","script":{"id":"420b721e-6e6c-4db3-a0bb-aeff7bcf51eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f4c87bb4-b030-497e-9dd7-e6c9a94cf0de","type":"text/javascript","exec":[""]}}],"_postman_id":"cd778b47-9f11-4ca4-9f16-d289a617f18e"}],"event":[{"listen":"prerequest","script":{"id":"adee3ff1-168a-43c1-9358-b16ce0e2a2ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"10fafed6-72ad-4dd2-a7aa-0058be800101","type":"text/javascript","exec":[""]}}]}