Skip to main content
POST
/
v1
/
conversations
/
{sessionId}
/
messages
Send message
curl --request POST \
  --url https://quick.bot/api/v1/conversations/{sessionId}/messages \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": {
    "type": "text",
    "text": "<string>",
    "value": "<string>",
    "attachedFileUrls": [
      "<string>"
    ],
    "createdAt": 123
  },
  "messageMetadata": {
    "inputBlockId": "<string>",
    "inputType": "<string>"
  },
  "clientLogs": [
    {
      "status": "<string>",
      "description": "<string>",
      "details": "<unknown>"
    }
  ]
}
'
{
  "actor": {
    "role": "host",
    "name": "<string>",
    "avatarUrl": "<string>"
  },
  "messages": [
    {
      "id": "<string>",
      "type": "text",
      "content": {
        "type": "markdown",
        "markdown": "<string>"
      }
    }
  ],
  "input": {
    "id": "<string>",
    "type": "text input",
    "outgoingEdgeId": "<string>",
    "options": {
      "labels": {
        "placeholder": "<string>",
        "button": "<string>"
      },
      "variableId": "<string>",
      "audioClip": {
        "isEnabled": true,
        "saveVariableId": "<string>"
      },
      "attachments": {
        "isEnabled": true,
        "saveVariableId": "<string>"
      }
    },
    "prefilledValue": "<string>",
    "runtimeOptions": {
      "paymentIntentSecret": "<string>",
      "amountLabel": "<string>",
      "publicKey": "<string>"
    }
  },
  "clientSideActions": [
    {
      "type": "scriptToExecute",
      "scriptToExecute": {
        "content": "<string>",
        "args": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ],
        "isCode": true
      },
      "lastBubbleBlockId": "<string>",
      "expectsDedicatedReply": true
    }
  ],
  "logs": [
    {
      "status": "<string>",
      "description": "<string>",
      "details": "<unknown>"
    }
  ],
  "progress": 123,
  "guestDisplayText": "<string>"
}

Path Parameters

sessionId
string
required

The session ID you got from the POST /v1/conversations response.

Body

application/json
message
object
messageMetadata
object
clientLogs
object[]

Response

Successful response

actor
object
required
messages
(Text · object | Image · object | Video · object | Audio · object | Embed · object)[]
required
input
Text · object
clientSideActions
(Script to execute · object | Redirect · object | Wait · object | Set variable · object | Inject start props · object | Execute code · object)[]

Actions to execute on the client side

logs
object[]

Logs that were saved during the last execution

progress
number

If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow.

guestDisplayText
string