Overview
The following use-cases (with curl language examples) are a guide for your app development. To return a score for a user, this version requires two back-to-back voice samples that have passed the elicitation checks.
Notes:
Guidelines for recording audio in the mobile app for “Ahhh” are available at Sonde's Respiratory (V2) Mobile App Implementation Note
Detail information on Respiratory Symptoms Risk is available at Respiratory Symptoms Risk
...
Replace <access_token> with the value of the access_token attribute of Response1.
...
Note - Partners can send their userIdentifier in query parameter in below API if they wish to register a user with Sonde Heath using their user identifier, this will help Partners to map Sonde data
For Api details Please check the REST API Reference .
| Code Block |
|---|
$ curl --request POST 'https://api.sondeservices.com/platform/v2/users' \ --header 'Authorization: <access_token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "yearOfBirth": "1985", "gender": "Female", "language": "HINDI", "device": { "type": "MOBILE", "manufacturer": "VIVO" } }' |
Response2:
Capture the userIdentifier, in the below response wiNODNXcm.
...
Call Storage Service to get the signed URL. In the Authorization header put the value of the access_token attribute from Response1 and the country-code in which you want to upload the wave file. (
For supported country codes
...
and audio meta info Please check the REST API Reference
...
.
For better measure accuracy it is recommended to upload the audio file which has the elicitation mentioned on page Respiratory Symptoms Risk.
...
| Code Block |
|---|
$ curl --request POST 'https://api.sondeservices.com/platform/v1/storage/files' \
--header 'Authorization: <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"fileType": "wav",
"countryCode": "US",
"userIdentifier": "<userIdentifier>",
"audioMetaInfo": {
"microphone": "DEVICE",
"capturingMode": "CUED",
"os": "IOS",
"application": "APP",
"device": "MOBILE",
"deviceModel": "Iphone 14"
}
}' |
Response3:
The response is shown for illustration purposes.
...
Provided filePath should be present on Server
Perform elicitation check configured for the given measure. For example Ahh elicitation check
Audio file duration should be as per Respiratory Symptoms Risk
Audio file should be as per Audio Format Specifications
Note: Your app should gracefully handle any extra validation which may be added in future releases of the Sonde API Platform.
Replace <filePath> with the value of filePath attribute of Response3.
...
Provided filePath should be present on Server
Perform elicitation check configured for the given measure. For example Ahh elicitation
The user of this audio file should match with the user of the first audio file
Previously added audio file and this audio file should be different
Audio file duration should be as per Respiratory Symptoms Risk
Country of a previously added audio file and this audio file should be same
The audio file should be as per Audio Format Specifications
Note: Your app should gracefully handle any extra validation which may be added in future releases of Sonde API Platform.
Replace <inferenceParameterId> with the value of id attribute of Response5.
Replace <filePath> with the value of filePath attribute of Response6.
...