PortaSwitch configuration to set up Voice AI Agent (Apifonica)

Link copied to clipboard

This handbook provides the PortaSwitch configuration steps required to set up the Voice AI Agent (Apifonica) module, available via the Add-on Mart.

After completing the described steps, refer to this instruction for comprehensive instructions on configuring and deploying the Voice AI Agent (Apifonica) module.

Configuration overview

Link copied to clipboard
  1. Verify SIP-to-SIP connection
  2. Create a new node for the Voice AI GW
  3. Create a new service for calls handled by Voice AI agents
  4. Create a new rate code for the AI agent service
  5. Create a new tariff and rate for the AI agent service
  6. Update the product to include the AI agent service
  7. Create a vendor for Voice AI GW

1. Verify SIP-to-SIP connection

Link copied to clipboard

Make sure an internal connection for SIP-to-SIP (on-net) calls exists in PortaBilling. This is required for routing calls between PortaSIP and the Voice AI GW.

2. Create a new node for the Voice AI GW

Link copied to clipboard
  1. Navigate to Infrastructure > Nodes and fill in the following details:
    • Name – type a short descriptive name of the server.
    • Node ID – type the node ID of the Voice AI GW.
    • IP address – type the same value as Node ID.
    • Manufacturer – select PortaOne.
    • Type – select Generic.

      Create node for Voice AI GW.

  2. Click Save & Edit details.
  3. Navigate to the Communication with billing panel, turn on the Enable communication with billing toggle, and fill in the following details:
    • Client protocol – select RADIUS.
    • RADIUS key – type the RADIUS Secret value of the Voice AI GW, provided by the Support team.
    • RADIUS source IP – type the RADIUS Bind Address of the Voice AI GW, provided by the Support team.

      Configure node for Voice AI GW.

3. Create a new service

Link copied to clipboard
  1. Navigate to Service catalog > Services.
  2. Click + Service and fill in the new service details:
    • Name – specify the service name, e.g., AI agent.
    • Type – select Voice calls.
    • Rating base – select session-time (seconds).
    • Base unit – select seconds.
    • Billing unit – select minute.
    • Base ratio – leave default value, 60.
    • Usage charging – select Yes.

      Add AI agent service.

  3. Click Save.

4. Create a new rate code

Link copied to clipboard
  1. Navigate to Service catalog > Rate codes.
  2. Click + Add and fill in the new rate code details:
    • Format – select Custom.
    • Prefix – type the rate code provided by the Support team, e.g., AI-AGENT.

      Create rate code for AI agent.

5. Create a new tariff and rate

Link copied to clipboard
  1. Navigate to Service catalog > Tariffs.
  2. Click + Tariff and fill in the new tariff details:
    • Tariff name – specify the tariff name, e.g., AI agent.
    • Currency – select the currency.
    • Service – select the AI agent service created in step 3.
    • Applied to – select Customer.
    • Define prices – leave the default value, per individual rate code.

      Add tariff for AI agent.

  3. Click Save & Edit.
  4. On the Rates page, click + Rate, select AI-AGENT rate code, and define the price for calls to AI Agent.

    Add rate for AI agent.

6. Update the product

Link copied to clipboard
  1. Navigate to Service catalog > Products and find the product assigned to your cloud PBX customers.
  2. Add AI agent service to the product. On the product page, go to Services, click Add a service, select the checkbox for AI agent service, and click Add.

    Add AI agent service to product.

  3. Add a new usage charge entry to the product. On the product page, go to Usage charges, click Add, and fill in the details:
    • Service – select AI agent.
    • Node – select the node configured in step 2, e.g., Voice AI GW.
    • Access code – type the access code provided by the support team, e.g., VOICE_AI_GW.
    • Tariff – select the AI agent tariff created in step 5.

      Add AI agent usage charges to product.

7. Create a vendor for Voice AI GW

Link copied to clipboard

A vendor connection is required to generate xDRs and track costs for calls routed to AI agents. You can create a separate vendor and connection for this, or add a new connection to the existing vendor.

  1. Navigate to Service catalog > Tariffs.
  2. Click + Tariff and fill in the new tariff details:
    • Tariff name – specify the tariff name, e.g., AI agent cost.
    • Currency – select the currency.
    • Service – select the AI agent service created in step 3.
    • Applied to – select Vendor.
    • Routing – leave this option disabled.
    • Define prices – leave the default value, per individual rate code.

      Add tariff for AI agent cost.

  3. Click Save & Edit.
  4. On the Rates page, click + Rate, select AI-AGENT rate code, and set the per-minute cost of calls to AI Agent (if any).

    Add rate for AI agent cost.

  5. Create a connection for calls handled by the AI agent. On the vendor page, navigate to Connections, click + Add, and fill in the connection details:
    • Name – specify the connection name, e.g., Calls to AI Agent.
    • Service type – select Voice calls.
    • Type of connections – select PSTN.
    • Direction – select To vendor.
    • Tariff – select the tariff created in step 7.
    • Node – select the node configured in step 2.
    • Capacity - type the maximum number of simultaneous calls handled by the node. This parameter is only used for correctly scaling the load graph for the connection.

      Create AI agent connection.

Docs for
What's new
Admin manuals
Handbooks
UI help
Developers documentation