List queued messages - Cadenya

cadenya-widgets conversations list-queued-messages _123

{
  "items": [
    {
      "id": "objqa_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "conversationId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "content": "<string>",
      "state": "STATE_UNSPECIFIED",
      "createdAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "eventId": "<string>"
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "total": 123
  }
}

{
  "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": {}
    }
  ]
}

GET

/

v1

/

conversations

/

{id}

/

queued_messages

cadenya-widgets conversations list-queued-messages _123

{
  "items": [
    {
      "id": "objqa_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "conversationId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "content": "<string>",
      "state": "STATE_UNSPECIFIED",
      "createdAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "eventId": "<string>"
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "total": 123
  }
}

{
  "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.

Query Parameters

limit

integer<int32>

Maximum number of results to return.

cursor

string

Pagination cursor from previous response.

state

enum<string>

Only return messages in this state. When unset, messages in every state are returned.

Available options:

STATE_UNSPECIFIED,

STATE_QUEUED,

STATE_SENT,

STATE_REMOVED,

STATE_DISCARDED

Response

OK

List queued messages response. Ordered oldest first.

items

object[]

required

Show child attributes

pagination

object

Page carries pagination data for list responses. A deliberate local duplicate of the api module's Page — this package imports nothing from cadenya.api.v1 (see the workspace README).

Show child attributes