Call screening error codes (mpbx-ai::screening)
Raised when a screening profile's rules or phrases are saved, and by the assistant API
(/me/assistant, /screening). Messages name the rule's index in the submitted list or the phrase id; they
never contain caller numbers or the text of a phrase. Guide: Call assistant (user guide) and Call
assistant policy (administration).
| Code | Kind | Meaning | What to do |
|---|---|---|---|
MPBX-SCREEN-RULES-TOO-MANY | invalid_argument | More than 50 rules in one profile. | Merge rules (most profiles need fewer than ten). |
MPBX-SCREEN-RULE-CONDITION | invalid_argument | A rule names an unknown condition, or its argument is invalid (a number that is not E.164, an unknown intent or presence value, a repeat count outside 2 to 10, an empty label). | Fix the named rule. |
MPBX-SCREEN-RULE-ACTION | invalid_argument | A rule names an unknown action, or its argument is invalid (block days outside 1 to 365, a phrase id outside the catalogue, a text message that is not one of sms.auto_reply, sms.hours, delivery.instructions, a colleague target that is not an extension, ring group or queue number). | Fix the named rule. |
MPBX-SCREEN-RULE-POSITION | invalid_argument | Two rules share a position. | Send distinct positions (the server renumbers them 0..n after saving). |
MPBX-SCREEN-RULE-URGENT-MISSING | invalid_argument | No enabled rule rings you when a caller says the call is urgent. Every template has this rule. | Keep or re-add the rule. |
MPBX-SCREEN-RULE-URGENT-ORDER | invalid_argument | A rule that ends the call (say a phrase and hang up, decline and block, hand to a call flow) for callers who may be unknown comes before the rule for urgent callers. Rules about one known caller may come first. | Move the urgent-caller rule up, or the other rule down. |
MPBX-SCREEN-PHRASE-ID | invalid_argument | The override names a phrase id outside the catalogue. | Use an id from the catalogue (GET /me/assistant/phrases). |
MPBX-SCREEN-PHRASE-EMPTY | invalid_argument | The override is empty. | Delete the override to use the catalogue text. |
MPBX-SCREEN-PHRASE-LENGTH | invalid_argument | The override is longer than 300 characters (the context note: 600). | Shorten it. |
MPBX-SCREEN-PHRASE-PLACEHOLDER | invalid_argument | The override uses a placeholder other than {owner}, {business}, {hours}, {note}, {colleague}, {who}, {why}, {when}. | Remove or rename it. |
MPBX-SCREEN-PHRASE-TEXT | invalid_argument | The override is not plain text: markup, a link, an e-mail address or an unbalanced brace. | Write plain spoken text. |
MPBX-SCREEN-PHRASE-DIGITS | invalid_argument | The override (or the context note) holds four or more digits in a row. The assistant never speaks codes or numbers from a script. | Remove the digits. |
API (/me/assistant, /screening)
| Code | Kind | Meaning | What to do |
|---|---|---|---|
MPBX-SCREEN-SESSION-REQUIRED | permission_denied | The call assistant is managed from a signed-in session; an API key cannot change it. | Sign in as the user. |
MPBX-SCREEN-NOT-ALLOWED | permission_denied | The company turned the personal call assistant off (/screening/policy, personal_assistant). | Ask an administrator. |
MPBX-SCREEN-MODE-NOT-ALLOWED | invalid_argument | The mode (or the template's mode) is not one of the modes the company allows. | Pick one of effective.allowed_modes from GET /me/assistant. |
MPBX-SCREEN-SETTINGS | invalid_argument | A setting is out of range: an unknown mode, ring seconds outside 0 to 20, caller turns outside 1 to 5, a voice id with other characters, a language that is not a BCP-47 tag, a pause length other than one_hour / until_tomorrow, a shared profile name outside 1 to 80 characters, or a policy cap out of range. | Fix the named field. |
MPBX-SCREEN-RULE-TARGET | invalid_argument | A ring_colleague rule names a number that is not an enabled extension, ring group or queue of the company. | Pick a colleague, ring group or queue of the company. |
MPBX-SCREEN-RULE-FLOW | invalid_argument | A run_flow rule names a flow that is not a published call flow of the company, or a user's own assistant uses it while the company does not let users build their own automations (personal_designer). | Publish the flow, ask an administrator, or use another action. |
MPBX-SCREEN-TEMPLATE | invalid_argument | Unknown template id, or front_desk for a user's own assistant (it is for shared profiles). | Use an id from the template list. |
MPBX-SCREEN-CONTACTS | invalid_argument | A phone-contact upload holds more than 5000 entries, a fingerprint that is not 64 lowercase hex characters (numbers in clear are refused), or a label longer than 40 characters. | Fingerprint each number with the key of GET /me/assistant/hmac-key. |
MPBX-SCREEN-FEEDBACK | invalid_argument | The verdict is not correct or wrong, or should_have is not one of ring_me, ring_mobile, take_message, send_to_voicemail, decline_and_block, offer_callback, escalate_push (or is given with correct). | Fix the field. |
MPBX-SCREEN-NAME-TAKEN | conflict | Another shared assistant of the company has this name. | Choose another name. |
MPBX-SCREEN-PREVIEW-LIMIT | resource_exhausted | More than 10 voice previews in 10 minutes. | Wait for the Retry-After seconds. |
MPBX-SCREEN-COMMAND | invalid_argument | A command during a screened call (POST /me/assistant/sessions/{id}/commands) is not take, reject, say, answer or forward, or a field is wrong: a cmd_id outside 1 to 64 letters, digits, -, _, ., :; how other than polite, voicemail, block; block days outside 1 to 365; words that are empty, longer than 160 characters or hold a link; a mode other than verbatim / natural; an answer_id other than ring_me, voicemail, polite, block; an extension that is not 1 to 15 digits. | Fix the named field. |
MPBX-SCREEN-SPAM-ENTRY | invalid_argument | A company spam-list entry is not number (+ and 7 to 15 digits) or prefix (+ and 1 to 15 digits), or its note is longer than 200 characters. | Write the number in E.164 form. |
MPBX-SCREEN-SPAM-EXISTS | conflict | The number or prefix is already on the company spam list. | Nothing to do. |
MPBX-SCREEN-HOLD-REASON | invalid_argument | A legal-hold change has no reason, or one longer than 200 characters. | Give the reason (it is kept in the audit log). |
Route reasons
The route decision is logged with one of these reasons (not an error; the call is never refused):
bypass, screened, own_device, disabled, ai_off, not_allowed, paused, blocked, vip,
colleague, budget, limit, cooldown, ring_me, rule, screen. Only blocked, limit,
cooldown, rule and screen divert the call to the assistant; every other reason rings the
user's devices as without the assistant.