Documentación de woku - Guía para desarrolladores

curl --request POST \
  --url https://clientapi.woku.app/wokus/create-woku \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Experiencia de Servicio al Cliente - Tienda #123",
  "fileUrl": "https://cdn.example.com/images/product-image.jpg"
}
'

{
  "_id": "507f1f77bcf86cd799439011",
  "description": "Customer Service Experience - Store #123",
  "createdBy": "507f1f77bcf86cd799439012",
  "companyId": "507f1f77bcf86cd799439013",
  "folderId": "507f1f77bcf86cd799439014",
  "file": {
    "filename": "product-image.webp",
    "type": "image",
    "url": "https://cdn.woku.app/files/product-image.webp"
  },
  "qualifications": [
    {
      "_id": "507f1f77bcf86cd799439015",
      "qualification": 5,
      "createdBy": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "textnotes": [
    {
      "_id": "507f1f77bcf86cd799439016",
      "qualification": {
        "qualification": 5
      },
      "description": "Excellent service!",
      "anonymous": false,
      "feedbackType": "positive",
      "clientId": "<string>",
      "validated": true,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "voicemails": [
    {
      "_id": "507f1f77bcf86cd799439017",
      "qualification": {
        "qualification": 4
      },
      "file": {
        "filename": "voicemail.mp4",
        "url": "<string>"
      },
      "transcription": "I had a great experience with your service...",
      "anonymous": false,
      "feedbackType": "positive",
      "clientId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "feedbacksSummary": "Customers generally praise the helpful staff and quick service...",
  "closed": false,
  "createdAt": "2026-01-20T10:30:00.000Z",
  "updatedAt": "2026-01-20T15:45:00.000Z"
}

{
  "statusCode": 400,
  "message": [
    "description must be a string",
    "fileUrl must be a valid URL"
  ],
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid or missing API key"
}

POST

wokus

create-woku

curl --request POST \
  --url https://clientapi.woku.app/wokus/create-woku \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Experiencia de Servicio al Cliente - Tienda #123",
  "fileUrl": "https://cdn.example.com/images/product-image.jpg"
}
'

{
  "_id": "507f1f77bcf86cd799439011",
  "description": "Customer Service Experience - Store #123",
  "createdBy": "507f1f77bcf86cd799439012",
  "companyId": "507f1f77bcf86cd799439013",
  "folderId": "507f1f77bcf86cd799439014",
  "file": {
    "filename": "product-image.webp",
    "type": "image",
    "url": "https://cdn.woku.app/files/product-image.webp"
  },
  "qualifications": [
    {
      "_id": "507f1f77bcf86cd799439015",
      "qualification": 5,
      "createdBy": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "textnotes": [
    {
      "_id": "507f1f77bcf86cd799439016",
      "qualification": {
        "qualification": 5
      },
      "description": "Excellent service!",
      "anonymous": false,
      "feedbackType": "positive",
      "clientId": "<string>",
      "validated": true,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "voicemails": [
    {
      "_id": "507f1f77bcf86cd799439017",
      "qualification": {
        "qualification": 4
      },
      "file": {
        "filename": "voicemail.mp4",
        "url": "<string>"
      },
      "transcription": "I had a great experience with your service...",
      "anonymous": false,
      "feedbackType": "positive",
      "clientId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "feedbacksSummary": "Customers generally praise the helpful staff and quick service...",
  "closed": false,
  "createdAt": "2026-01-20T10:30:00.000Z",
  "updatedAt": "2026-01-20T15:45:00.000Z"
}

{
  "statusCode": 400,
  "message": [
    "description must be a string",
    "fileUrl must be a valid URL"
  ],
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid or missing API key"
}

Autorizaciones

Authorization

string

header

requerido

Clave de API de la empresa. Obtenla desde tu dashboard de Woku en Settings > API Keys.

Cuerpo

application/json

description

string

requerido

Descripcion del woku (producto, servicio o experiencia que se resena)

Minimum string length: 1

Ejemplo:

"Customer Service Experience - Store #123"

fileUrl

string<uri>

requerido

URL de un archivo existente (imagen o video) para asociar al woku

Ejemplo:

"https://cdn.example.com/images/product-image.jpg"

folderSecondaryKey

string

Identificador de clave secundaria de la carpeta. Si la carpeta no existe, se creara automaticamente.

Ejemplo:

"store-123"

parentFolderSecondaryKey

string

Identificador de clave secundaria de la carpeta padre. Se usa para crear jerarquias de carpetas.

Ejemplo:

"region-north"

clientEmail

string<email>

Direccion de correo del cliente. Si se proporciona, se enviara un correo de invitacion a resenar.

Ejemplo:

"customer@example.com"

clientPhone

integer

Numero de telefono del cliente (incluyendo el codigo de pais, sin espacios ni simbolos). Si se proporciona, se enviara una invitacion por WhatsApp a resenar.

Ejemplo:

56912345678

Respuesta

Woku creado correctamente

_id

string<objectid>

Identificador unico del woku

Ejemplo:

"507f1f77bcf86cd799439011"

description

string

Descripcion del woku

Ejemplo:

"Customer Service Experience - Store #123"

createdBy

string<objectid>

ID del usuario que creo el woku

Ejemplo:

"507f1f77bcf86cd799439012"

companyId

string<objectid>

ID de la empresa a la que pertenece el woku

Ejemplo:

"507f1f77bcf86cd799439013"

folderId

string<objectid>

ID de la carpeta en la que esta organizado el woku

Ejemplo:

"507f1f77bcf86cd799439014"

file

object

Show child attributes

qualifications

object[]

Arreglo de calificaciones de estrellas

Show child attributes

textnotes

object[]

Arreglo de resenas de texto

Show child attributes

voicemails

object[]

Arreglo de resenas de voz

Show child attributes

feedbacksSummary

string

Resumen generado por IA de todo el feedback

Ejemplo:

"Customers generally praise the helpful staff and quick service..."

closed

boolean

predeterminado:false

Si el woku esta cerrado para nuevas resenas

createdAt

string<date-time>

Marca de tiempo de creacion

Ejemplo:

"2026-01-20T10:30:00.000Z"

updatedAt

string<date-time>

Marca de tiempo de la ultima actualizacion

Ejemplo:

"2026-01-20T15:45:00.000Z"

Wokus

Empresas

Reportes

Crear un woku mediante URL

Autorizaciones

Cuerpo

Respuesta