βš™οΈ
Maax AI Documentation
  • Start Here
    • ▢️Welcome to Maax
      • How does it work?
        • Integrations
        • Dataflow
      • Accessing your account
    • πŸ“šSetting Up Your Knowledge Base
      • Uploading Content
        • Upload Best Practices
      • Testing Responses
    • πŸ’»Web App (Dashboard)
      • Maax AI Setup
        • Upload Content
        • Student Support
        • Sales
      • Leaving Feedback on Conversations
  • Setup Your AI
    • πŸ’ΈSales AI
      • 1. Product
        • 1a. Update Knowledge Base
        • 1b. Create a Product Description
      • 2. Strategy
      • 3. Goal and Goal URL
      • 4. Creating Your Sales AI
    • πŸ¦Έβ€β™‚οΈCustomer Support AI
      • Emergency Notification Setting
  • πŸ”„Setup Your Integration
    • V2 Sales AI - Zapier
      • 1. Send Question to Maax
      • 1a. Explanation of Python Code Step
      • 2. Catch and Map Response From Maax
      • 3. Catch and Map Follow Ups
      • 4. Set up Emergency Notifications
    • V1 Customer AI - Zapier
      • Step 1 – Starting your Zap
      • Step 2 – Use Zapier Python to Send Your Question to Maax
        • Follow-up Message Handling
      • Step 3 – Delay Your Request
      • Step 4 – Get the Answer
      • Step 5 – Map the Answer
    • Example Use Cases
      • Gmail Customer Support Automation with Zapier
  • Technical Guides
    • πŸ”—APIs
      • V1
        • Authentication
        • Base Url
        • Conversations
        • Products
        • Strategies
        • Goals
        • Sales AIs
      • V2
        • Authentication
        • Base Url
        • Outgoing Messages
        • Conversations
    • πŸ‡Explanatory Diagrams
      • Advanced - MAAX AI API Model Architecture
      • Answer Generation With MAAX AI
  • πŸ’¬ Building Good Prompts
    • [Use Case] Engage Cart Abandons
Powered by GitBook
On this page
  • /outgoing-messages/
  • Generates an answer to a message.
  1. Technical Guides
  2. APIs
  3. V2

Outgoing Messages

The V2 API handles conversations differently than V1 for speed. Instead of polling an endpoint to retrieve an answer, we will send a response to your supplied endpoint

PreviousBase UrlNextConversations

Last updated 1 year ago

The only endpoint you'll need to poll is:

The main difference to V1 is the supplication of the send_response_url variable in the body of your request.

Many of our clients use the Zapier Step, to fulfillsend_response_urland followup_url

/outgoing-messages/

Generates an answer to a message.

POST https://app.max.ai/api/v2/outgoing-messages/

This endpoint tasks Maax AI with generating a response to a message you received

Query Parameters

Name
Type
Description

message_content*

String

Contents of the message from your customer.

platform*

String

Where will you be sending the response to? website, email, sms

ai_id*

Integer

sales_automation

prospect_id

Integer

The id of prospect who is asking the question (If it is not provided, the new one will be created based on the prospect_info)

prospect_info*

JSON

{"first_name": student, "last_name": test,

"email": email@test.com,

"phone": 1234567778,

"facebook": fbname,

"instagram": igname,

"intercom": icname

}

First name is required, and at least one other variables (except last_name)

conversation_id

Int

output_format

String

plain_text if you wish to receve an unformatted response (recommended for SMS)

Leave blank if you wish to receive a HTML formatted response

service_type*

String

sales_automation

send_response_url*

String

The URL to which Maax will send a response after the message is processed

followup_url*

String

The URL to which Maax will send a follow-up message to

Headers

Name
Type
Description

Content-Type*

String

application/json

2hd-api-key*

String

Request Body

Name
Type
Description

String

Retrieve the ID from the

The conversation id between this user and the prospect. If it is not given, the latest conversation between these two will be used, otherwise, a new one will be created. Please review the endpoint if you want to create a conversation and specify an id. Recommended for sales applications.

Your MAAX AI API key, which you can locate at

πŸ”—
"Webhooks By Zapier"
/outgoing-messages/
Sales AI dashboard.
https://app.maax.ai/dashboard/api-keys/
/create_conversation/