Conventions and Case Sensitivity
Request conventions, canonical field names and enumerated value casing for the Outbound Voice Platform API.
Case sensitivity
All parameter names, JSON keys and enumerated values are case sensitive. Sending a field in the wrong case causes it to be ignored, and the request is rejected as missing a mandatory parameter or silently processed without the intended value.
Canonical field names
Send the form in the left column.
| Canonical form | Also seen as | Where it appears |
|---|---|---|
ukey | Ukey | All endpoints |
file | File | Bulk CSV upload form field |
apiName | Api Name | Webhook registration |
botName | botname | Voice Bot endpoints |
countofNumbers | countOfNumbers | All lead upload endpoints |
secretKey | ukey | Lead Action query string only |
Enumerated values
| Parameter | Permitted values | Convention |
|---|---|---|
retryType | C, R | Upper case, single character |
ssmlGender | MALE, FEMALE | Upper case |
language | en-IN, hi-IN | Lower case language, upper case region |
action (keypress) | PlayPrompt, Repeat | Pascal case |
isDND | true, false | Lower case |
Header prefixes | TXT_, NUM_, PLAY_ | Upper case, trailing underscore |
Next: Lead Upload or CDR Reference.