Mosend
MosendDeveloper

Encuesta de satisfacción

Referencia de 3 endpoints generados desde mosend-wb-backend/src/modules/surveys/surveys.controller.ts.

Base path: /organizations/:orgId/surveys·3 endpoints·Source: mosend-wb-backend/src/modules/surveys/surveys.controller.ts
GET/organizations/:orgId/surveys/config
bearer

La configuración de la encuesta de satisfacción. Si nunca se guardó, devuelve los valores por defecto (apagada).

Path params

  • orgIdstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/surveys/config' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
PATCH/organizations/:orgId/surveys/config
bearer

Cambia la configuración de la encuesta.

Path params

  • orgIdstringrequerido

Body (JSON)

  • activeboolean

    Si se le pregunta o no. Nace apagada.

  • delayMinutesnumber

    Minutos a esperar desde el cierre. 120 por defecto.

  • audiencestring
    ALLHUMANBOT

    A quién: ALL toda conversación cerrada, HUMAN solo las que contestó una persona, BOT solo las que atendió el bot.

  • cooldownDaysnumber

    Días sin volver a preguntarle al mismo contacto.

  • questionsobject[]

    Las preguntas, hasta 3: [{ text, options[] }]. La PRIMERA admite 3 respuestas (es la única que podría salir como plantilla, y una plantilla no acepta listas); de la segunda en adelante, hasta 10. En cada una, la primera opción es la mejor nota. Máximo 20 caracteres por respuesta.

  • askCommentboolean

    Si además se le pide un comentario.

  • commentQuestionstring

    La segunda pregunta, abierta.

  • thanksMessagestring

    Con qué se despide.

  • answerTimeoutHoursnumber

    Horas que se espera una respuesta antes de darla por perdida.

  • phoneNumberIdsstring[]

    Solo para estos números. Vacío = todos.

Respuestas

  • 200
curl -X PATCH 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/surveys/config' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"active": true,"delayMinutes": 0,"audience": "ALL","cooldownDays": 0,"questions": [],"askComment": true,"commentQuestion": "<commentQuestion>","thanksMessage": "<thanksMessage>","answerTimeoutHours": 0,"phoneNumberIds": []}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/organizations/:orgId/surveys/results
bearer

Resultados: nota media, tasa de respuesta, desglose por opción y por asesor, comentarios y por qué no se mandaron algunas.

Path params

  • orgIdstringrequerido

Query params

  • desdestringrequerido
  • hastastringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/surveys/results' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2026-05-01T03:42:18.123Z"
    }
  ],
  "timestamp": "2026-05-01T03:42:18.123Z"
}