ConnectCloud Developers

Get the NFON phone book settings (tenant:settings:read)

GET /api/crm/v1/nfon/config

Module: CRM · operationId: getNfonConfig · Tag: NFON telephony · Auth: access token (Authorization: Bearer <accessToken>)

The nfon section of the module configuration. The lastSync* fields describe the most recently started run. The NFON account and its API key are set up in comms.

Responses

  • 200 Settings (application/json)
  • 401 Missing, invalid or expired token (no body).
  • 403 The token lacks the permission (insufficient permissions) or has no active tenant. (application/json)
  • 500 Unexpected error; details are only logged. (application/json)

Fields of the 200 answer:

  • active (boolean): The phone book is sent only when active.
  • fullSyncCron (string): Schedule of the full run (comms empties and rebuilds the NFON phone book), same format. Missing: Sundays at 03:00 (0 3 * * 0); empty: no scheduled full run. When both schedules are due, the full run is sent.
  • includeLeads (boolean): Also put the CRM leads with a phone number into the phone book (after the masterdata contacts). (default true)
  • lastSync (string (date-time), read-only): Start of the most recent run.
  • lastSyncCount (integer, read-only): Entries the most recent run sent.
  • lastSyncError (string, read-only): First error of the most recent run.
  • lastSyncStatus (string, read-only): Status of the most recent run. (one of SUCCESS, FAILED)
  • syncIntervalCron (string): Schedule of the regular run: a 5-field cron expression in German time (prefix CRON_TZ=<zone> for another zone). Empty: no scheduled regular run; responses leave the field out then. A scheduled run sends only when something changed.

Example 200 answer:

{
  "active": true,
  "fullSyncCron": "0 3 * * 0",
  "includeLeads": true,
  "syncIntervalCron": "* * * * *"
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/crm/v1/nfon/config' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI