raia icon

raia

Interact with the official raia API

raia

AI-generated

Overview

This node interacts with the official Raia API to perform various communication-related actions such as prompting an agent, starting email, SMS, or voice conversations, and sending messages within existing conversations. It is useful in scenarios where automated or semi-automated communication workflows are needed, for example, initiating customer support conversations via different channels or sending prompts to agents.

Use Case Examples

  1. Starting an SMS conversation with a customer by providing their phone number, name, and an introductory message.
  2. Starting an email conversation with a customer including subject, introduction, and optionally including a signature.
  3. Prompting an agent with a specific message to take action.
  4. Sending a message to an existing conversation by specifying the conversation ID and message content.

Properties

Name Meaning
Agent Actions The type of action to perform, such as prompting an agent or starting a conversation via SMS, email, or voice.
First Name The first name of the contact for starting SMS, email, or voice conversations.
Last Name The last name of the contact for starting SMS, email, or voice conversations.
Context The context or category of the conversation, e.g., Support.
Source The source system or origin of the conversation, e.g., crm.
fkId An optional foreign key identifier related to the conversation.
fkUserId An optional foreign key user identifier related to the conversation.
Phone Number The phone number of the contact for SMS or voice conversations.
SMS Introduction The introductory message for starting an SMS conversation.
First Message The first message content for starting a voice conversation.
Email The email address of the contact for starting an email conversation.
Email Subject The subject line for the email conversation.
Email Introduction The introductory message for starting an email conversation.
Include Signature In Email Whether to include a signature in the email conversation.
Include Signature In SMS Whether to include a signature in the SMS conversation.
Reset Conversation Whether to start a new conversation instead of continuing an existing one in the same channel.
Prompt The prompt message to send to an agent.
Conversation ID The identifier of an existing conversation to send a message to.
Message The message content to send in an existing conversation.

Output

JSON

  • conversationId - The unique identifier of the conversation created or referenced.
  • messageId - The unique identifier of a message, if applicable.
  • userId - The identifier of the user involved in the conversation or message.
  • message - The content of the message sent or received.
  • timestamp - The timestamp when the message or event occurred.
  • fullPayload - The complete response payload from the Raia API for the action performed.

Dependencies

  • Raia API with authentication credentials

Troubleshooting

  • Missing required fields such as first name, last name, phone number, email, or message depending on the action will cause errors. Ensure all required fields are provided and valid.
  • API errors may occur due to invalid credentials, network issues, or incorrect input parameters. Check the API key and endpoint URL configuration.
  • Error messages from the API include HTTP status codes and descriptive messages. Review these messages to correct input or authentication issues.
  • If the node throws 'Unknown Action' error, verify that the selected action is supported and correctly spelled.

Discussion