Send the next message - Cadenya

cadenya-widgets conversations continue _123 \
  --message sample

{
  "type": "event",
  "event": {
    "type": "userMessage",
    "userMessage": {
      "content": "<string>"
    },
    "id": "<string>",
    "conversationId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

POST

/

v1

/

conversations

/

{id}

:continue

cadenya-widgets conversations continue _123 \
  --message sample

{
  "type": "event",
  "event": {
    "type": "userMessage",
    "userMessage": {
      "content": "<string>"
    },
    "id": "<string>",
    "conversationId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

id

string

required

Conversation ID.

Body

application/json

Continue conversation request.

message

string

required

The visitor's next message.

enqueue

boolean

When false, the conversation must be open and the message is sent immediately. When true, an open conversation still receives the message immediately; a conversation whose agent is responding queues it instead, and the agent picks it up before its next reply. Queued messages can be listed and removed until then.

Response

OK

Option 1
Option 2

ContinueConversationResponse reports whether the message joined the conversation immediately or was queued for the agent.

type

enum<string>

required

Available options:

event

event

object

required

The userMessage event, when the conversation was open and the message was sent immediately.

Show child attributes