Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 4 days ago

    Hello Team, 

    we are using the Genesys Webmessaging, we would like to download the chat transcript of the conversation when customer ends the chat. Is this the correct API to call? if yes, how do we get the conversation ID and communication ID. This is for the Chat flow I'm asking for. 

    /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl

    #WebMessaging

    ------------------------------
    Kamesh S
    ------------------------------


  • 2.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 3 days ago

    You can get both IDs from the conversation details:

    1. The conversationId is the ID of the Genesys interaction.
    2. Then, use this API to get the SessionID:
    • GET /api/v2/analytics/conversations/{conversationId}/details
    1. In the customer participant, look for the messaging session. The sessionId is the value you should use as the communicationId, then call the API:
    • GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{sessionId}/transcripturl

    One thing to keep in mind is that the transcript may not be available immediately when the customer ends the conversation, since Speech and Text Analytics processing can occur after the interaction.



    ------------------------------
    Leonardo Teixeira
    NA
    ------------------------------



  • 3.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 3 days ago

    Hey Leonardo , 

    Thanks for your response, 

    I'd like to know how do we get the conversation ID from the UI? or is it exposed only on the agent portal? We are trying to get the chat transcript by making API Calls. If conversation ID can be fetched via API I need that details as the API explorer doc is bit confusing. :) Could you help me with the details? 



    ------------------------------
    Kamesh S
    ------------------------------



  • 4.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 3 days ago
    Edited by Phaneendra Avatapalli 2 days ago

    Hi Kamesh,

    Yes, you can get the conversationId from both the Genesys Cloud UI and via API.

    In the UI, you can find it from Performance > Workspace > Interactions. You can add the Conversation ID column, and it is also available from the interaction details/URL. Genesys has a short guide here:

    https://help.genesys.cloud/video/finding-the-conversation-id/

    If you're retrieving it programmatically, you can use:

    POST /api/v2/analytics/conversations/details/query

    to search completed Web Messaging interactions using your required filters. The response will contain the conversationId. Then you can follow Leonardo's steps:

    conversationIdGET /api/v2/analytics/conversations/{conversationId}/details → customer messaging sessionId → transcript URL API.

    So you don't need to rely on the agent portal to obtain it.



    ------------------------------
    Phaneendra
    Technical Solutions Consultant
    ------------------------------



  • 5.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 3 days ago

    Hi Phaneendra, 

    I use the API explorer to test the API to see if we are getting response, I followed your steps to obtain the conversation ID programmatically, but the filter has lot of options which is kind of complex, If I want to get the conversation ID of a person say 'abc@zz.com' email with a particular interval, how do I do it? Also i just used a 1 day interval to pull the data and I get the Production chat conversation in the response when i use this API

    POST /api/v2/analytics/conversations/details/query

    anything I'm doing incorrectly? 



    ------------------------------
    Kamesh S
    ------------------------------



  • 6.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 2 days ago

    Hi Phaneendra, 

    Could you help me with the above query please? 



    ------------------------------
    Kamesh S
    ------------------------------



  • 7.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 2 days ago
    Edited by Phaneendra Avatapalli 2 days ago

    Hi Kamesh,

    You're not doing anything incorrectly. If you only specify a 1-day interval in:

    POST /api/v2/analytics/conversations/details/query

    then you'll get conversations matching that interval, which explains why you're seeing multiple production Web Messaging conversations.

    For abc@zz.com, I think the important part is how that email address is associated with the Web Messaging interaction. Is the customer identified/linked as an External Contact, or are you simply asking for the email address in the bot/message flow and storing it as a value?

    If the interaction is associated with an External Contact, we can look at using that identity to narrow down the conversation. If the email is only being captured within the flow, we would need to look at where/how that value is stored before deciding what Analytics filter can be used.

    If you let us know how abc@zz.com is being captured or associated with the Web Messaging interaction, we can narrow down the appropriate way to retrieve the conversationId.

    But the results you're getting from the one-day interval query itself sound expected.



    ------------------------------
    Phaneendra
    Technical Solutions Consultant
    ------------------------------



  • 8.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 2 days ago
    Edited by Kamesh S 2 days ago

    Hi Phaneendra,

    Thanks for the follow-up. To answer your question - the email is populated in the webmessaging participant data, we have a registration form before starting the chat (we use headless) so we have registration form, customer fills the data, and those data sent in participant data upon chat connection with the agent. And, yeah this data is used to create a external contact in the genesys portal.

    customAttributes: {

        "_genesys_url": "https://www.abc.com/webchat/jewelry",

        "EmailAddress": "abc@zzz.com",

        "FirstName": "abc",

        "LastName": "zz"

    }

    could you tell me what Analytics filter (if any) would let me search by this email directly? Or is there any other way to narrow it down? 



    ------------------------------
    Kamesh S
    ------------------------------



  • 9.  RE: How do we get Conversation ID and Communication ID to download the Chat transcript?

    Posted 2 days ago

    Hi Kamesh,

    Thanks, that helps clarify the setup.

    Since the email is initially being passed as Participant Data, I don't believe EmailAddress = abc@zzz.com can simply be used as a filter in the Conversation Details Analytics query.

    However, since you're also creating/linking an External Contact, that may give you another way to identify the interaction. Genesys documents that when an External Contact is linked to an interaction, the interaction is added to that contact's interaction history, including message interactions:

    https://help.genesys.cloud/articles/view-interaction-history-contact/

    I would first confirm that the Web Messaging interaction is actually linked to the External Contact, rather than the contact only being created from the Participant Data.

    If it is linked, the External Contact relationship may be a better route for locating the corresponding interaction/conversation ID than trying to filter Analytics directly by the custom EmailAddress Participant Data attribute.

    Hope someone from community might add more to this.



    ------------------------------
    Phaneendra
    Technical Solutions Consultant
    ------------------------------