Send message with the Crisp API
Sends a message as an operator in a conversation. type text goes to the visitor right away; type note is an internal note seen only by operators.
- Identifier
- crisp_send_message
The request
POST https://connect.reportei.com/api/tools/crisp_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"website_id": "<website_id>",
"session_id": "<session_id>",
"type": "text",
"from": "operator",
"origin": "chat",
"content": "<content>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| website_id | string | Yes | Id of the workspace, from List websites. |
| session_id | string | Yes | Id of the conversation, starting with session_, from List conversations. |
| type | string | Yes | text for a message to the visitor, note for an internal note.Values: text, note |
| from | string | Yes | Sender of the message. Always operator.Values: operator |
| origin | string | Yes | Channel of the message: chat for the chatbox, email for conversations that came in by email.Values: chat, email |
| content | string | Yes | Text of the message or of the note. |
| user | object | No | Sender shown on the message. |
| mentions | array | No | Operators to mention in a note: the user_id inside details, from List operators. |
| attachments | array | No | Files already hosted at a public URL, from 1 to 10. |
Supported connections
Your customer connects their Crisp account once, with one of the modes below. The same connection serves every tool of the toolkit.
Username and password
Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/crisp_send_message. It becomes your agent's tool definition with no conversion.
Other Crisp tools
- List websitesGETLists the Crisp workspaces, called websites in the API, where the plugin of this token is installed, with their website_id. Get website gives the name of each one. Pages start at 1, and an empty data list means there are no more pages.
- Get websiteGETReturns the name, domain and logo of a Crisp workspace, to tell apart the ids that List websites returns.
- List conversationsGETLists the conversations of a workspace, with session_id, state, unread counts, assigned operator, last message and the visitor meta (nickname, email, phone, segments). Pages start at 1, and a page with fewer items than per_page is the last one.
- Get conversationGETReturns a conversation with its state, assigned operator, unread counts, last message, people_id of the contact and the visitor meta. The messages come from List conversation messages.
- List conversation messagesGETReturns the latest batch of messages of a conversation, with type, sender, content and timestamp in milliseconds. To page towards older messages, send the timestamp of the oldest message of the batch as timestamp_before.
- Update conversation statePATCHChanges the state of a conversation to pending, unresolved or resolved.
- Assign conversationPATCHAssigns a conversation to an operator, who gets notified unless silent is true.
- Update conversation metaPATCHUpdates the visitor details and the subject or segments of a conversation. Send only the fields to change.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
