Skip to main content
GET
/
api
/
conversation
Listar Conversaciones
curl --request GET \
  --url https://api.plazbot.com/api/conversation \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "newContinuationToken": "<string>",
    "data": [
      {
        "id": "<string>",
        "contactId": "<string>",
        "workspaceId": "<string>",
        "internalWhatsappNumber": "<string>",
        "platformSenderId": "<string>",
        "platformSenderName": "<string>",
        "platformSenderPhone": "<string>",
        "workspaceName": "<string>",
        "templateCode": "<string>",
        "templateType": "<string>",
        "type": 123,
        "campaignName": "<string>",
        "agentSenderId": "<string>",
        "requestBody": "<string>",
        "responseBody": "<string>",
        "responseStatus": "<string>",
        "creationDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Token de autenticacion Bearer. Obtenga el token usando el endpoint /api/user/login

Headers

x-workspace-id
string
required

Identificador del workspace

Query Parameters

workspaceId
string
required

Identificador del workspace

contactId
string

ID del contacto para filtrar conversaciones

continuationToken
string

Token de paginacion para obtener los siguientes registros. Si es null, no hay mas registros.

Response

Lista de conversaciones obtenida exitosamente

success
boolean
required

Indica si la operacion fue exitosa

code
integer
required

Codigo HTTP de la respuesta

errorCode
string | null
required

Codigo de error, null si no hay error

message
string
required

Mensaje descriptivo del resultado

data
object
required

Respuesta paginada de conversaciones