Workforce Engagement Management

Sign Up

Expand all | Collapse all

Documentation for Survey API Release 19th January

  • 1.  Documentation for Survey API Release 19th January

    Posted 22 days ago

    Has anyone seen documentation on this new API? I can't see anything in the API Explorer or preview APIs. The resource center seems to be broken at the moment with lots of Page Not Found messages.

    A number of users are referencing in the idea that they can't find any information.

    https://genesyscloud.ideas.aha.io/ideas/WEM-I-287


    #CustomerSurveys

    ------------------------------
    Richard Chandler
    Connect
    ------------------------------


  • 2.  RE: Documentation for Survey API Release 19th January
    Best Answer

    Posted 20 days ago
    Edited by Richard Chandler 20 days ago
      |   view attached

    Hi Richard,

    Received the attached yesterday with the a link to the API endpoint of: post/api/v2/quality/surveys - Create a survey for a conversation.

    Regards,



    ------------------------------
    Neil Jones
    Voice Comms Lead
    Awaze Uk
    neil.jones@awaze.com
    ------------------------------



  • 3.  RE: Documentation for Survey API Release 19th January

    Posted 20 days ago

    Thanks Neil,

    I also saw an email this morning. Would have been helpful to have that with the release notes.



    ------------------------------
    Richard Chandler
    Connect
    ------------------------------



  • 4.  RE: Documentation for Survey API Release 19th January

    Posted 20 days ago

    Indeed.

    Understand it's early days, but I've built a quick journey using a data action to call the API and then insert the URL to the chat - works as expected. What's not clear is the comment from Genesys (highlighted below) how we interject the survey URL when a chat has completed (post agent), as from memory there isn't a 'Set Post-Flow' node available in either a digital bot or inbound message flow.

    Regards,



    ------------------------------
    Neil Jones
    Voice Comms Lead
    Awaze Uk
    neil.jones@awaze.com
    ------------------------------



  • 5.  RE: Documentation for Survey API Release 19th January

    Posted 20 days ago

    Hi Neil,

    Post Flow Action in Architect Message Flows is due next week so you'll be able to use that.

    In my case I wanted to create a survey without an agent so created a workflow that managed the end to end process.



    ------------------------------
    Richard Chandler
    Connect
    ------------------------------



  • 6.  RE: Documentation for Survey API Release 19th January

    Posted 20 days ago

    Yes, I've just come across this: https://genesyscloud.ideas.aha.io/ideas/DIG-I-1027

    Our digital bots do have self service options so would work for those scenarios.

    Hopefully this does come with next weeks release.

    Regards, 



    ------------------------------
    Neil Jones
    Voice Comms Lead
    Awaze Uk
    neil.jones@awaze.com
    ------------------------------



  • 7.  RE: Documentation for Survey API Release 19th January

    Posted 13 days ago
      |   view attached

    Hi Richard and Neil,

    Thank you for your valuable feedback. Post Flow Action in Message Flows is live now and I have attached a document on the steps of getting the API to display a web survey link directly inside the Genesys Web Messenger immediately after an interaction ends.

    Thank you

    Hari



    ------------------------------
    Hari Dasaratharaman
    Principal Product Manager
    ------------------------------



  • 8.  RE: Documentation for Survey API Release 19th January

    Posted 13 days ago

    Thank you Hari for taking the time to produce this guide - very useful.

    Have one question... in your survey inbound message flow, where you depict sending a response after the successful data action call. What response message string was use to create a hyper-link, as I used a digit bot to perform this.

    Regards,



    ------------------------------
    Neil Jones
    Voice Comms Lead
    Awaze Uk
    neil.jones@awaze.com
    ------------------------------



  • 9.  RE: Documentation for Survey API Release 19th January

    Posted 13 days ago

    Hi Neil - Here's the markup I'm using in my lab for the Send Response block after generating the survey URL from data action:

    "We're always improving-your feedback helps. Please share your thoughts in our quick survey.\n[Take Survey](" + State.surveyUrl + ")"



    ------------------------------
    Lonny Schwartz
    Principal PS Consultant
    ------------------------------



  • 10.  RE: Documentation for Survey API Release 19th January

    Posted 10 days ago

    Super, thank you.



    ------------------------------
    Neil Jones
    Voice Comms Lead
    Awaze Uk
    neil.jones@awaze.com
    ------------------------------



  • 11.  RE: Documentation for Survey API Release 19th January

    Posted 9 days ago

    I am getting a failure occurred, which I think is with my output contract configuration. I created the output customerSurveyUrl as a string? My jSON is 

    {
      "title": "SurveyCreateOutput",
      "type": "object",
      "required": [
        "customerSurveyURL"
      ],
      "properties": {
        "customerSurveyURL": {
          "type": "string"
        }
      }
    }


    ------------------------------
    Martin Bunting
    New Era Technology
    Senior Solutions Consultant
    ------------------------------



  • 12.  RE: Documentation for Survey API Release 19th January

    Posted 9 days ago

    Hi Martin, 

    Here's my data action setup to retrieve the surveyUrl:

    Input:

    {
      "type": "object",
      "properties": {
        "conversationId": {
          "type": "string"
        },
        "surveyFormContextId": {
          "type": "string"
        }
      }
    }
    Output:
    {
      "type": "object",
      "properties": {
        "customerSurveyUrl": {
          "type": "string"
        }
      }
    }


    ------------------------------
    Lonny Schwartz
    Principal PS Consultant
    ------------------------------



  • 13.  RE: Documentation for Survey API Release 19th January

    Posted 9 days ago

    I got it working; thanks for your help.  I did have to modify the Send Response to get the clickable link to work properly.

     



    ------------------------------
    Martin Bunting
    New Era Technology
    Senior Solutions Consultant
    ------------------------------