Residential devices¶
Residential Devices are the main routable option in Residential clients. More or less like Friends are to Virtual PBX Clients, devices contain the required configurable options to provide a SIP connectivity service with IvozProvider and an external SIP entity.
Warning
Although both Carriers/DDI Providers and Residential Devices are defined by the brand operator, the former are designed to connect with the public switched telephony network while the latter connects the system with our clients’ SIP entities.
Types of residential devices¶
There are 2 main types of SIP endpoints that can use residential with IvozProvider:
- Direct connection endpoint: IvozProvider must be able to talk SIP directly with this kind of devices by just forwarding the traffic to the proper port of the public IP address of the PBX.
- Endpoint behind NAT: Not directly reachable. This kind of endpoint must register at IvozProvider (just like all the Terminals do).
What kind of calls can be routed through a Residential Device?¶
Contrary to Friends, Residential Devices have some simplifications and limitations:
- Residential Devices only route their assigned DDIs
- Residential Devices only place externals calls to Carriers
- Residential Devices only receive external calls from DDI Providers
Residential Devices Configuration¶
These are the configurable settings of Residential devices:
- Name
- Name of the residential device. This name must be unique in the whole brand so it’s recommended to use some kind of sequential identifier. This will also be used in SIP messages (sent From User).
- Description
- Optional. Extra information for this residential device.
- Password
- When the residential device send requests, IvozProvider will authenticate it using this password. Using password IS A MUST in “Register” mode. In “Direct” mode, leaving it blank disables SIP authentication and enables IP source check.
- Direct connectivity
- If you choose ‘Yes’ here, you’ll have to fill the protocol, address and port where this residential device can be contacted.
- Language
- Locutions will be played in this language
- Numeric transformation
- Numeric transformation set that will be applied when communicating with this device.
- Fallback Outgoing DDI
- External calls from this residential device will be presented with this DDI, unless the source presented matches a DDI belonging to the residential client.
- Allowed codec
- Like vPBX terminals, residential devices will talk only the selected codec.
- From domain
- Request from IvozProvider to this device will include this domain in the From header.
- DDI In
- If set to ‘Yes’, set destination (R-URI and To) to called DDI when calling to this endpoint. If set ‘No’, username used in Contact header of registration will be used, as specified in SIP RFC (residential device name will be used for endpoints with direct connectivity). Defaults to ‘No’.
- Call waiting
- Limits received calls when already handling this number of calls. Set 0 for unlimited.
- Enable T.38 passthrough
- If set to ‘yes’, this SIP endpoint must be a T.38 capable fax sender/receiver. IvozProvider will act as a T.38 gateway, bridging fax-calls of a T.38 capable carrier and a T.38 capable device.
- RTP Encryption
- If set to ‘yes’, call won’t be established unless it’s possible to encryption its audio. If set to ‘no’, audio won’t be encrypted.
- Multi Contact
- Same SIP credentials can be configured in multiple SIP devices. In that case, all devices ring simultaneously when receiving a call. Setting this toggle to ‘No’ limits this behaviour so that only latest registered SIP device rings.
Tip
Residential device can be contacted due to calls to several DDIs. DDI In setting allows remote SIP endpoint to know which number caused each call, setting that number as destination (R-URI and To headers). This way, residential device can handle calls differently.
Voicemail settings¶
Every residential device has a voicemail that can be accessed using voicemail service code defined at brand level.
Call forwarding settings¶
Apart from unconditional call forwarding to external number through External call filters applied to DDI, residential devices may have additional call forwarding settings that allow:
- Forwarding to another external number.
- Forwarding to voicemail associated to each residential device.
- Supported forwarding types: unconditional, no-answer, non-registered, busy.
Warning
External call filters have precedence over residential devices call forwarding settings.
Tip
Forwarding to national numbers can be configured using services codes (further information here).
Asterisk as a residential device¶
At the other end of a device can be any kind of SIP entity. This section takes as example an Asterisk PBX system using SIP channel driver that wants to connect to IvozProvider.
Device register¶
If the system can not be directly access, Asterisk will have to register in the platform (like a terminal will do).
Configuration will be something like this:
register => residentialDeviceName:residentialDevicePassword@ivozprovider-brand.sip-domain.com
Device peer¶
[residentialDeviceName]
type=peer
host=ivozprovider-brand.sip-domain.com
context=XXXXXX
disallow=all
allow=alaw
defaultuser=residentialDeviceName
secret=residentialDevicePassword
fromuser=residentialDeviceName
fromdomain=ivozprovider-brand.sip-domain.com
insecure=port,invite
sendrpid=pai
directmedia=no
Warning
Residential devices MUST NOT challenge IvozProvider. That’s why the insecure setting is used here.
Note
As From username is used to identify the residential device, P-Asserted-Identity (or P-Preferred-Identity or Remote-Party-Id) must be used to specify caller number. Prevalence among these source headers is: PAI > PPI > RPID.