N8N Tools - Tidio API icon

N8N Tools - Tidio API

Complete Tidio integration - Live chat, AI chatbots, and customer engagement

Actions31

Operator → Set Operator Status

AI-generated

Overview

This node integrates with the Tidio API to manage operators (agents) within a live chat and customer engagement platform. Specifically, the "Set Operator Status" operation allows users to update an operator's online presence status such as setting them to "online," "offline," or "away." This is useful for managing agent availability in real-time, ensuring that conversations are routed appropriately based on who is available.

Practical scenarios include:

  • Automatically marking an operator as "away" when they start a break.
  • Setting an operator to "online" at the beginning of their shift.
  • Marking an operator "offline" after their work hours to prevent new chat assignments.

Properties

Name Meaning
Operator ID The unique identifier of the operator whose status you want to set.
Additional Fields A collection of optional fields including:
- Visitor Name Name of the visitor (not used directly in this operation).
- Visitor Email Email address of the visitor (not used directly in this operation).
- Visitor Phone Phone number of the visitor (not used directly in this operation).
- Tags Comma-separated list of tags (not used directly in this operation).
- Tag Name Name of the tag to add/remove (not used directly in this operation).
- Custom Properties JSON object of custom properties (not used directly in this operation).
- Contact Name Full name of the contact (not used directly in this operation).
- Contact Email Email address of the contact (not used directly in this operation).
- Contact Phone Phone number of the contact (not used directly in this operation).
- Mailing List ID ID of the mailing list (not used directly in this operation).
- Bot Flow ID ID of the bot flow to trigger (not used directly in this operation).
- Status The operator's status to set. Options: online, offline, away.
- Department Department name or ID (not used directly in this operation).
- Priority Conversation priority (not used directly in this operation).
- Limit Maximum number of results to return (not used directly in this operation).
- Offset Number of results to skip (not used directly in this operation).
- Auto Reply Enable automatic replies (not used directly in this operation).
- Send As Bot Send message as bot rather than operator (not used directly in this operation).

Note: For the "Set Operator Status" operation, only the Operator ID and Status fields are relevant and used.

Output

The node outputs a JSON object representing the response from the Tidio API after attempting to set the operator's status. This typically includes confirmation of the updated status or error details if the operation failed.

Example output structure:

{
  "json": {
    "status": "online",
    "operator_id": "12345",
    "message": "Status updated successfully"
  }
}

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Tidio API.
  • Needs configuration of the Tidio API URL, client ID, and client secret credentials.
  • The node uses an HTTP proxy endpoint hosted by n8ntools.io to forward requests to the Tidio API.

Troubleshooting

  • Common issues:

    • Invalid or missing operator ID will cause the API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Providing an unsupported status value will cause the request to be rejected.

  • Error messages:

    • "Unknown operator operation: setOperatorStatus": Indicates a mismatch or typo in the operation name; ensure the correct operation is selected.
    • API authentication errors: Verify that the API key, client ID, and client secret are correctly configured.
    • Validation errors from the API about the status field: Confirm that the status is one of online, offline, or away.

Links and References

Discussion