Interactions Error Codes

Comprehensive guide to error codes used in the system, categorized for easy reference and troubleshooting.

👍

> In case Interactions fail to set up or load and issues like the one below are observed:


Troubleshooting Step: Check the browser settings, especially under the Performance section. If the Energy Saver option is enabled, it might cause such issues. Disable the Energy Saver option as a troubleshooting step to resolve the problem.


Overview

This document defines the standardized error codes and their corresponding messages used across the application. These codes are categorized for clarity and ease of debugging. They help developers and support teams quickly identify the nature of the issue and take appropriate action.

Each error code follows the format:

IH-<ERROR_CATEGORY>-<MODULE_CODE><SEQUENCE_NUMBER>
  • IH → Prefix for Interaction Hub
  • <ERROR_CATEGORY> → 2-letter category identifier
  • <MODULE_CODE><SEQUENCE_NUMBER> → Module and unique error sequence

🔢 Error Code Categories

CategoryCodeDescription
GENERALGEGeneral non-specific errors
VALIDATION_ERRORVAInput validation and schema-related issues
PERMISSIONSAPAccess permission-related failures
AUTHENTICATION_AUTHORIZATIONAUAuthentication and authorization failures
NOT_FOUNDNFResource not found
SERVICE_ERRORSVAPI/service-level errors
DATABASE_ERRORDBFailures interacting with the database
INTERNAL_APPLICATION_ERRORIAApplication-level unexpected failures
CLIENT_ERRORCLIssues caused due to client-side behavior
SERVER_ERRORSYServer-side runtime errors
FUNCTIONAL_LOGIC_ERRORFLErrors arising from business rule enforcement
EXTERNAL_SERVICE_ERROREXErrors from 3rd-party or external service integrations
CONFIGURATION_ERRORCOMissing or invalid configuration settings

Module-wise Error Definitions

GENERAL (GE)

CodeMessage
IH-GE-010001Your account has been temporarily deactivated due to policy violations. If you believe this is a mistake, please contact our support team.

AUTHENTICATION_AUTHORIZATION (AU)

CodeMessage
IH-AU-020001Your session has expired due to inactivity. Please log in again to continue.
IH-AU-020002The username or password you entered is incorrect. Please check your credentials and try again.
IH-AU-020003You are not authorized to access this resource. Ensure your account has the necessary permissions or contact an administrator.

SERVICE_ERROR (SV)

CodeMessage
IH-SV-030001You have exceeded the allowed number of requests. Please wait a few moments before trying again.
IH-SV-030002This API endpoint has been deprecated and is no longer available. Please refer to the latest API documentation.

PERMISSIONS (AP)

CodeMessage
IH-AP-040001Access denied. You do not have the required permissions to perform this action.
IH-AP-040002Your role does not allow you to perform this operation. Please contact your administrator for access.
IH-AP-040003You have exceeded the disposition selection limit. Please select within your allowed limit.

INTERACTION (NF, FL, CL, DB, AU)

CodeMessage
IH-NF-050001The requested interaction could not be found. It may have been deleted or does not exist in the system.
IH-FL-050002An error occurred while updating the interaction. Please try again later or contact support if the issue persists.
IH-FL-050003There was an error while creating the interaction. Please ensure all required fields are filled correctly and try again.
IH-CL-050004This interaction is already in the queue. Please click the "Assign to Me" button to assign it and initiate the conversation.
IH-CL-050005This interaction has already been assigned to another agent.
IH-DB-050006We were unable to add the interaction to the queue. Please try again or reach out to support for assistance.
IH-NF-050007Please check the agent identifier and try again.
IH-AU-050008You are not authorized to perform this action. Your client ID does not match the provided user ID.
IH-CL-050009This interaction has been resolved. First assign the interaction
IH-CL-050010This interaction is already resolved and cannot be moved back to the queue.
IH-CL-050011This interaction is still in queue and must be assigned before it can be resolved
IH-DB-050012Failed to resolve the interaction. Please try again or contact support.
IH-CL-050013You need to have atleast one message to mark this chat as queue

CONVERSATION (NF, FL, CL, DB)

CodeMessage
IH-NF-060001The specified conversation does not exist. Please check the ID or try refreshing your conversations.
IH-FL-060002An error occurred while updating the conversation. Please check your input or try again later.
IH-FL-060003We couldn't create the conversation. Ensure all required details are provided and retry.
IH-CL-060004Missing WhatsApp payload: "whatsapp" field is required for WhatsApp channel.
IH-DB-060005Failed to fetch conversation expiry
IH-CL-060006The agent's phone number does not match the phone number associated with this WhatsApp channel

CONTACT (NF, FL)

