Upload voice
PUT/bogunso/call/uploadHTTP/1.1
Host: api.alzwin.com
Upload the voice file. The AlzWIN test results are returned.
Request
Add the key 'x-body' to the header and put the string data in json format as the value.
Attach the audio file as a binary.
Request Property
Name | Tip | |
---|---|---|
ticketstring | Issued ticket | Required |
customerIdstring | Customer's ID | Required if profile is null |
profileobject | Who is being tested | Required if customerId is null |
birthyearnumber | Birth Year (4 digits) | Required if age is null |
agenumber | Age | Required if birthyear is null |
genderstring | Sex 'male' or 'female' | Required |
langstring | Test language code 'en', 'ko', 'zh-CN', 'ja', ... (more to come) | Required |
tagstring | About tags | |
extstring | Audio File Extensions 'wav', 'ogg', 'aac', 'ac3', 'mp3' | Required |
requestManualTypingbool | Whether to type the contents of the voice file Default false if null |
Request Example
- Case 1
- Case 2
// customerId uesd
{
"ticket": "RjlFrC1r6H",
"customerId": "fpTqo36jviI",
"lang": "en",
"tag": "lorem ipsum",
"ext": "ogg",
"requestManualTyping": false
}
// profile used
{
"ticket": "RjlFrC1r6H",
"profile": {
"birthyear": 1949, // Required if age is null
// "age": 77, // Required if birthyear is null
"gender": "male"
},
"lang": "en",
"tag": "lorem ipsum",
"ext": "ogg",
"requestManualTyping": false
}
Response
A successful response will return data in JSON format.
Response Property
Name | Tip | |
---|---|---|
estring | Error Information null if no error | |
msgstring | References for Error Causes May be returned on error | |
vobject | Test results in JSON format | |
tempScorenumber | Inaccurate temporary score based on STT | Required |
bogunsoCallIdstring | AlzWIN Test ID | Required |
Response Example
- Case 1
- Case 2
// success
{
"v": {
"bogunsoCallId": "644109f9db9de",
"tempScore": 43.41
}
}
// failure
{
"e": "invalid",
"msg": "lang must be specified"
}