Skip to main content
POST
Registra una telefonata conclusa

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Facoltativa. La stessa chiave entro 24 ore ripete la prima risposta 2xx.

Maximum string length: 255

Body

application/json
externalCallId
string
required

L'id della chiamata presso il fornitore: la chiave di idempotenza.

Required string length: 1 - 255
direction
enum<string>
required
Available options:
inbound,
outbound
from
string
required

Numero di telefono in qualunque formato; «anonymous» se nascosto.

Required string length: 3 - 32
to
string
required

Numero di telefono in qualunque formato; «anonymous» se nascosto.

Required string length: 3 - 32
startedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
durationSeconds
integer
required
Required range: 0 <= x <= 86400
outcome
enum<string>
required
Available options:
booked,
rescheduled,
cancelled,
information,
callback,
interested,
not_interested,
transferred,
no_answer,
voicemail,
failed,
other
summary
string
Maximum string length: 4000
recordingUrl
string<uri>
Maximum string length: 2048
transcript
string

Dato clinico: richiede lo scope clinical:write.

Maximum string length: 200000
patientId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
leadId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
facilityId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
caller
object

Il nome detto al telefono: serve solo se il numero e' sconosciuto e nasce un lead.

Response

La telefonata registrata (200 se era gia' registrata).

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
externalCallId
string
required

L'id della chiamata presso il fornitore della voce.

direction
enum<string>
required
Available options:
inbound,
outbound
from
string
required
to
string
required
startedAt
string
required

Istante ISO 8601.

durationSeconds
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
outcome
enum<string>
required
Available options:
booked,
rescheduled,
cancelled,
information,
callback,
interested,
not_interested,
transferred,
no_answer,
voicemail,
failed,
other
summary
string | null
required
recordingUrl
string | null
required

Link alla registrazione presso il fornitore.

patientId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
leadId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
facilityId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
createdAt
string
required
transcript
string | null

Solo nel dettaglio e solo con lo scope clinical:read (dato clinico, finisce nel registro accessi).