CodeMessage
IH-NF-070001No contact found with the provided information. Verify the details and try again.
IH-FL-070002We were unable to update the contact information. Please check the fields and try again.
IH-FL-070003Creating the contact failed. Make sure all required fields are completed correctly.

CHANNEL (NF, FL, CL)

CodeMessage
IH-NF-080001The channel you are trying to access was not found. It may have been removed.
IH-FL-080002Failed to update the channel. Please verify your changes and try again.
IH-FL-080003An error occurred while creating the channel. Please ensure all inputs are valid.
IH-CL-080004This channel does not support replying. Please use a different channel for interaction.

SERVER_ERROR (SY)

CodeMessage
IH-SY-090001An unexpected server error occurred. Please try again shortly or contact support if the issue persists.
IH-SY-090002The server took too long to respond. Please check your connection or try again later.

CONFIGURATION_ERROR (CO)

CodeMessage
IH-CO-100001Something went wrong. We are looking into it. Please try again in a few minutes.
IH-CO-100002An unexpected issue occurred. Please try refreshing the page or contact support.

VALIDATION_ERROR (VA)

CodeMessage
IH-VA-110001The request contains invalid data. Please review your input and try again.
IH-VA-110002One or more required fields are missing. Please fill out all necessary information and submit again.

SERVICE_ERROR (SV)

CodeMessage
IH-SV-120001We're currently experiencing issues connecting to one of our partner services. Please try again shortly.
IH-SV-120002The request to an external service took too long to respond. Please try again in a moment.

DATABASE_ERROR (DB)

CodeMessage
IH-DB-130001We couldn't connect to our database. Please try again later or report the issue.
IH-DB-130002A database error occurred while processing your request. Please try again.

INTERNAL_APPLICATION_ERROR (IA)

CodeMessage
IH-IA-140001The application encountered a critical error and stopped unexpectedly. We're working to fix it.
IH-IA-140002An unexpected error occurred inside the application. Please retry or contact support.

CLIENT_ERROR (CL)

CodeMessage
IH-CL-150001The client's request failed due to malformed input or connection issues. Please review and retry.
IH-CL-150002The client configuration appears to be incorrect. Verify your setup or contact support for help.

EXTERNAL_SERVICE_ERROR (EX)

CodeMessage
IH-EX-160001We're currently experiencing issues connecting to one of our partner services. Please try again shortly.
IH-EX-160002The request to an external service took too long to respond. Please try again in a moment.
IH-EX-160101Your message text appears to be empty or incorrectly formatted. Please enter a valid message.
IH-EX-160102Replies are not supported for template messages. Please send a new message instead.
IH-EX-160103The person you are trying to reply to does not match the original recipient. Please check and try again.
IH-EX-160104The reply message is being sent from a different channel than the original one. Please use the correct channel.
IH-EX-160105You are reacting to a message from a different channel. Please use the right one.
IH-EX-160106We couldn't find the original message you're trying to reply to. It may have been deleted.
IH-EX-160107We couldn't find the message you're trying to react to. It may have been removed.
IH-EX-160108The selected template could not be found. It may have been deleted or is no longer available.
IH-EX-160109The number of values provided does not match the expected number of fields in the template. Please check and try again.

CONFIGURATION_ERROR (CO)

CodeMessage
IH-CO-170001The system encountered an invalid configuration. Please notify the support team.
IH-CO-170002Required configuration settings are missing. Contact the administrator to resolve this.

SETTINGS (NF, FL)

CodeMessage
IH-NF-180001The settings you are trying to access was not found. It may have been removed.
IH-FL-180002Failed to update the settings. Please verify your changes and try again.
IH-FL-180003An error occurred while creating the settings. Please ensure all inputs are valid.

SCHEDULE_CALL (NF, FL, AU)

CodeMessage
IH-NF-190001The scheduled call you are trying to access was not found. It may have been removed.
IH-FL-190002Failed to update the scheduled call. Please verify your inputs and try again.
IH-FL-190003An error occurred while creating the scheduled call. Please ensure all inputs are valid.
IH-AU-190004Access denied — only the owner or a supervisor can update this scheduled call.

Usage Guidelines

For Developers

  1. Always use the predefined error codes from this documentation
  2. Include meaningful error messages that help users understand what went wrong
  3. Use appropriate HTTP status codes in conjunction with these error codes
  4. Log error codes for debugging and monitoring purposes

For Support Teams

  1. Use error codes to quickly identify the category and nature of issues
  2. Reference this documentation to provide accurate guidance to users
  3. Escalate issues based on error categories (e.g., database errors to infrastructure team)

Error Code Format

  • Prefix: Always starts with the cohort code (IH for Interaction Hub)
  • Category: 2-letter code indicating the error type
  • Module: 2-digit module identifier
  • Sequence: 3-digit unique sequence number within the module