Saltar al contenido
Índice

Registrar una llamada

POST/v1/crm/contacts/{id}/calls

Una actividad de tipo llamada en el histórico del contacto, firmada por la llave. La transcripción, los turnos y los números se guardan en crudo aparte. El cuerpo entero no pasa de 2 MB (413). Con el mismo externalCallId otra vez, 409 duplicate con la que ya está.

Permiso de la llave:«Registrar llamadas y tareas» (activities_write)Permiso del rol:crm.edit

Cabeceras

  • Authorizationstringobligatorio

    Bearer y el secreto de la llave.

  • Idempotency-Keystring

    Recomendada. De 1 a 200 caracteres. La misma clave y la misma petición devuelven la misma respuesta durante 24 h, sin repetirla. Sin ella, un reintento se hace otra vez.

Parámetros de ruta

  • idstringobligatorio

    El contacto.

    uuid

Cuerpo

JSON, con Content-Type: application/json.

  • summarystringobligatorio

    Qué pasó, en una línea: es lo que se lee en el histórico.

    hasta 300 caracteres

  • directionstring

    in (llamó) u out (se le llamó). Por omisión, in.

    uno de: in, out

  • startedAtstring

    Cuándo empezó. Por omisión, ahora; no en el futuro.

    fecha y hora (RFC 3339) · hasta 40 caracteres

  • durationSecondsinteger

    Cuánto duró. En el histórico, en minutos redondeados hacia arriba.

    de 0 a 86400

  • transcriptstring

    La transcripción entera. Se guarda en crudo, tal cual llega, aparte.

    hasta 400000 caracteres

  • turnsarray de object

    La conversación por turnos, si la tienes separada: la ficha la enseña distinguiendo quién dijo qué. Se guarda en crudo, como llega. Puede ir con transcript o sin él. El cuerpo entero de la llamada no pasa de 2 MB.

    hasta 2000 elementos

  • turns[].speakerstringobligatorio

    Quién habla: assistant (el asistente automático), customer (el contacto, llame o reciba la llamada) o agent (una persona del equipo).

    uno de: assistant, customer, agent

  • turns[].textstringobligatorio

    Lo que dijo.

    hasta 4000 caracteres

  • turns[].atstring

    Cuándo, si lo sabes.

    fecha y hora (RFC 3339) · hasta 40 caracteres

  • notesstring

    Detalle, si lo hay.

    hasta 10000 caracteres

  • typeIdstring

    El tipo, del vocabulario del cliente (GET /v1/crm/activity-types).

    uuid · hasta 36 caracteres

  • externalCallIdstring

    El id de la llamada en tu sistema, tal cual: con él, mandarla otra vez no la duplica.

    hasta 200 caracteres

  • fromNumberstring

    Desde qué número, en E.164.

    teléfono E.164 · hasta 40 caracteres

  • toNumberstring

    A qué número, en E.164.

    teléfono E.164 · hasta 40 caracteres

Respuestas

  • 201Registrada.Ver campos
    • idstringobligatorio

      Su id.

      uuid · hasta 36 caracteres

  • 400Algo no es válido: error.field dice qué.
  • 401Sin llave, o no vale.
  • 403Fuera del plan (code plan); la llave sin el permiso de su rol o sin el permiso de API de la operación (code forbidden); o desde una IP que la llave no permite (code ip_not_allowed).
  • 404No existe o no lo alcanza.
  • 409duplicate, conflict, idempotency_conflict o in_progress.
  • 413El cuerpo es demasiado grande.
  • 429Más de 120 peticiones por minuto con la llave, o de 600 en la organización. Con Retry-After.
  • 503No se pudo atender. Con Retry-After: repítela.