Get | SignalCore

{
  "id": "id",
  "agent_id": "agent_id",
  "trigger_id": "trigger_id",
  "handled_by": "agent",
  "pending": true,
  "test": true,
  "created_at": "2024-01-15T09:30:00Z",
  "messages": [
    {
      "id": "id",
      "role": "user",
      "text": "text",
      "action": {
        "key": "value"
      },
      "steps": [
        {
          "id": "id",
          "action": "action",
          "state": "running",
          "output": null,
          "surface": null,
          "awaits": true,
          "request": null
        }
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "files": [
        {
          "id": "id",
          "name": "name",
          "media_type": "media_type",
          "size": 1
        }
      ],
      "author": "contact",
      "delivery": "queued",
      "delivery_error": "delivery_error",
      "pieces": [
        "pieces"
      ],
      "sent_parts": 1,
      "voice": {
        "id": "id",
        "name": "name",
        "media_type": "media_type",
        "size": 1
      },
      "heard": "heard",
      "decision": {
        "kind": "deciding",
        "reason": null,
        "automation": null,
        "title": null,
        "run_id": null
      }
    }
  ],
  "run_id": "run_id",
  "handover": {
    "holder": "agent",
    "reason": "reason",
    "by": "by",
    "title": "title",
    "at": "2024-01-15T09:30:00Z"
  },
  "title": "title",
  "channel": {
    "id": "id",
    "kind": "kind",
    "name": "name"
  },
  "contact": {
    "id": "id",
    "name": "name",
    "address": "address",
    "muted": true
  },
  "reply_due_at": "2024-01-15T09:30:00Z",
  "last_inbound_at": "2024-01-15T09:30:00Z",
  "call": {
    "id": "id",
    "kind": "browser",
    "reason": "reason",
    "seconds": 1,
    "started_at": "2024-01-15T09:30:00Z",
    "ended_at": "2024-01-15T09:30:00Z",
    "recording": true
  },
  "person": {
    "kind": "host_person",
    "external_id": "external_id",
    "name": "name",
    "email": "email"
  },
  "handovers": [
    {
      "holder": "agent",
      "reason": "reason",
      "by": "by",
      "title": "title",
      "at": "2024-01-15T09:30:00Z"
    }
  ]
}

Authentication

AuthorizationBearer

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

Path parameters

conversation_idstringRequired

Response

Successful Response

idstring

agent_idstring

trigger_idstring or null

handled_byenum

Allowed values:

pendingboolean

testboolean

created_atdatetime

messageslist of objects

run_idstring or nullOptional

handoverobject or nullOptional

A change of who answers a conversation: to whom, why, who set it and when.

titlestring or nullOptional

channelobject or nullOptional

The channel a conversation is on, as a list draws it.

contactobject or nullOptional

The person a conversation on a channel is with, or a person of a host’s page (on no channel).

reply_due_atdatetime or nullOptional

last_inbound_atdatetime or nullOptional

callobject or nullOptional

The call a conversation is (VOICE.md): the owner’s in the browser or a phone call, when the worker took it and when it ended, why and how long.

personobject or nullOptional

Who a conversation is with (people).

handoverslist of objectsOptionalDefaults to []

Errors

422

Conversations Get Request Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors