Full reference
The interactive reference with all endpoints, parameters, request and response schemas and examples is in the API Swagger. The OpenAPI 3.1 document is available at openapi.json: you can import it into Postman, Insomnia or a client generator.
To try endpoints from Swagger, click Authorize and enter your API key.
#All endpoints
List generated from the OpenAPI document, grouped by area, with the required scope and the corresponding SDK method.
#Stato servizio
| Request | Scope | SDK method |
|---|
GET /health | — | health() |
#Accesso
| Request | Scope | SDK method |
|---|
GET /auth/me | — | auth.me() |
#Aziende
| Request | Scope | SDK method |
|---|
GET /v1/tenants | tenants:read | tenants.list() |
POST /v1/tenants | tenants:write | tenants.create() |
GET /v1/tenants/current | extensions:read | tenants.current() |
GET /v1/tenants/:id | tenants:read | tenants.get() |
PATCH /v1/tenants/:id | tenants:write | tenants.update() |
DELETE /v1/tenants/:id | tenants:write | tenants.delete() |
PUT /v1/tenants/:id/limits | tenants:write | tenants.limits() |
POST /v1/tenants/:id/suspend | tenants:write | tenants.suspend() |
POST /v1/tenants/:id/resume | tenants:write | tenants.resume() |
POST /v1/tenants/:id/impersonate | tenants:impersonate | tenants.impersonate() |
GET /v1/tenants/:id/voice-node | tenants:read | tenants.getVoiceNode() · py: tenants.get_voice_node() |
PUT /v1/tenants/:id/voice-node | tenants:write | tenants.setVoiceNode() · py: tenants.set_voice_node() |
#featureCodes
| Request | Scope | SDK method |
|---|
GET /v1/feature-codes/settings | extensions:read | featureCodes.getSettings() · py: feature_codes.get_settings() |
PUT /v1/feature-codes/settings | extensions:write | featureCodes.setSettings() · py: feature_codes.set_settings() |
#Interni
| Request | Scope | SDK method |
|---|
GET /v1/extensions | extensions:read | extensions.list() |
POST /v1/extensions | extensions:write | extensions.create() |
GET /v1/extensions/:id | extensions:read | extensions.get() |
PATCH /v1/extensions/:id | extensions:write | extensions.update() |
DELETE /v1/extensions/:id | extensions:write | extensions.delete() |
PUT /v1/extensions/:id/follow-me | extensions:write | extensions.followMe() · py: extensions.follow_me() |
GET /v1/extensions/:id/dnd | extensions:read | extensions.getDnd() · py: extensions.get_dnd() |
PUT /v1/extensions/:id/dnd | extensions:write | extensions.setDnd() · py: extensions.set_dnd() |
GET /v1/extensions/:id/availability | extensions:read | extensions.getAvailability() · py: extensions.get_availability() |
PUT /v1/extensions/:id/availability | extensions:write | extensions.setAvailability() · py: extensions.set_availability() |
POST /v1/extensions/:id/password | extensions:write | extensions.resetPassword() · py: extensions.reset_password() |
GET /v1/extensions/:id/sip-credentials | extensions:write | extensions.sipCredentials() · py: extensions.sip_credentials() |
#Linee
| Request | Scope | SDK method |
|---|
GET /v1/trunks/approvals | security:read | trunks.approvals() |
POST /v1/trunks/:id/approve | security:write | trunks.approve() |
POST /v1/trunks/:id/reject | security:write | trunks.reject() |
GET /v1/trunks | trunks:read | trunks.list() |
POST /v1/trunks | trunks:write | trunks.create() |
GET /v1/trunks/:id | trunks:read | trunks.get() |
PATCH /v1/trunks/:id | trunks:write | trunks.update() |
DELETE /v1/trunks/:id | trunks:write | trunks.delete() |
#Numeri
| Request | Scope | SDK method |
|---|
GET /v1/numbers | numbers:read | numbers.list() |
POST /v1/numbers | numbers:write | numbers.create() |
POST /v1/numbers/bulk | numbers:write | numbers.bulkCreate() · py: numbers.bulk_create() |
GET /v1/numbers/:id | numbers:read | numbers.get() |
PATCH /v1/numbers/:id | numbers:write | numbers.update() |
DELETE /v1/numbers/:id | numbers:write | numbers.delete() |
PUT /v1/numbers/:id/assignment | numbers:write | numbers.assign() |
GET /v1/numbers/:id/calendar | numbers:read | numbers.getCalendar() · py: numbers.get_calendar() |
PUT /v1/numbers/:id/calendar | numbers:write | numbers.setCalendar() · py: numbers.set_calendar() |
#Regole in entrata
| Request | Scope | SDK method |
|---|
GET /v1/inbound-routes | inbound_routes:read | inboundRoutes.list() · py: inbound_routes.list() |
POST /v1/inbound-routes | inbound_routes:write | inboundRoutes.create() · py: inbound_routes.create() |
PUT /v1/inbound-routes/order | inbound_routes:write | inboundRoutes.reorder() · py: inbound_routes.reorder() |
GET /v1/inbound-routes/:id | inbound_routes:read | inboundRoutes.get() · py: inbound_routes.get() |
PATCH /v1/inbound-routes/:id | inbound_routes:write | inboundRoutes.update() · py: inbound_routes.update() |
DELETE /v1/inbound-routes/:id | inbound_routes:write | inboundRoutes.delete() · py: inbound_routes.delete() |
#Regole di uscita
| Request | Scope | SDK method |
|---|
GET /v1/outbound-routes | outbound_routes:read | outboundRoutes.list() · py: outbound_routes.list() |
POST /v1/outbound-routes | outbound_routes:write | outboundRoutes.create() · py: outbound_routes.create() |
PUT /v1/outbound-routes/order | outbound_routes:write | outboundRoutes.reorder() · py: outbound_routes.reorder() |
GET /v1/outbound-routes/policy | outbound_routes:read | outboundRoutes.getPolicy() · py: outbound_routes.get_policy() |
PUT /v1/outbound-routes/policy | outbound_routes:write | outboundRoutes.setPolicy() · py: outbound_routes.set_policy() |
POST /v1/outbound-routes/simulate | outbound_routes:read | outboundRoutes.simulate() · py: outbound_routes.simulate() |
GET /v1/outbound-routes/:id | outbound_routes:read | outboundRoutes.get() · py: outbound_routes.get() |
PATCH /v1/outbound-routes/:id | outbound_routes:write | outboundRoutes.update() · py: outbound_routes.update() |
DELETE /v1/outbound-routes/:id | outbound_routes:write | outboundRoutes.delete() · py: outbound_routes.delete() |
#Segreteria
| Request | Scope | SDK method |
|---|
GET /v1/voicemail/settings | voicemail:read | voicemail.getSettings() · py: voicemail.get_settings() |
PUT /v1/voicemail/settings | voicemail:write | voicemail.setSettings() · py: voicemail.set_settings() |
GET /v1/voicemail/boxes | voicemail:read | voicemail.listBoxes() · py: voicemail.list_boxes() |
GET /v1/voicemail/boxes/:extensionId | voicemail:read | voicemail.getBox() · py: voicemail.get_box() |
PUT /v1/voicemail/boxes/:extensionId | voicemail:write | voicemail.updateBox() · py: voicemail.update_box() |
GET /v1/voicemail/boxes/:extensionId/messages | voicemail:read | voicemail.listMessages() · py: voicemail.list_messages() |
GET /v1/voicemail/boxes/:extensionId/messages/:messageId/audio | voicemail:read | voicemail.messageAudio() · py: voicemail.message_audio() |
PATCH /v1/voicemail/boxes/:extensionId/messages/:messageId | voicemail:write | voicemail.updateMessage() · py: voicemail.update_message() |
DELETE /v1/voicemail/boxes/:extensionId/messages/:messageId | voicemail:write | voicemail.deleteMessage() · py: voicemail.delete_message() |
GET /v1/voicemail/boxes/:extensionId/messages/:messageId/meta | voicemail:read | voicemail.messageMeta() · py: voicemail.message_meta() |
GET /v1/voicemail/boxes/:extensionId/messages/:messageId/transcript | voicemail:read | voicemail.messageTranscript() · py: voicemail.message_transcript() |
POST /v1/voicemail/boxes/:extensionId/messages/:messageId/transcribe | voicemail:write | voicemail.transcribeMessage() · py: voicemail.transcribe_message() |
POST /v1/voicemail/boxes/:extensionId/messages/:messageId/email | voicemail:write | voicemail.resendEmail() · py: voicemail.resend_email() |
#Registro chiamate
| Request | Scope | SDK method |
|---|
GET /v1/cdr | cdr:read | cdr.list() |
GET /v1/cdr/export.csv | cdr:read | cdr.export() |
GET /v1/cdr/:linkedid | cdr:read | cdr.get() |
#Chiavi API
| Request | Scope | SDK method |
|---|
GET /v1/api-keys | api_keys:read | apiKeys.list() · py: api_keys.list() |
POST /v1/api-keys | api_keys:write | apiKeys.create() · py: api_keys.create() |
GET /v1/api-keys/:id | api_keys:read | apiKeys.get() · py: api_keys.get() |
PATCH /v1/api-keys/:id | api_keys:write | apiKeys.update() · py: api_keys.update() |
POST /v1/api-keys/:id/rotate | api_keys:write | apiKeys.rotate() · py: api_keys.rotate() |
POST /v1/api-keys/:id/revoke | api_keys:write | apiKeys.revoke() · py: api_keys.revoke() |
GET /v1/api-keys/:id/usage | api_keys:read | apiKeys.usage() · py: api_keys.usage() |
GET /v1/api-keys/:id/usage/stats | api_keys:read | apiKeys.usageStats() · py: api_keys.usage_stats() |
#Sicurezza
| Request | Scope | SDK method |
|---|
GET /v1/security/summary | extensions:read | security.summary() |
GET /v1/security/status | security:read | security.status() |
GET /v1/security/bans | security:read | security.bans() |
POST /v1/security/bans | security:write | security.ban() |
POST /v1/security/bans/unban | security:write | security.unban() |
GET /v1/security/jails | security:read | security.jails() |
PUT /v1/security/jails/:name | security:write | security.updateJail() · py: security.update_jail() |
GET /v1/security/geo | security:read | security.geo() |
PUT /v1/security/geo/:service | security:write | security.updateGeo() · py: security.update_geo() |
GET /v1/security/whitelist | security:read | security.whitelist() |
POST /v1/security/whitelist | security:write | security.addWhitelist() · py: security.add_whitelist() |
DELETE /v1/security/whitelist/:id | security:write | security.deleteWhitelist() · py: security.delete_whitelist() |
GET /v1/security/settings | security:read | security.getSettings() · py: security.get_settings() |
PUT /v1/security/settings | security:write | security.setSettings() · py: security.set_settings() |
GET /v1/security/logs | security:read | security.logs() |
#Sistema
| Request | Scope | SDK method |
|---|
GET /v1/system/status | system:read | system.status() |
POST /v1/system/reload | system:write | system.reload() |
GET /v1/system/reload-jobs | system:read | system.reloadJobs() · py: system.reload_jobs() |
GET /v1/system/reload-jobs/:id | system:read | system.reloadJob() · py: system.reload_job() |
#Tempo reale
| Request | Scope | SDK method |
|---|
GET /v1/live/snapshot | live:read | live.snapshot() |
GET /v1/live/channels | live:read | live.channels() |
GET /v1/live/extensions | live:read | live.extensions() |
GET /v1/live/devices | live:read | live.devices() |
GET /v1/live/trunks | live:read | live.trunks() |
GET /v1/live/queues | live:read | live.queues() |
GET /v1/live/health | live:read | live.health() |
GET /v1/live/events | live:read | live.stream() |
GET /v1/live/ws | live:read | live.websocket() (TS) |
#Webhook
| Request | Scope | SDK method |
|---|
GET /v1/webhooks/event-types | webhooks:read | webhooks.eventTypes() · py: webhooks.event_types() |
GET /v1/webhooks | webhooks:read | webhooks.list() |
POST /v1/webhooks | webhooks:write | webhooks.create() |
GET /v1/webhooks/:id | webhooks:read | webhooks.get() |
PATCH /v1/webhooks/:id | webhooks:write | webhooks.update() |
DELETE /v1/webhooks/:id | webhooks:write | webhooks.delete() |
POST /v1/webhooks/:id/rotate-secret | webhooks:write | webhooks.rotateSecret() · py: webhooks.rotate_secret() |
POST /v1/webhooks/:id/test | webhooks:write | webhooks.test() |
GET /v1/webhooks/:id/deliveries | webhooks:read | webhooks.deliveries() |
POST /v1/webhooks/:id/deliveries/:deliveryId/retry | webhooks:write | webhooks.redeliver() |
#Orari e chiusure
| Request | Scope | SDK method |
|---|
GET /v1/calendars | calendars:read | calendars.list() |
POST /v1/calendars | calendars:write | calendars.create() |
GET /v1/calendars/holidays | calendars:read | calendars.holidays() |
GET /v1/calendars/:id | calendars:read | calendars.get() |
PATCH /v1/calendars/:id | calendars:write | calendars.update() |
DELETE /v1/calendars/:id | calendars:write | calendars.delete() |
PUT /v1/calendars/:id/hours | calendars:write | calendars.setHours() · py: calendars.set_hours() |
GET /v1/calendars/:id/status | calendars:read | calendars.status() |
POST /v1/calendars/:id/force | calendars:write | calendars.force() |
DELETE /v1/calendars/:id/force | calendars:write | calendars.clearForce() · py: calendars.clear_force() |
GET /v1/calendars/:id/overrides | calendars:read | calendars.overrides() |
POST /v1/calendars/:id/simulate | calendars:read | calendars.simulate() |
POST /v1/calendars/:id/holidays | calendars:write | calendars.preloadHolidays() · py: calendars.preload_holidays() |
GET /v1/calendars/:id/exceptions | calendars:read | calendars.listExceptions() · py: calendars.list_exceptions() |
POST /v1/calendars/:id/exceptions | calendars:write | calendars.createException() · py: calendars.create_exception() |
PATCH /v1/calendars/:id/exceptions/:exceptionId | calendars:write | calendars.updateException() · py: calendars.update_exception() |
DELETE /v1/calendars/:id/exceptions/:exceptionId | calendars:write | calendars.deleteException() · py: calendars.delete_exception() |
POST /v1/calendars/:id/ical/import | calendars:write | calendars.importIcal() · py: calendars.import_ical() |
GET /v1/calendars/:id/ical/export.ics | calendars:read | calendars.exportIcal() · py: calendars.export_ical() |
POST /v1/calendars/:id/ical/sync | calendars:write | calendars.syncIcal() · py: calendars.sync_ical() |
#Registrazioni
| Request | Scope | SDK method |
|---|
GET /v1/recordings | recordings:read | recordings.list() |
GET /v1/recordings/settings | recordings:read | recordings.getSettings() · py: recordings.get_settings() |
PUT /v1/recordings/settings | recordings:write | recordings.setSettings() · py: recordings.set_settings() |
GET /v1/recordings/policies | recordings:read | recordings.listPolicies() · py: recordings.list_policies() |
GET /v1/recordings/policies/effective | recordings:read | recordings.effectivePolicy() · py: recordings.effective_policy() |
PUT /v1/recordings/policies/:scope/:targetId | recordings:write | recordings.upsertPolicy() · py: recordings.upsert_policy() |
DELETE /v1/recordings/policies/:scope/:targetId | recordings:write | recordings.deletePolicy() · py: recordings.delete_policy() |
GET /v1/recordings/access-log | recordings:write | recordings.accessLog() · py: recordings.access_log() |
GET /v1/recordings/:id | recordings:read | recordings.get() |
DELETE /v1/recordings/:id | recordings:write | recordings.delete() |
GET /v1/recordings/:id/audio | recordings:read | recordings.audio() |
GET /v1/recordings/:id/transcript | recordings:read | recordings.transcript() |
POST /v1/recordings/:id/transcribe | recordings:write | recordings.transcribe() |
POST /v1/recordings/:id/summarize | recordings:write | recordings.summarize() |
#Inoltro al cellulare
| Request | Scope | SDK method |
|---|
GET /v1/extensions/:id/invisible-forwarding | extensions:read | forwarding.get() |
PUT /v1/extensions/:id/invisible-forwarding | extensions:write | forwarding.update() |
GET /v1/extensions/:id/provider-divert | tenants:write | forwarding.getProviderDivert() · py: forwarding.get_provider_divert() |
PUT /v1/extensions/:id/provider-divert | tenants:write | forwarding.setProviderDivert() · py: forwarding.set_provider_divert() |
#Notifiche
| Request | Scope | SDK method |
|---|
GET /v1/notifications/settings | notifications:read | notifications.getSettings() · py: notifications.get_settings() |
PUT /v1/notifications/settings | notifications:write | notifications.setSettings() · py: notifications.set_settings() |
GET /v1/notifications/log | notifications:read | notifications.log() |
POST /v1/notifications/test | notifications:write | notifications.test() |
#Lavori in corso
| Request | Scope | SDK method |
|---|
GET /v1/jobs/:id | media:read | jobs.get() |
| Request | Scope | SDK method |
|---|
GET /v1/ivrs | ivrs:read | ivrs.list() |
POST /v1/ivrs | ivrs:write | ivrs.create() |
GET /v1/ivrs/:id | ivrs:read | ivrs.get() |
PATCH /v1/ivrs/:id | ivrs:write | ivrs.update() |
DELETE /v1/ivrs/:id | ivrs:write | ivrs.delete() |
POST /v1/ivrs/:id/greeting-text | ivrs:read | ivrs.greetingText() · py: ivrs.greeting_text() |
#Gruppi di squillo
| Request | Scope | SDK method |
|---|
GET /v1/ring-groups | ring_groups:read | ringGroups.list() · py: ring_groups.list() |
POST /v1/ring-groups | ring_groups:write | ringGroups.create() · py: ring_groups.create() |
GET /v1/ring-groups/:id | ring_groups:read | ringGroups.get() · py: ring_groups.get() |
PATCH /v1/ring-groups/:id | ring_groups:write | ringGroups.update() · py: ring_groups.update() |
DELETE /v1/ring-groups/:id | ring_groups:write | ringGroups.delete() · py: ring_groups.delete() |
#Code
| Request | Scope | SDK method |
|---|
GET /v1/queues | queues:read | queues.list() |
POST /v1/queues | queues:write | queues.create() |
GET /v1/queues/:id | queues:read | queues.get() |
PATCH /v1/queues/:id | queues:write | queues.update() |
DELETE /v1/queues/:id | queues:write | queues.delete() |
GET /v1/queues/:id/live | live:read | queues.live() |
PUT /v1/queues/:id/members/:extensionId/pause | queues:write | queues.pauseMember() · py: queues.pause_member() |
GET /v1/queues/:id/callbacks | queues:read | queues.callbacks() |
#Musica d’attesa
| Request | Scope | SDK method |
|---|
GET /v1/moh | media:read | moh.list() |
POST /v1/moh | media:write | moh.create() |
GET /v1/moh/:id | media:read | moh.get() |
PATCH /v1/moh/:id | media:write | moh.update() |
DELETE /v1/moh/:id | media:write | moh.delete() |
#Messaggi vocali
| Request | Scope | SDK method |
|---|
GET /v1/prompts | media:read | prompts.list() |
POST /v1/prompts | media:write | prompts.createTts() · py: prompts.create_tts() |
POST /v1/prompts/upload | media:write | prompts.upload() |
GET /v1/prompts/:id | media:read | prompts.get() |
PATCH /v1/prompts/:id | media:write | prompts.update() |
DELETE /v1/prompts/:id | media:write | prompts.delete() |
POST /v1/prompts/:id/generate | media:write | prompts.generate() |
GET /v1/prompts/:id/audio | media:read | prompts.audio() |
#Rubrica
| Request | Scope | SDK method |
|---|
GET /v1/contacts | contacts:read | contacts.list() |
POST /v1/contacts | contacts:write | contacts.create() |
GET /v1/contacts/lookup | contacts:read | contacts.lookup() |
POST /v1/contacts/import | contacts:write | contacts.import() |
GET /v1/contacts/export | contacts:read | contacts.export() |
GET /v1/contacts/settings | contacts:read | contacts.getSettings() · py: contacts.get_settings() |
PUT /v1/contacts/settings | contacts:write | contacts.setSettings() · py: contacts.set_settings() |
GET /v1/contacts/:id | contacts:read | contacts.get() |
PATCH /v1/contacts/:id | contacts:write | contacts.update() |
DELETE /v1/contacts/:id | contacts:write | contacts.delete() |
#Operatività
| Request | Scope | SDK method |
|---|
GET /v1/ops/status | system:read | ops.status() |
#voiceNodes
| Request | Scope | SDK method |
|---|
GET /v1/voice-nodes | system:read | voiceNodes.list() · py: voice_nodes.list() |
POST /v1/voice-nodes | system:write | voiceNodes.create() · py: voice_nodes.create() |
GET /v1/voice-nodes/:id | system:read | voiceNodes.get() · py: voice_nodes.get() |
PATCH /v1/voice-nodes/:id | system:write | voiceNodes.update() · py: voice_nodes.update() |
DELETE /v1/voice-nodes/:id | system:write | voiceNodes.delete() · py: voice_nodes.delete() |
POST /v1/voice-nodes/:id/enrollment-code | system:write | voiceNodes.enrollmentCode() · py: voice_nodes.enrollment_code() |
POST /v1/voice-nodes/:id/revoke | system:write | voiceNodes.revoke() · py: voice_nodes.revoke() |
#voices
| Request | Scope | SDK method |
|---|
GET /v1/voices | media:read | voices.list() |
POST /v1/voices/sync | system:write | voices.sync() |
PUT /v1/voices/default | media:write | voices.setTenantDefault() · py: voices.set_tenant_default() |
PUT /v1/voices/platform-default | system:write | voices.setPlatformDefault() · py: voices.set_platform_default() |
GET /v1/voices/:voiceId/preview | media:read | voices.preview() |
POST /v1/voices/:voiceId/sample | media:write | voices.sample() |
