Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  API Key for third party system

    Posted 04-08-2025 13:55

    Does any body knows how to pull the recordings through the API along with the call audio, we need to ensure the following permissions are enabled for the API key set up for EvaluAgent in our Genesys account:

    • Recording > screen and recording > view
    • AND
    • Recording >screen and recording >download

      Thanks in advance

    #API/Integrations

    ------------------------------
    Rechelle McConnell
    CHRISTIAN BROADCASTING NETWORK
    ------------------------------


  • 2.  RE: API Key for third party system

    Posted 04-08-2025 15:18

    Hello Rechelle,

    I have moved your post to our Genesys Cloud - Developer Community. I was looking at our API Explorer and you may want to look into the following API call:

    https://developer.genesys.cloud/devapps/api-explorer-standalone#get-api-v2-conversations--conversationId--recordings



    ------------------------------
    Jason Kleitz
    Online Community Manager/Moderator
    ------------------------------



  • 3.  RE: API Key for third party system
    Best Answer

    Posted 04-08-2025 15:30

    Hi Rechelle,

    These permissions are specifically for screen recordings, not the standard call audio recordings.

    To pull call audio recordings via the API, the essential permission you need for the OAuth client (API key set) used by EvaluAgent is:

    1. recording:recording:view (Essential for Full Downloads)

      • This is the primary permission required for most call audio download scenarios.
      • It allows the API client (like EvaluAgent) to:
        • Access the metadata of call recordings associated with conversations.
        • Retrieve the specific details of a recording, critically including the secure download links (mediaUris) needed to fetch the entire audio file.
    2. recording:recordingSegment:view (Needed for Segment Access)

      • This permission grants access to specific segments or parts within a recording.
      • It's typically used in scenarios like:
        • Quality Management evaluations where an evaluator might only need access to specific portions of the call.
        • Detailed analysis that requires interacting with timing or data associated with specific segments of the conversation.
      • Necessity: For the standard goal of downloading the complete, full audio file, this permission is usually NOT required. However, if EvaluAgent's specific integration method involves interacting with or retrieving data based on recording segments, then this permission would be necessary.

    Other Potentially Relevant Permissions:

    • conversation:conversation:view: Often needed to initially find the conversationId for the calls whose recordings you want to download (e.g., searching by date, participant, etc.).

    The typical API flow for downloading involves:

    1. Finding the conversationId.
    2. Using GET /api/v2/conversations/{conversationId}/recordings to list available recordings for that conversation.
    3. Using GET /api/v2/conversations/{conversationId}/recordings/{recordingId} to get details for a specific recording, which includes the download URLs in the mediaUris object.
    4. Using the provided signed URL from mediaUris to download the media file directly from the storage location (this step itself doesn't usually require a Genesys Cloud permission check, as the URL is pre-signed and time-limited).


    ------------------------------
    Orhun Sahin
    Software Development Engineer
    ------------------------------



  • 4.  RE: API Key for third party system

    Posted 04-14-2025 16:10

    Thank you so much for this. I appreciate!



    ------------------------------
    Rechelle McConnell
    CHRISTIAN BROADCASTING NETWORK
    ------------------------------