Skip to main content
Sonax is a cloud telephony and call-center platform (Sonax PABX Virtual, by Sonavoip). This connector uses the Sonax voice reporting API to bring your inbound and outbound call records into Nekt.
The Sonax API is available only to Sonax PABX customers. Your login credentials are provisioned by Sonax and can be found inside your PABX manager. There is no public/sandbox environment.

​
1. Add your Sonax access

  1. In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Sonax option from the list of connectors.
  2. Click Next and you’ll be prompted to fill the configuration.
    • Login ID: Your Sonax login identifier (the id used to authenticate), provided by Sonax.
    • Password: The password for that login.
    • Start date (advanced): The earliest call date to sync. Reports are fetched in date windows starting from this date.
    • Window Days (advanced): The size, in days, of each request window. Sonax caps a single query at 31 days; smaller windows keep each response bounded. Defaults to 1.
    • Row Limit (advanced): The maximum number of rows requested per window. Sonax returns only about 1,000 rows when left blank, so a high value is sent to avoid truncation. Defaults to 100,000.
  3. Click Next.

​
2. Select your Sonax streams

  1. The next step is letting us know which streams you want to bring. You can select entire groups of streams or only a subset of them.
    Tip: The stream can be found more easily by typing its name.
  2. Click Next.

​
3. Configure your Sonax data streams

  1. Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
    • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
    • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
    • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
    • Sync Type: depending on the data you are bringing to the lake, you can choose between INCREMENTAL and FULL_TABLE. Read more about Sync Types here.
  2. Click Next.

​
4. Configure your Sonax data source

  1. Describe your data source for easy identification within your organization. You can inform things like what data it brings, to which team it belongs, etc.
  2. To define your Trigger, consider how often you want data to be extracted from this source.
  3. Optionally, you can define some additional settings (if available).
    • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
    • Determine when to execute an Additional Full Sync.

​
Check your new source!

  1. Click Next to finalize the setup. Once completed, you’ll receive confirmation that your new source is set up!
  2. You can view your new source on the Sources page. Now, for you to be able to see it on your Catalog, you have to wait for the pipeline to run. If needed, manually trigger the pipeline by clicking on the refresh icon.
If you encounter any issues, reach out to us, and we’ll gladly assist you!

​
Streams and Fields

Below you’ll find all available data streams from Sonax. Both streams are synced incrementally across date windows, bookmarked on dt_inicio.
Inbound (receptive) calls that reached the PABX (/api/vingadora/relatorioEntrante), one record per call.Fields:
  • cid: String - Unique call identifier (protocolo) of the inbound call
  • dt_inicio: DateTime - Start timestamp of the call (ISO 8601); incremental replication key
  • ura_desc: String - Name of the IVR (URA) that handled the call, if any
  • espera: String - Time the caller waited before being answered (HH:MM:SS)
  • duracao: String - Total call duration (HH:MM:SS)
  • duracao_segundos: Integer - Total call duration in seconds
  • atendido: String - Answer status of the call (e.g. Atendida, Não atendida, Atendimento URA)
  • numero: String - Caller’s phone number (originating number)
  • agente_login: String - Login/accountcode of the agent who answered the call
  • agente_nome: String - Display name of the agent who answered the call
  • ramal: String - Extension (ramal) the call was routed to
  • alias: String - Alias (apelido) of the answering extension/agent
  • fila_desc: String - Name of the queue (fila) the call passed through
  • did_desc: String - Inbound number (DID/receptivo) the call arrived on
  • tabulacao_desc: String - Disposition/tabulation label assigned to the call
  • qtd_chamadas_desce: Integer - Number of associated transferred/dropped calls for this record
  • atendente_avaliacao_media: Number - Average satisfaction rating given to the agent for this call, if any
  • status: String - Processing status of the record returned by the API (e.g. OK)
Outbound (saínte) calls placed from the PABX (/api/vingadora/relatorioSainte), one record per call.Fields:
  • cid: String - Unique call identifier (protocolo) of the outbound call
  • dt_inicio: DateTime - Start timestamp of the call (ISO 8601); incremental replication key
  • duracao: String - Total call duration (HH:MM:SS)
  • duracao_segundos: Integer - Total call duration in seconds
  • atendido: String - Answer status of the outbound call (e.g. Atendida, Não atendida)
  • numero: String - Dialed (destination) phone number
  • agente_login: String - Login/accountcode of the agent who placed the call
  • agente_nome: String - Display name of the agent who placed the call
  • ramal: String - Extension (ramal) that originated the call
  • alias: String - Alias (apelido) of the originating extension/agent
  • campanha_desc: String - Name of the dialer campaign the call belongs to, if any
  • tabulacao_desc: String - Disposition/tabulation label assigned to the call
  • status: String - Processing status of the record returned by the API (e.g. OK)