/
Official Documentation (Prime VoIP ENVIA)

Official Documentation (Prime VoIP ENVIA)

Official Documentation (Prime VoIP ENVIA)

Operational guide for the nmsprime-provvoipenvia package (ProvVoipEnvia). Nested how-to pages under this section keep carrier-specific procedures.

Prerequisites

  • OS VoIP Provisioning (nmsprime-provvoip) installed and phonenumbers/modems modelled.

  • envia TEL credentials in /etc/nmsprime/env/provvoipenvia.env (API URL, username, password).

  • Roles that may create Envia orders and view Envia contracts.

Concepts

Concept

Meaning

Concept

Meaning

EnviaOrder

Workflow item for an Envia API method (create contract, create voip account, phonebook, port, …).

EnviaContract

Local mirror of the wholesale contract identity returned by Envia.

API method

Named Envia operation triggered from contract / modem / phonenumber / phonebookentry views (see ProvVoipEnvia entity job lists).

Phonebook entry

Directory listing managed via phonebookentry_get / create / delete API actions.

Availability

Probe whether a location/service can be ordered (EnviaAvailabilityCheckClient / availability check).

Typical order lifecycle

  1. Operator creates or triggers an EnviaOrder from the contract / modem / phonenumber / phonebook context.

  2. Queue / artisan runs provvoipenvia:process_envia_orders (and related status refresh).

  3. Status and optional stored XML (when PROVVOIPENVIA__STORE_XML_* is enabled) remain on the order.

  4. Successful creates update EnviaContract / phonenumber / modem links as applicable.

  5. Console getters/updaters refresh references, orders, and voice data.

First-time setup

Follow the nested guide: Provisioning VoIP envia TEL Setup.

Summary of artisan commands used there / in modules/ProvVoipEnvia/Console:

Command

Purpose

Command

Purpose

provvoipenvia:get_envia_customer_references

Pull customer references

provvoipenvia:get_envia_contracts_by_customer

Pull contracts for customers

provvoipenvia:get_envia_contract_references

Pull contract references for phonenumbers

provvoipenvia:update_envia_orders

Refresh Envia orders (also drives Billing item date sync when Billing is active)

provvoipenvia:process_envia_orders

Process pending Envia orders

provvoipenvia:update_voice_data

Refresh SIP/TRC / voice data

provvoipenvia:update_envia_customer_references_from_csv

CSV-based customer reference update

Related OS VoIP code tables (from the setup guide): provvoip:update_carrier_code_database, provvoip:update_ekp_code_database, provvoip:update_trc_class_database.

Verify credentials with the UI action Ping envia TEL API (misc_ping) — expect a “pong”.

Operations covered by nested guides

Topic

Nested page

Topic

Nested page

Initial envia TEL setup

Provisioning VoIP envia TEL Setup

Request new phonenumber

Requesting a new Phonenumber

Port from another carrier

Porting a Number from another VoIP carrier

Change / cancel phonenumber

Changing/Canceling a Phonenumber

Voice / item dates → Billing

Connection to Billing

Flow diagram

Flow diagram

Directory & carrier services

Directory entries & carrier services

Error handling

  • Failed API calls leave the EnviaOrder in an error / interaction-needed state with stored request/response when XML store is on.

  • Do not manually invent Envia contract IDs — create via successful API paths.

  • When Envia rejects an order, fix the business data (address, customer, number) and retry per Envia rules.

Related packages

Package

Role

Package

Role

nmsprime-provvoip

Phonenumber / modem VoIP model (required)

nmsprime-billing

Voice item date sync / settlement when installed

nmsprime-provbase

Contract / modem

Source pointers

  • Models: modules/ProvVoipEnvia/Entities/

  • Controllers: modules/ProvVoipEnvia/Http/Controllers/

  • Console: modules/ProvVoipEnvia/Console/

  • Availability client: modules/ProvVoipEnvia/Services/EnviaAvailabilityCheckClient.php

  • Install config: modules/ProvVoipEnvia/Install/config.cfg