IVR and prompt error codes (mpbx-ivr)
Raised when IVR menus and the prompt library are edited (W3-TEL-07). Messages name fields, ids
and node ids; they never contain the audio, collected digits or caller numbers. Guide:
IVR menus and prompts. Flow-level problems (a published version that cannot
change, a flow that is still jumped to) keep the MPBX-FLOW-* codes of
call flows.
IVR
| Code | Kind | Meaning | What to do |
|---|---|---|---|
MPBX-IVR-INVALID | invalid_argument | The settings failed validation: a bad key, number, timeout or prompt path, a missing allow-list, or (on publish) a problem with something the IVR refers to. The API answer lists every problem with its field. | Fix each listed field and save or publish again. |
MPBX-IVR-NOT-FOUND | not_found | No such IVR in this company (another company's IVR is invisible), or the flow is not an IVR. | Check the id. |
MPBX-IVR-NOT-FORM | conflict | The flow's graph is not exactly what the IVR form writes: it was changed outside the form (for example in the visual designer). The form refuses to read or overwrite it so no node is lost. | Edit it in the designer, or create a new IVR with the form. |
MPBX-IVR-CHANGED | conflict | The IVR changed since you read it (If-Match does not match). | Read it again and retry. |
MPBX-IVR-PROMPT-MISSING | invalid_argument | A prompt the IVR plays is not in the company's prompt library (reported as a problem on its field). | Upload the prompt or pick another. |
MPBX-IVR-DESTINATION-INVALID | invalid_argument | A destination does not exist, has the wrong kind, or is another flow that is not a published IVR (reported as a problem on its field). | Pick an existing destination. |
MPBX-IVR-NOTHING-TO-PUBLISH | conflict | There is no draft: the live version already has every change. | Nothing to do. |
Prompts
| Code | Kind | Meaning | What to do |
|---|---|---|---|
MPBX-PROMPT-NOT-FOUND | not_found | No such prompt in this company. | Check the id. |
MPBX-PROMPT-AUDIO-INVALID | invalid_argument | The upload is not MP3, WAV or Ogg Vorbis audio the system can read: unknown format (the bytes are checked, not the file name), a damaged file, an unsupported codec (for example AAC or Opus), more than two channels, or an unusable sample rate. | Convert the file to MP3, WAV or Ogg Vorbis and upload it again. |
MPBX-PROMPT-TOO-LARGE | invalid_argument | The upload is larger than 25 MiB. | Upload a shorter or more compressed file. |
MPBX-PROMPT-TOO-LONG | invalid_argument | The audio is longer than 10 minutes. | Split the file. |
MPBX-PROMPT-NAME-TAKEN | conflict | Another prompt of the company has this name. | Choose another name. |
MPBX-PROMPT-IN-USE | conflict | An IVR or call flow (its live version or a draft) still plays this prompt. | Change those first, then delete. |
MPBX-PROMPT-CHANGED | conflict | The prompt changed since you read it (If-Match does not match). | Read it again and retry. |
MPBX-PROMPT-LIMIT | conflict | The company already has 1000 prompts. | Delete prompts you no longer use. |
MPBX-PROMPT-INVALID | invalid_argument | The name (1 to 120 characters, no control characters) or the language tag (en, es-MX, zh-Hans) is not acceptable. | Fix the field. |