Send Message
Sends Message to the Thread between a Chatbot and an EndUser, returns the Message created from the request, the Messages generated in response, and returns information about the Thread between the Chatbot and EndUser
curl --request POST \
--url https://api.altur.io/api/v1.0/message \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"chatbot_id": "<string>",
"end_user_id": "<string>",
"content": "<string>"
}'{
"thread": {
"id": "<string>",
"chatbot": {
"id": "<string>",
"name": "<string>"
},
"enduser": {
"id": "<string>",
"display_name": "<string>",
"integration_type": "api",
"info": "<string>"
},
"integration": {
"id": "<string>",
"type": "api"
},
"updated_at": "2023-11-07T05:31:56Z",
"active": true,
"blocked": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "blue"
}
],
"assigned_to": [
{
"id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
]
},
"messages": [
{
"thread_id": "<string>",
"type": "text",
"content": "<string>",
"media": "<string>",
"sent_by": "AI",
"sent_by_user": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"read": true
}
],
"in_response_to": {
"thread_id": "<string>",
"type": "text",
"content": "<string>",
"media": "<string>",
"sent_by": "AI",
"sent_by_user": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"read": true
}
}Authorizations
Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.
Body
Unique identifier of the Chatbot recieving the Message
Unique identifier of the EndUser sending the Message
Text content of the Message
Response
Unique identifier for the Thread
Unique identifier for the EndUser
EndUser's display name
Enum representing the Integration's channel
api, whatsapp EndUser's information valuable for interactions with Chatbots or human agents
Last time the Thread was updated
Boolean describing if automatic responses by the Chatbot are active on this Thread
Boolean describing if Thread is blocked
Array of Messages in response to prompted Message
Unique identifier of the Thread the Message belongs to
Message type enum
text, image, audio, video, button, template, document Author of this message
AI, EU, SYS Datetime from when the Message was sent
Message's text content
Message's media content, if any (usually in form of URL)
Altur user id (if Message was sent manually by an in-app user)
Boolean describing if the Message is considered as read
Unique identifier of the Thread the Message belongs to
Message type enum
text, image, audio, video, button, template, document Author of this message
AI, EU, SYS Datetime from when the Message was sent
Message's text content
Message's media content, if any (usually in form of URL)
Altur user id (if Message was sent manually by an in-app user)
Boolean describing if the Message is considered as read
curl --request POST \
--url https://api.altur.io/api/v1.0/message \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"chatbot_id": "<string>",
"end_user_id": "<string>",
"content": "<string>"
}'{
"thread": {
"id": "<string>",
"chatbot": {
"id": "<string>",
"name": "<string>"
},
"enduser": {
"id": "<string>",
"display_name": "<string>",
"integration_type": "api",
"info": "<string>"
},
"integration": {
"id": "<string>",
"type": "api"
},
"updated_at": "2023-11-07T05:31:56Z",
"active": true,
"blocked": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "blue"
}
],
"assigned_to": [
{
"id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
]
},
"messages": [
{
"thread_id": "<string>",
"type": "text",
"content": "<string>",
"media": "<string>",
"sent_by": "AI",
"sent_by_user": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"read": true
}
],
"in_response_to": {
"thread_id": "<string>",
"type": "text",
"content": "<string>",
"media": "<string>",
"sent_by": "AI",
"sent_by_user": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"read": true
}
}