Skip to main content
POST
/
chat
/
sessions
/
{session_id}
/
send
Send a message
curl --request POST \
  --url https://api.open.cx/chat/sessions/{session_id}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sender": "contact",
  "message": {
    "type": "text",
    "text": "Hello!"
  }
}'
{
  "success": true,
  "data": {
    "success": true,
    "code": "<string>",
    "autopilotResponse": {
      "type": "text",
      "value": {
        "error": true,
        "content": "<string>"
      },
      "id": "<string>",
      "mightSolveUserIssue": true,
      "completelyAndFullyCoveredUserIssue": true,
      "debugInfo": {
        "actionCalls": [
          {
            "action": {
              "name": "<string>",
              "id": "<string>",
              "openapi": {
                "openapi_spec_id": "<string>",
                "operation_spec": "<any>",
                "operation_id": "<string>",
                "operation_method": "<string>"
              },
              "metadata": "<any>",
              "required_form_submission": true,
              "is_handoff_like": true
            },
            "arguments": "<any>",
            "result": "<any>"
          }
        ],
        "actionSearchQuery": "<string>",
        "knowledge": [
          {
            "source": "<string>",
            "source_type": "<string>",
            "url": "<string>"
          }
        ],
        "knowledge_used": [
          {
            "content": "<string>",
            "source": "<string>"
          }
        ],
        "work_instructions_scanned": [
          {
            "content": "<string>"
          }
        ],
        "client_context": {},
        "additional_debug_data": {},
        "whatsapp_template_request": "<any>",
        "rule_violation_reflections": [
          {
            "rule_name": "<string>",
            "violation_description": "<string>"
          }
        ]
      },
      "mode": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      },
      "didExitMode": true
    },
    "uiResponse": {
      "type": "ui",
      "value": {
        "type": "ui_component",
        "request_response": "<any>",
        "name": "<string>",
        "content": "<string>"
      },
      "mightSolveUserIssue": true
    },
    "sessionIsHandedOff": true,
    "resolveArgs": {
      "summary": "<string>",
      "sentiment": "angry"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

Body

application/json
sender
enum<string>
required
Available options:
contact,
agent
message
object
required
contact
object

Updated contact info

agent
object

Agent info. if id is provided, the name and avatar_url are ignored.

should_take_over_session_from_ai
boolean
default:false

If true and sender is agent and session is assigned to AI, the session will be reassigned to the agent.

Response

success
boolean
required
data
object
required
  • Option 1
  • Option 2
  • Option 3