Retail

Retail clients are even a more lightweight client type than Residential clients.

They just provide a SIP trunking service that include these features:

  • Configure one or more retail accounts (SIP devices).
  • Setup one or more DDIs.
  • Place external calls showing one of those DDIs.
  • Receive external calls to their DDIs.
  • Record calls.

Warning

No users, no extensions, no internal calls, no hunt groups, no IVRs, no voicemail... just incoming and outgoing external calls.

Error

Retail clients and their accounts MUST use Brand’s SIP domain in their SIP messages.

Differences between retail and residential clients

There is an important key difference between these two clients: retail client calls do not traverse any application server.

As a result:

  • No virtual faxing service for retail clients.
  • No voicemail service for retail clients.

But they also have benefits that make them ideal for some situations:

  • No application server traverse, much less load for the platform.
  • Call transcoding as a feature.
  • Routing tags for different call routing for same destinations.

Warning

Residential devices are force to talk the codec selected in their configuration (just one). Retail clients, on the other hand, can talk in the codecs they offer in their SDP and in the codecs selected in IvozProvider: IvozProvider will make transcoding when necessary.

Tip

Use retail client type unless you need any of the services provided by application servers (fax or voicemails).

Adding/Editing retail clients

Hint

Some fields described below may not be visible depending on enabled features.

These are the fields shown when adding a new retail client:

Name
Used to reference this particular client.
Billing method
To choose among postpaid, prepaid and pseudo-prepaid. ‘none’ disables billing.
Language
Used to choose the language of played locutions.
Country code
Default country code for DDIs.
Default timezone
Used for showing call registries dates.
Currency
Chosen currency will be used in price calculation, invoices, balance movements and remaining money operations of this client.
Numeric transformation
Describes the way the client will “talk” and the way the client wants to be “talked”.
Max calls
Limits both incoming and outgoing external calls (0 for unlimited).
Filter by IP address
If set, the platform will only allow calls coming from allowed IP/ranges or countries.
GeoIP allowed countries
If Filter by IP address is enabled, traffic from selected countries will be allowed.
Max daily usage
Limits external outbound calls when this limit is reached within a day. At midnight counters are reset and accounts are re-enabled.
Email
A notification email will be sent to given address when configured max daily usage is reached. Leave empty to avoid notification.

When editing a client, these additional fields can be configured:

Invoice data
All the fields in this group will be included in invoices generated for this client. This section also allows showing/hiding billing details to client’s portal, such as Invoices, Rating Profiles and Price of external calls.
Outgoing DDI
Fallback DDI for external outgoing calls (can be overridden at residential device level).
Routing tags
This field allows enabling routing tags for this specific client. Call preceded with this routing tags will be rated and routed differently.
Audio transcoding
This field allows enabling codecs for this specific client. This codecs will be added to the ones offered by the client in its SDP.
Allow Client to remove recordings
Shown only if Recording feature is enabled for client, shows/hides recording removal button on client Call Recordings section.

Error

Selecting codecs in Audio transcoding may lead to uneeded transcoding. Selecting ALL codecs is always a horrible idea. Do not select any codec unless this client does not support an specific codec that is compulsory for a needed destination/carrier.

Note

Apart from these fields, main operator (aka God) will also see a Platform data group that allows:

  • Choosing an specific media relay set for the client.

Tip

For outgoing calls, platform will use the CLID provided by the client as long as it is considered valid, otherwise fallback DDI will be used. The platform will consider as valid any CLID that matches one of the client’s DDIs.

Additional subsections

Each entry in this table has these additional options:

  • List of authorized sources: if Filter by IP address is enabled, this subsection allows adding addresses or network ranges.

Error

No outgoing call will be allowed if Filter by IP address is enabled and the corresponding list is empty.

  • List of client admins: this subsection allows managing portal credentials for this specific client. Read ACLs for further explanation about restricted client administrators.
  • List of Rating profiles: this subsection allows managing the rating profiles that will be used to bill its outgoing calls.

Warning

No outgoing call will be allowed for this client unless an active rating profiles that can bill the specific call.