Legacy Dev Forum Posts

 View Only

Sign Up

Full list of return parameter for conversations api

  • 1.  Full list of return parameter for conversations api

    Posted 06-05-2025 18:25

    jho | 2023-03-11 00:06:47 UTC | #1

    https://developer.genesys.cloud/routing/conversations/conversations-apis

    We are trying to do integrate some conversation data into a reporting aggregation ui, but we can't seems to find the full list of parameter for the "api/v2/conversations/{conversationId}" (GET)

    Specifically we are looking for the return parameter for the following keys from the return json object

    "purpose" "participantType"

    However, the full list if available is also welcome.


    Ebenezer_Osei | 2023-03-13 15:41:41 UTC | #2

    Hi,

    Im not sure I understand your question, are you asking for a list of query parameters for GET api/v2/conversations/{conversationId}? If so, you should know that the endpoint has no query parameters. The response will always include all the necessary fields including purpose and participantType

    Best


    Eos_Rios | 2023-03-13 16:00:17 UTC | #3

    Ebenezer_Osei, post:2, topic:18844
    Im not sure I understand your question, are you asking for

    They want all possible values for the "purpose" and "participantType" enums


    Ebenezer_Osei | 2023-03-13 16:31:30 UTC | #4

    I got this from a similar endpoint.

    Hope it helps answer your question.

    Best


    SimonBrown | 2023-03-13 19:52:16 UTC | #5

    I believe the model shows these values even though the participantType is (I think looking at what I have seen in results) is referred to as conversationInitiator in the model.

    Conversation Model conversationInitiator

    Enum (acd, agent, api, botflow, campaign, customer, dialer, external, fax, group, inbound, ivr, manual, outbound, station, user, voicemail, workflow)

    Indicates the participant purpose of the participant initiating a message conversation.

    and purpose is shown as

    Enum (acd, agent, api, botflow, campaign, customer, dialer, external, fax, group, inbound, ivr, manual, outbound, station, user, voicemail, workflow)

    The participant's purpose.

    Simon


    John_Carnell | 2023-03-27 15:40:48 UTC | #6


    This post was migrated from the old Developer Forum.

    ref: 18844