/canvassResponses/resultCodes
Changed onResult Codes, or contact dispositions, are the result of a contact attempt. For example, Not Home, Wrong Number, Moved, etc. A successful contact interaction yields a Result Code called Canvassed which is automatically applied when canvass responses are submitted (e.g., when a Survey Response is recorded).
Unsuccessful contact attempts are what Result Codes are all about. This endpoint returns a list of those response codes available in the current context. Similar to Contact Types, Result Codes’ availability can vary by Input Type and/or Contact Type. For example, Wrong Number only makes sense in the context of a Call Contact Type. Moved only makes sense in the context of a Walk Contact Type.
Request
- Base URLhttps://api.securevan.com/v4
- URLhttps://api.securevan.com/v4/canvassResponses/resultCodes
- AuthHTTP basic
Query parameters
Optional; filter Result Codes to those available to the given Input Type
Optional; filter Result Codes to those available to the given Contact Type
Response
200
Example response
[
{
"resultCodeId": 18,
"name": "Busy",
"mediumName": "Busy",
"shortName": "BZ"
}
]Changes
- info
endpoint added
- info