search

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

The only endpoint you'll need to poll is: /outgoing-messages/

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

circle-info

Many of our clients use the Zapier Step, "Webhooks By Zapier" arrow-up-right to fulfillsend_response_urland followup_url

hashtag
/outgoing-messages/

hashtag
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

hashtag
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

Retrieve the ID from the Sales AI dashboard. arrow-up-right

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 protected],

"phone": 1234567778,

"facebook": fbname,

"instagram": igname,

"intercom": icname

}

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

conversation_id

Int

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 /create_conversation/ endpoint if you want to create a conversation and specify an id. Recommended for sales applications.

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

hashtag
Headers

Name
Type
Description

Content-Type*

String

application/json

2hd-api-key*

String

Your MAAX AI API key, which you can locate at https://app.maax.ai/dashboard/api-keys/arrow-up-right

hashtag
Request Body

Name
Type
Description

String

PreviousBase UrlNextConversations

Last updated