Operator | SignalCore

import requests
url = "https://signalcore.ai/v1/conversations/conversation_id/operator"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "id",
  "role": "user",
  "text": "text",
  "action": {
    "key": "value"
  },
  "steps": [
    {
      "id": "id",
      "action": "action",
      "state": "running",
      "output": "output",
      "surface": {
        "key": "value"
      },
      "awaits": true,
      "request": {
        "key": "value"
      },
      "app": {
        "name": "name"
      }
    }
  ],
  "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": "reason",
    "automation": "automation",
    "title": "title",
    "run_id": "run_id"
  }
}

A person of the business writes to the person on the channel (doors.channels): delivered as theirs, and the conversation theirs (the agent quiet) until it is given back, or they have been quiet in it for the channel’s auto_release_after_h.

Authentication

AuthorizationBearer

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

Path parameters

conversation_idstringRequired

Request

This endpoint expects an object.

textstringOptional<=20000 charactersDefaults to

fileslist of stringsOptionalDefaults to []

Response

Successful Response

idstring

roleenum

Allowed values:

textstring

actionmap from strings to any or null

stepslist of objects

created_atdatetime

fileslist of objectsOptionalDefaults to []

authorenum or nullOptional

Allowed values:

deliveryenum or nullOptional

Allowed values:

delivery_errorstring or nullOptional

pieceslist of strings or nullOptional

sent_partsinteger or nullOptional

voiceobject or nullOptional

A file of the conversation as a message shows it; its bytes are at GET /conversations/{id}/files/{file_id}.

heardstring or nullOptional

decisionobject or nullOptional

What was decided of a contact’s message (handlers): by the channel’s filter, the agent answers it or not this time (skip); by the agent’s own handlers (@sc.on), it answers, or the conversation goes to a person (hold) or to nobody (ignore); deciding while they go.

Errors

422

Conversations Operator Request Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors