Push.md

Survey Push API

The survey push API is a module in the survey platform that triggers at 5 minutes intervals and sends any new data over to a customer server using HTTP(S) POST with JSON data. If no new data is available, no requests will be sent.

The server side will have to respond with a HTTP 200 ok if the request was successfully received, if any HTTP error codes are returned then the request will be retried on the next trigger.

Property list

Property Name	Data Type	Description
id	Integer	Unique integer identifier for survey
surveyid	Integer	Manual survey id
agentid	String	Identifier for agent
queue	String	Identifier for queue
rating	String	End user's score
response	String	End user's reply
smsSentDate	String	Timestamp of the first SMS sent to the end user
team	String	Identifier for team
follow_up_response	String	End user's follow up response
name	String	End user's name
address	String	End user's address
street	String	End user's street name
housenumber	String	End user's housenumber
entry	String	End user's entry
postnumber	String	End user's post number
postArea	String	End user's post area
extraParamName1	String	1. extra parameter name
extraParamName2	String	2. extra parameter name
extraParamName3	String	3. extra parameter name
extraParamName4	String	4. extra parameter name
extraParamName5	String	5. extra parameter name
extraParamValue1	String	1. extra value
extraParamValue2	String	2. extra value
extraParamValue3	String	3. extra value
extraParamValue4	String	4. extra value
extraParamValue5	String	5. extra value
comment	String	Your comment
updated	String	Last modified

Example - Push of survey data using HTTP(S) POST with JSON

{
"callcenterSurveyList": [
    {
        "id": 4483,
        "surveyid": 0,
        "msisdn": "+4712345678",
        "agentid": "agent1",
        "queue": "queue1",
        "rating": "8",
        "response": "5 abc",
        "smsSentDate": "2016-10-21T15:23:43.423+0200",
        "team": "team1",
        "follow_up_response": null,
        "name": "Minh Do Le",
        "address": "Brynsveien 13 ; 0667 Oslo",
        "street": "Brynsveien",
	    "housenumber": "13",
		"entry": null,
	    "postnumber": "0667",
	    "postArea": "Oslo",
        "extraParamName1": "waitingTime",
        "extraParamName2": "callDuration",
        "extraParamName3": null,
        "extraParamName4": null,
        "extraParamName5": null,
        "extraParamValue1": "01:12:50",
        "extraParamValue2": "01:12:50",
        "extraParamValue3": null,
        "extraParamValue4": null,
        "extraParamValue5": null,
        "comment": "OK",
  		"updated": "2016-10-21T15:27:04.387+0200"      
    }
],
"manualSurveyList": []
}