API reference
VoiceState
The objects, fields and constraints behind the API.
| Field | Type & constraints |
|---|---|
profilerequired | VoiceProfile ↗ | null |
preferencesrequired | VoicePreferences ↗ |
revisionrequired | integer |
stalerequired | boolean | null |
latestJobrequired | VoiceJob ↗ | null |
View JSON schema
{
"type": "object",
"properties": {
"profile": {
"anyOf": [
{
"$ref": "#/components/schemas/VoiceProfile"
},
{
"type": "null"
}
]
},
"preferences": {
"$ref": "#/components/schemas/VoicePreferences"
},
"revision": {
"type": "integer"
},
"stale": {
"type": [
"boolean",
"null"
]
},
"latestJob": {
"anyOf": [
{
"$ref": "#/components/schemas/VoiceJob"
},
{
"type": "null"
}
]
}
},
"required": [
"profile",
"preferences",
"revision",
"stale",
"latestJob"
],
"additionalProperties": true
}