Get a Task Status

4 min

{ "name" "get a task status", "method" "get", "url" "https //api sandbox klavi ai/data/v1/tasks/{taskid}/status", "description" "get a task status by taskid", "tab" "examples", "examples" { "languages" \[ { "id" "zplrs rob9tcanmzvfzzx", "language" "curl", "code" "curl location globoff 'https //api sandbox klavi ai/data/v1/tasks/{taskid}/status' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" } ], "selectedlanguageid" "zplrs rob9tcanmzvfzzx" }, "results" { "languages" \[ { "id" "puufdsbrsudfm0c 2z5ec", "language" "200", "customlabel" "", "code" "{\n \\"code\\" 200,\n \\"message\\" \\"ok\\",\n \\"status\\" \\"success\\",\n \\"mfainfo\\" object,\n}" } ], "selectedlanguageid" "puufdsbrsudfm0c 2z5ec" }, "request" { "pathparameters" \[ { "name" "taskid", "kind" "required", "type" "string", "description" "unique identifier for the task", "children" \[] } ], "queryparameters" \[], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "bearer link token, it returned by the /links", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response name descritption code the status of task, only valid when the status is fail , other is 200 , the error code and message, please refer to the document for details docid\ atcomcnvoe13e8qxavfxg message only valid when the status is fail , other is ok status verify the status of mfa, the enumeration values are success ， fail , needmfa and pending if you want to customize error messages, please first check the status as fail before proceeding with customization based on the code number mfainfo only valid when the status is needmfa mfa type basic { "mfaid" 22 "mfatype" "basic" } contact { "mfaid" 30, "mfatype" "contact", "contact" "phone" } example { "mfaid" 30, "mfatype" "contact", "contact" "(99) 1234" } question { "mfaid" 32, "mfatype" "questions", "questions" \[ { "id" "100", "question" "test", "options" \[ { "label" "xxx", "value" "1" } ] } ] } example { "mfaid" 32, "mfatype" "questions", "questions" \[ { "id" "100", "question" "em qual desses municipios você reside ou já residiu?", "options" \[ { "label" "buriti dos montes", "value" "1" }, { "label" "sao goncalo do gurgueia", "value" "2" }, { "label" "nenhuma das alternativas", "value" "3" }, { "label" "sao pedro da cipa", "value" "4" }, { "label" "sao paulo", "value" "5" } ] } ] } multichoice { "mfaid" 51, "mfatype" "multichoice", "multichoices" \[ { "label" "xxx", "value" "1" } ] } example { "mfaid" 51, "authmethod" "multichoice", "multichoices" \[ { "label" "e mail", "value" "1" }, { "label" "sms", "value" "2" } ] }