To ensure compatibility with future releases of PortaBilling, it is highly recommended that you follow the Cisco guidelines regarding which attributes must be contained in each authentication or accounting request. For more information, please refer to the RADIUS Vendor-Specific Attributes Voice Implementation Guide at Cisco website.
Authentication/Authorization requests
Currently, the following attributes are required for correct processing of authentication/authorization requests:
|
Attribute |
Description |
|---|---|
|
NAS-IP-Address (required) |
Specifies the IP address of the network access server that is requesting authentication |
|
NAS-Identifier |
Specifies the name (e.g., the hostname) of the network access server that is requesting authentication. Either NAS-IP-Address or NAS-Identifier attributes must be present in the authentication request |
|
User-Name (required) |
Indicates the name of the user being authenticated by the RADIUS server |
|
Password |
Indicates the user’s password |
|
Called-Station-Id |
The telephone number the user called. Only for authorization requests |
|
Message-Authenticator |
Used to authenticate and protect the integrity of Access-Requests in order to prevent spoofing |
|
h323-conf-id |
The unique call identifier generated by the gateway. Used to identify the separate billable events (calls) within a single calling session |
|
h323-incoming-conf-id |
The unique number for identifying a parent session on a gateway, where a session is closed when the calling party hangs up. It is used to:
The value used for legs 1 and 2 on the originating gateway can differ from that for legs 3 and 4 on a terminating gateway. The h323-incoming-conf-id is different from h323-conf-id. |
|
h323-ivr-out |
User-definable attribute-value pairs sent from the NAS to the RADIUS server |
|
PortaOne-* |
PortaOne specific attributes sent from the NAS to the RADIUS server. The list of attributes is described in the PortaBilling custom attributes section |
Authentication/Authorization responses
Currently, the following standard attributes are used (A1 = authentication, A2 = authorization):
|
Attribute |
A1 |
A2 |
Description |
|---|---|---|---|
|
h323-billing-model |
Y |
|
Type of billing service for a specific session (0 Credit, 1 Debit) |
|
h323-return-code |
Y |
Y |
Return codes are the server’s instructions to the network access server. The list of possible values are described in the RADIUS Return Codes section |
|
h323-currency |
Y |
Y |
Currency used with h323-credit-amount (in ISO_4217 format, for example USD, EUR) |
|
h323-preferred-lang |
Y |
Y |
Language to use for the audio prompt (in ISO 639-1 format, for example en, es, de) |
|
h323-credit-amount |
Y |
|
Amount of credit (in currency) in the account |
|
h323-redirect-number |
Y |
|
Optional Phone number to which the call is redirected |
|
h323-ivr-in |
Y |
Y |
User-definable attribute-value pairs sent from the RADIUS server back to the NAS |
|
Message-Authenticator |
Y |
Y |
Used to authenticate and protect the integrity of Access-Requests in order to prevent spoofing |
|
Reply-Message |
Y |
Y |
The description of the accept or reject message |
|
PortaOne-* |
Y |
Y |
PortaOne specific attributes sent from the RADIUS server to the NAS. The list of attributes is described in the PortaBilling custom attributes section |
Accounting requests
Currently, the following attributes are required for the correct processing of accounting requests:
|
Attribute |
Description |
|---|---|
|
NAS-IP-Address |
Specifies the IP address of the network access server that is sending accounting requests |
|
NAS-Identifier |
Specifies the name (e.g., the hostname) of the network access server that is requesting authentication. Either NAS-IP-Address or NAS-Identifier attributes must be present in the request |
|
NAS-Port-Name |
Indicates the name of the physical NAS port that is authenticating the user |
|
User-Name |
Indicates the name of the user for the accounting request |
|
Calling-Station-Id |
The telephone number the call or message came from |
|
Called-Station-Id |
The telephone number the user called/sent a message |
|
Acct-Session-Time |
Indicates how long (in seconds) the user has received service |
|
Acct-Status-Type |
Indicates the stage of the session, whether this Accounting-Request marks the beginning of the user service (Start), interim update (Alive) or the end (Stop) |
|
h323-remote-address |
IP address of the remote voice equipment. PortaBilling uses it to disambiguate different IP route paths on a NAS |
|
h323-setup-time |
Indicates the setup time in Network Time Protocol (NTP) format: hour, minutes, seconds, microseconds, time_zone, day, month, day_of_month, year |
|
h323-connect-time |
Indicates the connect time in Network Time Protocol (NTP) format: hour, minutes, seconds, microseconds, time_zone, day, month, day_of_month, and year |
|
h323-disconnect-time |
Indicates the disconnect time in Network Time Protocol (NTP) format: hour, minutes, seconds, microseconds, time_zone, day, month, day_of_month, year |
|
h323-conf-id |
The unique call identifier generated by the gateway. Used to identify the separate billable events (calls) within a single session. When this attribute is not present, PortaBilling calculates the equivalent ID from other attributes, for example Acct-Session-Id |
|
h323-incoming-conf-id |
The unique number for identifying a calling session on a NAS, where a session is closed when the calling party hangs up. The h323-incoming-conf-id number is used to:
|
|
h323-disconnect-cause |
Specifies the reason a call was disconnected (e.g., 0x10 - normal ending, 0x3 no route, 0x11 user busy, 0x1F normal unspecified) |
|
h323-call-origin |
The NAS’es behavior in relation to the connection that is active for this leg. Possible values: answer, originate. For example, answer on leg 1; originate on leg 2 |
|
h323-call-type |
Protocol type or family used on this leg of the call. Possible values: VoIP, Telephony |
|
h323-ivr-out |
User-definable attribute-value (AV) pairs sent from the NAS to the RADIUS server |
