ATS9900 Ro Interface Specifications
ATS9900 Ro Interface Specifications
V100R005C02
Ro Interface Specifications
Issue
Date 2012-11-30
PUBLIC
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and
the customer. All or part of the products, services and features described in this document may not be
within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements,
information, and recommendations in this document are provided "AS IS" without warranties, guarantees or
representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute the warranty of any kind, express or implied.
Website: http://www.huawei.com
Email: [email protected]
Author
Prepared by Qin Kaiyong Date 2009-4-7
Reviewed by Date
Approved by Date
Authorized by Date
Change History
Date Revision CR ID Section Change Description Author
Version / Number
Defect
ID
2009-4-7 1.00 First draft Qin Kaiyong
(ID:56306)
2009-09-18 1.10 Added new AVPs, removed some AVPs Wei Yinghua
that the ATS does not use, and modified the (00111487)
description of some AVPs.
Contents
5.4.50 Result-Code......................................................................................................................................... 43
5.4.51 Role-of-Node ...................................................................................................................................... 44
5.4.52 Scale-Factor ........................................................................................................................................ 44
5.4.53 Service-Context-Id .............................................................................................................................. 45
5.4.54 Session-Id ............................................................................................................................................ 45
5.4.55 Service-Identifier ................................................................................................................................ 46
5.4.56 Service-Identity-List_CTEL ............................................................................................................... 46
5.4.57 Service-Information ............................................................................................................................ 46
5.4.58 SDP-Media-component ....................................................................................................................... 47
5.4.59 SDP-Session-Description .................................................................................................................... 47
5.4.60 SIP-Method ......................................................................................................................................... 47
5.4.61 SIP-Request-Timestamp ..................................................................................................................... 48
5.4.62 SIP-Response-Timestamp ................................................................................................................... 48
5.4.63 SDP-Media-Identifier.......................................................................................................................... 49
5.4.64 Subgroup-ID ....................................................................................................................................... 49
5.4.65 Subscription-ID ................................................................................................................................... 50
5.4.66 Subscription-Id-Type .......................................................................................................................... 50
5.4.67 Subscription-Id-Data ........................................................................................................................... 51
5.4.68 Termination-Cause .............................................................................................................................. 51
5.4.69 Time-Stamps ....................................................................................................................................... 52
5.4.70 Unit-Value ........................................................................................................................................... 52
5.4.71 Unit-Threshold .................................................................................................................................... 52
5.4.72 Used-Service-Unit ............................................................................................................................... 53
5.4.73 User-Session-Id ................................................................................................................................... 53
5.4.74 Value-Digits ........................................................................................................................................ 54
5.4.75 VPN-Call-property .............................................................................................................................. 54
5.4.76 Call-Property ....................................................................................................................................... 54
5.4.77 Called-Asserted-Identity ..................................................................................................................... 55
5.4.78 Number-Portability-Routing-Information ........................................................................................... 55
5.4.79 Ringing-Duration ................................................................................................................................ 56
5.4.80 Abnormal-Finish-Info ......................................................................................................................... 56
5.4.81 Abnormal-Finish-Warning .................................................................................................................. 56
5.4.82 Abnormal-Finish-Reason .................................................................................................................... 56
5.4.83 Carrier-Select-Routing-Information .................................................................................................... 57
5.4.84 Session-Priority ................................................................................................................................... 57
5.5 Work Flow ...................................................................................................................................................... 58
5.5.1 Online Charging Flow for the ATS + OCS Solution ............................................................................. 58
5.5.2 Configuring Data for Interworking Between the ATS and an External OCS ........................................ 59
A Result-Code Definition............................................................................................................. 60
The clauses in the following files become the clauses of this specification through reference.
All the sequent modification sheets (excluding the corrigenda) of the referenced files marked
with date are not fit for this specification. However, the parties that reach an agreement
according to this specification are recommended to study whether the latest versions of these
files can be used. The latest versions for all the referenced files without date are fit for this
specification.
[1] IETF RFC 3588: "Diameter Base Protocol"
[2] IETF RFC 4006: "Diameter Credit-Control Application"
[3] 3GPP TS 32.299 V8.3.0: "Telecommunication management; Charging management;
Diameter charging application"
[4] 3GPP TS 32.251 V8.2.0: "Telecommunication management; Charging management;
Packet Switched (PS) domain charging"
[5] 3GPP TS 32.296 V8.3.0: "Charging management; Online Charging System (OCS)
Applications and interfaces"
[6] 3GPP TS 32.815 V6.1.0: "Charging management; Online Charging System (OCS)
architecture study"
2.1 Definitions
AAA
Authentication, Authorization and Accounting.
Accounting
The act of collecting information on resource usage for the purpose of capacity planning,
auditing, billing or cost allocation.
Accounting Record
An accounting record represents a summary of the resource consumption of a user over the
entire session. Accounting servers creating the accounting record by processing interim
accounting events or accounting events from several devices serving the same user.
Authentication
The act of verifying the identity of an entity (subject).
Authorization
The act of determining whether a requesting entity (subject) will be allowed access to a
resource (object).
AVP
The Diameter protocol consists of a header followed by one or more Attribute-Value-Pairs
(AVPs). An AVP includes a header and is used to encapsulate protocol-specific data (for
example, routing information) as well as authentication, authorization or accounting
information.
Diameter Agent
A Diameter Agent is a Diameter node that provides either relay, proxy, redirect or translation
services.
Diameter Client
A Diameter Client is a device at the edge of the network that performs access control. An
example of a Diameter client is a Network Access Server (NAS) or a Foreign Agent (FA).
Diameter Node
A Diameter node is a host process that implements the Diameter protocol, and acts either as a
Client, Agent or Server.
Diameter Peer
A Diameter Peer is a Diameter Node to which a given Diameter Node has a direct transport
connection.
Diameter Server
A Diameter Server is one that handles authentication, authorization and accounting requests
for a particular realm. By its very nature, a Diameter Server must support Diameter
applications in addition to the base protocol.
Realm
The string in the NAI that immediately follows the '@' character. NAI realm names are
required to be unique, and are piggybacked on the administration of the DNS name space.
Diameter uses the realm, also loosely referred to as domain, to determine whether messages
can be satisfied locally, or whether they must be routed or redirected. In RADIUS, realm
names are not necessarily piggybacked on the DNS name space but may be independent of it.
Session State
A stateful agent is one that maintains session state information, by keeping track of all
authorized active sessions. Each authorized session is bound to a particular service, and its
state is considered active either until it is notified otherwise, or by expiration.
Transport Connection
A transport connection is a TCP or SCTP connection existing directly between two Diameter
peers, otherwise known as a Peer-to-Peer Connection.
3 Protocol Architecture
the corresponding request. The End-to-End Identifier must not be modified by Diameter
agents of any kind. The combination of the Origin-Host and this field is used to detect
duplicates. Duplicate requests cause the same answer to be transmitted, and must not
affect any state that is set when the original request is processed. Duplicate answer
messages that are to be locally consumed are silently discarded.
AVPs: AVPs are a method of encapsulating information relevant to the Diameter
message.
AVP Code
The AVP Code, combined with the Vendor-ID field, identifies the attribute uniquely. AVP
numbers 1 to 255 are reserved for backward compatibility with RADIUS, without setting
the Vendor-ID field. AVP numbers 256 and above are used for Diameter, which are
allocated by IANA.
AVP Flags
The AVP Flags field informs the receiver how each attribute must be handled. The 'r'
(reserved) bits are unused and must be set to 0. Note that subsequent Diameter
applications may define additional bits within the AVP header, and an unrecognized bit is
considered an error. The 'P' bit indicates the need for encryption for end-to-end security.
The 'M' Bit, known as the Mandatory bit, indicates whether support of the AVP is
required. If an AVP with the 'M' bit set is received by a Diameter client, server, proxy, or
translation agent and either the AVP or its value is unrecognized, the message must be
rejected. Diameter Relay and redirect agents must not reject messages with unrecognized
AVPs.
AVPs with the 'M' bit cleared are informational only and a receiver that receives a
message with such an AVP that is not supported, or whose value is not supported, may
simply ignore the AVP.
The 'V' bit, known as the Vendor-Specific bit, indicates whether the optional Vendor-ID
field is present in the AVP header. When set the AVP Code belongs to the specific vendor
code address space.
Unless otherwise noted, AVPs will have the following default AVP
Flags field settings:
The 'M' bit must be set. The 'V' bit must not be set.
AVP Length
The AVP Length field is three octets, and indicates the number of octets in this AVP
including the AVP Code, AVP Length, AVP Flags, Vendor-ID field (if present) and the
AVP data. If a message is received with an invalid attribute length, the message is
rejected.
64 bit unsigned value, in network byte order. The AVP Length field must be set to 16 (20
if the 'V' bit is enabled).
Float32
This represents floating point values of single precision as described by IEEE 754-1985.
The 32-bit value is transmitted in network byte order. The AVP Length field must be set
to 12 (16 if the 'V' bit is enabled).
Float64
This represents floating point values of double precision as described by IEEE 754-1985.
The 64-bit value is transmitted in network byte order. The AVP Length field must be set
to 16 (20 if the 'V' bit is enabled).
Grouped
The Data field is specified as a sequence of AVPs. Each of these AVPs follows - in the
order in which they are specified - including their headers and padding. The AVP Length
field is set to 8 (12 if the 'V' bit is enabled) plus the total length of all included AVPs,
including their headers and padding. In this way, the AVP length field of an AVP of the
Grouped type is always a multiple of 4.
Address
The Address format is derived from the OctetString AVP Base Format. It is a
discriminated union, representing, for example a 32-bit (IPv4) [IPV4] or 128-bit (IPv6)
[IPV6] address, most significant octet first. The first two octets of the Address AVP
represent the AddressType, which contains an Address Family defined in
[IANAADFAM]. The AddressType is used to discriminate the content and format of the
remaining octets.
Time
The Time format is derived from the OctetString AVP Base Format. The string must
contain four octets, in the same format as the first four bytes are in the NTP timestamp
format. The NTP Timestamp format is defined in chapter 3 of [SNTP]. This represents
the number of seconds since 0h on 1 January 1900 with respect to the Coordinated
Universal Time (UTC). On 6h 28m 16s UTC, 7 February 2036 the time value will
overflow. SNTP [SNTP] describes a procedure to extend the time to 2104. This
procedure must be supported by all DIAMETER nodes.
UTF8String
The UTF8String format is derived from the OctetString AVP Base Format. This is a
human readable string represented using the ISO/IEC IS 10646-1 character set, encoded
as an OctetString using the UTF-8 [UFT8] transformation format described in RFC
2279.
Diameter Identity
The Diameter Identity format is derived from the OctetString AVP Base Format.
Diameter Identity = FQDN
Diameter Identity value is used to uniquely identify a Diameter node for purposes of
duplicate connection and routing loop detection.
The contents of the string must be the FQDN of the Diameter node. If multiple Diameter
nodes run on the same host, each Diameter node must be assigned a unique Diameter
Identity. If a Diameter node can be identified by several FQDNs, a single FQDN is
picked at startup, and used as the only Diameter Identity for that node, whatever the
connection it is sent on.
Enumerated
Enumerated is derived from the Integer32 AVP Base Format. The definition contains a
list of valid values and their interpretation and is described in the Diameter application
introducing the AVP.
4 Interface Description
ATS
The Advanced Telephony Server (ATS) complies with the Diameter protocol and implements
the authentication, authorization, and accounting (AAA) functions in the IMS.
OCS
The Online Charge System (OCS) implements the credit control, account management,
accounting management, and real-time service authorization functions.
In IMS V200R008C00, the ATS supports only the sessions based on online charging for basic calls,
calling line identity presentation/restriction, and call forwarding services.
For certain third-party call control (3PCC) services, in which a call is initiated by the ATS, the
ATS cannot obtain the OCS IP address configured in the user profile carried in SIP messages.
In this case, the ATS sends an online charging message to another OCS based on the local
configuration in the ATS. The OCS forwards the online charging message to the OCS
specified in the user profile.
5 Interface Definition
Message Format
<Credit-Control-Request> ::= < Diameter Header: 272, REQ, PXY >
<Session-Id>
{Origin-Host}
{Origin-Realm}
{Destination-Realm}
{Auth-Application-Id}
{Service-Context-Id}
{CC-Request-Type}
{CC-Request-Number}
[Destination-Host]
[Event-Timestamp]
[Subscription-Id]
[Service-Identifier ]
[Multiple-Services-Indicator]
[Multiple-Services-Credit Control]
[Service-Information]
[Aoc-Information]
[Termination-Cause]
[Dialed-Party-Address]
Table 5-1 describes the Credit-Control-Request AVP.
Message Format
<Credit-Control-Answer> ::= < Diameter Header: 272, PXY >
<Session-Id>
{Result-Code}
{Origin-Host}
{Origin-Realm}
{Auth-Application-Id}
{CC-Request-Type}
{CC-Request-Number}
*[Multiple-Services-Credit-Control]
[Aoc-Tariff]
[Aoc-Cost-Information]
[AoC-Information]
[Cost-Information]
Table 5-3 describes the Credit-Control-Answer AVP.
Message Format
<RAR> ::= < Diameter Header: 258, REQ, PXY >
< Session-Id >
{ Origin-Host }
{ Origin-Realm }
{ Destination-Realm }
{ Destination-Host }
{ Auth-Application-Id }
{ Re-Auth-Request-Type }
Message Format
<RAA> ::= < Diameter Header: 258, PXY >
< Session-Id >
{ Result-Code }
{ Origin-Host }
{ Origin-Realm }
{ Destination-Realm }
{ Auth-Application-Id }
[ Destination-Host ]
Message Format
<ASR> ::= < Diameter Header: 274, REQ, PXY >
< Session-Id >
{ Origin-Host }
{ Origin-Realm }
{ Destination-Realm }
[ Destination-Host ]
{ Auth-Application-Id }
Message Format
<ASA> ::= < Diameter Header: 274, PXY >
< Session-Id >
{ Result-Code }
{ Origin-Host }
{ Origin-Realm }
{ Destination-Realm }
{ Auth-Application-Id }
[ Destination-Host ]
Vendor ID 10415
5.4.2 Accumulated-Cost
AVP Name Accumulated-Cost
Vendor ID 2011
This AVP specifies the amount charged since the beginning of the session. The ABNF syntax is as
follows:
Accumulated-Cost ::= < AVP Header: 920 >
{Value-Digits}
{Exponent}
5.4.3 Aoc-Confirmation
AVP Name Aoc-Confirmation
Vendor ID 2011
5.4.4 Aoc-Cost-Information
AVP Name Aoc-Cost-Information
Vendor ID 2011
This AVP specifies the information about the AOC service. This AVP is applicable only to the AOC
service in CCA messages. The ABNF syntax is as follows:
Aoc-Cost-Information ::= < AVP Header: 919 >
{Accumulated-Cost}
[Incremental-Cost]
[Currency-Code]
5.4.5 Aoc-Information
AVP Name Aoc-Information
Vendor ID 2011
This AVP specifies the information about the AOC service. This AVP is applicable only to the AOC
service in the CCA message. The ABNF syntax is as follows:
Aoc-Information ::= < AVP Header: 903 >
[Currency-Code]
*{Aoc-Tariff-Information}
5.4.6 Aoc-Price
AVP Name Aoc-Price
Vendor ID 2011
5.4.7 Aoc-Start-Time
AVP Name Aoc-Start-Time
Vendor ID 2011
This AVP specifies the start time of a tariff, in units of seconds and starting from 0. To improve the user
experience, the peer device can convert the Aoc-Start-Time value that is a multiple of 60 to a value
expressed in minutes. For example, at the first minute, the Aoc-Start-Time is 0 seconds. At the fourth
minute, the Aoc-Start-Time is set to 180 seconds. If this AVP is contained, the tariff starts from the first
minute.
5.4.8 Aoc-Tariff
AVP Name Aoc-Tariff
Vendor ID 2011
This AVP contains the following sub-AVP information related to the AOC service in a CCA message.
The ABNF syntax is as follows:
Aoc-Tariff ::= < AVP Header: 913 >
[Currency-Code]
{Scale-Factor}
*{Rating-Element}
5.4.9 Aoc-Tariff-Information
AVP Name Aoc-Tariff-Information
Vendor ID 2011
This AVP specifies the tariff information about the AOC service. This AVP must be contained in every
initial CCA message and updated CCA message. The ABNF syntax is as follows:
Aoc-Tariff-Information ::= < AVP Header: 907 >
{Aoc-Start-Time}
[Aoc-Unit]
{Aoc-Price}
5.4.10 Aoc-Unit
AVP Name Aoc-Unit
Vendor ID 2011
This AVP specifies the time unit of a tariff, in units of seconds. If this AVP is not contained, the AOC
unit is considered to be 60 seconds.
5.4.11 Auth-Application-Id
AVP Name Auth-Application-Id
Vendor ID 0
This AVP must contain the value of 4 as defined in RFC 4006 [402] according to TS 29.230 [206].
5.4.12 Called-Party-Address
AVP Name Called-Party-Address
Vendor ID 10415
This AVP indicates the called number that can be a SIP URI or a TEL URI. It is contained in the
Request-URI field.
1. If the called number is a TEL URI, the ATS9900 normalizes this number.
This AVP in the originating CCR is set based on the value of the Bill unification type parameter
defined by running ADD CNACLD:
(1) If Bill unification type is set to UNIFORM_WITHNO_SEP, the called number is
normalized to a global number prefixed with the plus sign (+), for example, +867552842001
(2) If Bill unification type is set to UNIFORM_WITH_SEP: the called number is normalized
to a global number with the plus sign (+) and minus sign (-), for example, tel:+86-755-2842001
(3) If Bill unification type is set to UNIFORM_WITH_IDD: the called number is normalized
to an international number with the international toll call prefix, for example, 00867552842001
(4) If Bill unification type is set to UNIFORM_WITHNO_IDD: the called number is
normalized to an international number without the international toll call prefix, for example,
867552842001
(5) If Bill unification type is set to NO_UNITFORM: The ATS9900 does not normalize the
called number.
This AVP in a terminating CCR is set to a global number with a plus sign (+).
If the called number is a TEL URI containing “user=phone”, for example,
sip:[email protected];user=phone, the ATS9900 does not normalize this number.
2. If the called number is a SIP URI, the ATS9900 does not normalize this number.
The TEL URI can be in two formats, for example:
tel:+8675528420001 or tel:28420001
sip:[email protected];user=phone
The SIP URI is as follows:
sip:[email protected]
5.4.13 Calling-Party-Address
AVP Name Calling-Party-Address
Vendor ID 10415
This AVP indicates the calling number. It corresponds to the PAI header field contained in an INVITE
request. If the P-Asserted-Identity header field is not contained in an INVITE request, this AVP
corresponds to the From header field. The value can be a SIP URI or a TEL URI. This AVP appears one
time when the P-Asserted-Identity header contains both a SIP URI and a TEL URI.
If the value is a TEL URI, it can be a global number with the plus sign.
The TEL URI can be in two formats, for example:
tel:+8675528420001
sip:[email protected];user=phone
The SIP URI is as follows:
sip:[email protected]
5.4.14 CC-Request-Number
AVP Name CC-Request-Number
Vendor ID 0
This AVP identifies a request within a session. As Session-Id AVPs are globally unique, the combination
of Session-Id and CC-Request-Number AVPs is also globally unique and can be used in matching
credit-control messages with confirmations.
Set the value to 0 for a credit-control request of the INITIAL_REQUEST type and set the value to 1
for the first UPDATE_REQUEST, to 2 for the second, and so on until the value for
TERMINATION_REQUEST is one more than that of the last UPDATE_REQUEST.
5.4.15 CC-Request-Type
AVP Name CC-Request-Type
Vendor ID 0
This AVP specifies the reason for sending the CCR message, and is contained in the CCR message.
The following values are defined in the CC-Request AVP:
INITIAL_REQUEST 1
An Initial request is used to initiate a credit-control session, and contains credit control information
that is relevant to the initiation.
UPDATE_REQUEST 2
An Update request contains credit control information for an existing credit-control session. Update
credit-control requests are sent when a credit-control re-authorization is needed at the expiry of the
allocated quota or validity time.
TERMINATION_REQUEST 3
A Termination request is sent to terminate a credit-control session and contains credit-control
information relevant to the existing session.
5.4.16 CC-Time
AVP Name CC-Time
Vendor ID 0
This AVP defines the requested, allocated, or used time in units of seconds.
5.4.17 CC-Total-Octets
AVP Name CC-Total-Octets
Vendor ID 0
This AVP specifies the total requested, allocated, or used bytes. This value is not related to the direction
(sending or receiving).
5.4.18 Content-Disposition
AVP Name Content-Disposition
Vendor ID 10415
This AVP indicates how the message-body or a message-body part (for example, session, render) is to be
interpreted, as described in RFC 3261 [405].
5.4.19 Content-Length
AVP Name Content-Length
Vendor ID 10415
This AVP specifies the size of the message-body, as described in RFC 3261 [405].
5.4.20 Content-Type
AVP Name Content-Type
Vendor ID 10415
This AVP specifies the media type (for example, application/sdp, text/html) of the message-body, as
described in RFC 3261 [405].
5.4.21 Cost-Information
AVP Name Cost-Information
Vendor ID 0
This AVP specifies the cost information about a service. In the initial CCA message, this field is set to 0.
In the update and termination CCA messages, this field is set to the actual value.
The ABNF syntax is as follows:
Cost-Information ::= < AVP Header: 423 >
{Unit-Value}
{Currency-Code}
[Cost-Unit]
5.4.22 Cost-Value
AVP Name Cost-Value
Vendor ID 2011
This AVP specifies the associated cost (in currency code) to be charged per unit-value. The ABNF
syntax is as follows:
Cost-Value ::= < AVP Header: 917 >
{Value-Digits}
{Exponent]}
5.4.23 Currency-Code
AVP Name Currency-Code
Vendor ID 0
5.4.24 Destination-Host
AVP Name Destination-Host
Vendor ID 0
This AVP specifies the ID of the device receiving the message. The global network allocates it in
centralized mode. Diameter peers must be unique.
It is contained in the request message but cannot be contained in the response message.
Example: ocs001.huawei.com.
5.4.25 Destination-Realm
AVP Name Destination-Realm
Vendor ID 0
This AVP specifies the home field of the device receiving the message. This attribute cannot be
contained in the response message.
Example: huawei.com.
5.4.26 Dialed-Party-Address
AVP Name Dialed-Party-Address
Vendor ID 2011
It is a AVP defined by Huawei Technologies Co., Ltd. This field indicates the dialed number in
original CCR. The value can be a SIP URI or a TEL URI. This AVP is set to the value of the
Request-URI header field. The ATS sends the number that are not normalized.
The TEL URI can be in two formats, for example:
tel:+8675528420001 or tel:28420001
sip:[email protected];user=phone
The SIP URI is as follows:
sip:[email protected]
5.4.27 Diversion-Count
AVP Name Diversion-Count
Vendor ID 2011
This field contains the forwarding count. It is used for call forwarding service. The field is valued as the
sum of diversion count in History-Info header of INVITE message and calling forward times triggered
in the local ATS.
For example, when A calls B, the call is forwarded to C, and then to D.
ATS-A: ACR(A->B) null
ATS-B: ACR(A-C) 0
ATS-B: ACR(B->C) 1
ATS-C: ACR(A-C) 1
ATS-C: ACR(C-D) 2
5.4.28 Diversion-Reason
AVP Name Diversion-Reason
Vendor ID 2011
This field contains the forwarding reason. It is used for call forwarding service. It can be one of the
following:
0: RFR_UNKNOWN
1: CALL_CFU
2: CALL_CFB
3: CALL_CFNR
4: CALL_CFNL
5: CALL_DEFLECTION_ALERTING_RESPONSE
6: CALL_DEFLECTION_IMMEDIATE_RESPONSE
7: CALL_CFNRC
8: CALL_CFU_TO_MAILBOX
9: CALL_CFB_TO_MAILBOX
10: CFNR_TO_MAILBOX
11: CFNL_TO_MAILBOX
12: CFNRC_TO_MAILBOX
13: CALL_CFTB
14: CALL_DND_TO_MAILBOX
15: CALL_CW_CFNR
16: CALL_CFS
17:CALL_DND_TO_MAILBOX
18:CALL_CW_CFNR
19:CALL_CFS
20:CALL_ACR_TO_MAILBOX
255: RFR_BUTT
The ATS sends an ACR for each call forwarding operation. This field indicates only the current
forwarding reason.
5.4.29 Event-Timestamp
AVP Name Event-Timestamp
AVP Code 55
Vendor ID 0
This AVP specifies the time stamp, indicating the number of seconds from January 1, 1900 00:00 UTC
to the sending time of the AVP.
5.4.30 Exponent
AVP Name Exponent
Vendor ID 0
5.4.31 Event-Type
AVP Name Event-Type
Vendor ID 10415
This AVP contains information about the type of chargeable telecommunication service for which the
credit-control request message(s) is generated. The ABNF syntax is as follows:
<Event-Type>:: = <AVP Header: 823 >
[ SIP-Method ]
5.4.32 Final-Unit-Action
AVP Name Final-Unit-Action
Vendor ID 0
This AVP indicates the action when the user account balance is insufficient to pay for the service charge.
Final-Unit-Action defines the following values:
TERMINATE 0
DCC client must end the service session. This is the default processing when the DCC user terminal
receives a Final-Unit-Action that is not supported.
5.4.33 Final-Unit-Indication
AVP Name Final-Unit-Indication
Vendor ID 0
This AVP indicates in the CCA message the number of the final units included in Granted-Service-Unit.
When these units are used up, the DCC client performs the actions designated in Final-Unit-Action.
If multiple service types are received in CCA, the service unit type that is first used up causes the DCC
client to perform the designated actions.
Final-Unit-Action defines the action performed by the service processing node when the user account
balance is insufficient to pay for the service charge. If Final-Unit-Indication exists, Final-Unit-Action
must also exist.
If Final-Unit-Action is set to TERMINATE, other AVPs in the Final-Unit-Indication AVP group must
not be contained. The ATS supports TERMINATE only.
The ABNF syntax is as follows:
Final-Unit-Indication ::= < AVP Header: 430 >
{ Final-Unit-Action }
[ Redirect-Server ]
5.4.34 Granted-Service-Unit
AVP Name Granted-Service-Unit
Vendor ID 0
This AVP includes the number of the units that allow the DCC client to provide services to terminal
users. When these units are used up, the DDC client must apply for new quota from the DCC server or
stop providing services to the terminal users. The DCC client does not need to distinguish all unit types.
In the CCA message when the client receives a unit type that cannot be distinguished or supported, the
CCA is regarded as error, and the DCC client must abort the session by sending a CCR message in
which the Termination-Cause is DIAMETER_BAD_ANSWER.
The ABNF syntax is as follows:
Granted-Service-Unit ::= < AVP Header: 431 >
[ CC-Time ]
[ CC-Total-Octets ]
5.4.35 Group-ID
AVP Name Group-ID
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., Ltd. It is an optional AVP, which indicates the
Centrex group number of a Centrex subscriber.
5.4.36 Message-Body
AVP Name Message-Body
Vendor ID 10415
This AVP specifies information about the message bodies including user-to-user data.
The ABNF syntax is as follows:
<Message-Body>::= < AVP Header: 889 >
[ Content-Type ]
[ Content-Length ]
[ Content-Disposition ]
5.4.37 Multiple-Services-Credit-Control
AVP Name Multiple-Services-Credit-Control
Vendor ID 0
This AVP is related to independent multiple-service credit control. Each instance contains one or more
services.
The details are defined in IETF RFC 4006. The Service-Identifier AVP is not a sub-AVP of the
Multiple-Services-Credit-Control AVP in the current ATS version.
5.4.38 Multiple-Services-Indicator
AVP Name Multiple-Services-Indicator
Vendor ID 0
This AVP indicates whether the DCC client can deal with multiple services independently in a session or
sub-session. If this AVP is not specified, the DCC client does not support multiple services.
If the DCC server does not support independent multiple-service credit control, then this AVP is
regarded as invalid.
For the same session, the client only needs to use this AVP in the first query.
The following values are defined in the Multiple-Services-Indicator AVP:
MULTIPLE_SERVICES_NOT_SUPPORTED 0
The client does not support independent multiple-service credit control in a session or sub-session.
MULTIPLE_SERVICES_SUPPORTED 1
The client supports independent multiple-service credit control in a session or sub-session.
5.4.39 Node-Functionality
AVP Name Node-Functionality
Vendor ID 10415
5.4.40 Origin-Host
AVP Name Origin-Host
Vendor ID 0
This AVP specifies the ID of the device sending the message. The global network allocates it in
centralized mode. Diameter peers must be unique.
Example: SCP001.huawei.com.
5.4.41 Origin-Realm
AVP Name Origin-Realm
Vendor ID 0
This AVP specifies the home field of the device sending the message.
Example: huawei.com.
5.4.42 PBX-Address
AVP Name PBX-Address
Vendor ID 2011
5.4.43 Private-Network-Indication
AVP Name Private-Network-Indication
Vendor ID 2011
5.4.44 Private-Number
AVP Name Private-Number
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., Ltd. It is an optional AVP, which indicates the user's
short number.
Examples:
tel:71001
tel: 60171001
5.4.45 Rating-Element
AVP Name Rating-Element
Vendor ID 2011
This AVP specifies the rate information and contains the following sub-AVPs:
{Unit-Value}
{Cost-Value}
{Unit-Threshold}
The ABNF syntax is as follows:
Rating-Element ::= < AVP Header: 915 >
{Unit-Value}
{Cost-Value}
{Unit-Threshold}
5.4.46 Re-Auth-Request-Type
AVP Name Re-Auth-Request-Type
Vendor ID 0
This AVP is included in application-specific answer to inform the client of the expected action upon
expiration of the Authorization-Lifetime. The details are defined in IETF RFC 3588.
5.4.47 Requested-Party-Address
AVP Name Requested-Party-Address
Vendor ID 10415
This AVP contains the address (SIP URI or TEL URI) of the party (Public User ID or Public Service ID) to whom the
SIP transaction is originally posted.
The Requested-Party-Address AVP contains the SIP URI or TEL URI contained in the Request-URI of the incoming
request. This field is present only when it is different from the Called Party Address parameter.
The TEL URI can be in two formats, for example:
tel:+8675528420001 or tel:28420001
sip:[email protected];user=phone
The SIP URI is as follows:
sip:[email protected]
5.4.48 Requested-Service-Unit
AVP Name Requested-Service-Unit
Vendor ID 0
5.4.49 Reporting-Reason
AVP Name Reporting-Reason
Vendor ID 10415
This AVP specifies the reason for sending the message. More details of this AVP are defined in 3GPP TS
32.299 V8.3.0.
5.4.50 Result-Code
AVP Name Result-Code
Vendor ID 0
This AVP shows whether a specific request is executed successfully or an error occurs. All Diameter
replies defined in the IETF application include Result-Code.
The Result-Code data includes a 32-bit address space managed by INAN to show an error. The error
code types provided by the Diameter are as follows and the error types are distinguished by the
thousands digit:
- 1xxx (Information)
- 2xxx (Succeded)
- 3xxx (Protocol error)
- 4xxx (Temporary failure)
- 5xxx (Permanent failure)
For the value definition of this field, see Appendix A "Result-Code Definition."
5.4.51 Role-of-Node
AVP Name Role-of-Node
Vendor ID 10415
This AVP specifies the role of the ATS. The identifier can be one of the following:
ORIGINATING_ROLE: 0
The AS is applying an originating role, serving the calling subscriber.
TERMINATING_ROLE: 1
The AS is applying a terminating role, serving the called subscriber.
PROXY ROLE: 2
The AS is applying a proxy role.
B2BUA_ROLE 3
The AS is applying a B2BUA role.
5.4.52 Scale-Factor
AVP Name Scale-Factor
Vendor ID 2011
This AVP specifies the scaling factor on the whole calculation. It is a sub-AVP of Aoc-Tariff. The ABNF
syntax is as follows:
Scale-Factor ::= < AVP Header: 914 >
{Value-Digits}
{Exponent}
[Rating-Element]
5.4.53 Service-Context-Id
AVP Name Service-Context-Id
Vendor ID 0
More details of the Service-Context-Id AVP are defined in 3GPP TS 32.299 V8.3.0 7.17.
5.4.54 Session-Id
AVP Name Session-Id
Vendor ID 0
5.4.55 Service-Identifier
AVP Name Service-Identifier
Vendor ID 0
Service identifer.TXT
5.4.56 Service-Identity-List_CTEL
AVP Name Service-Identity-List_CTEL
Vendor ID 81000
5.4.57 Service-Information
AVP Name Service-Information
Vendor ID 10415
This AVP is of service information group. Defining this AVP is to allow the client to deliver specific
additional service information.
The ABNF syntax is as follows:
Service-Information :: = < AVP Header: 873>
[ IMS-Information ]
5.4.58 SDP-Media-component
AVP Name SDP-Media-component
Vendor ID 10415
This AVP contains information about media used for an IMS session.
The ABNF syntax is as follows:
<SDP-Media-Component>:: = <AVP Header: 843 >
[ SDP-Media-Name ]
* [ SDP-Media-Description ]
5.4.59 SDP-Session-Description
AVP Name SDP-Session-Description
Vendor ID 10415
This AVP specifies the content of attribute-line (i=, c=, b=, k=, or a=) related to a session, as described
in RFC 4566 [406].
5.4.60 SIP-Method
AVP Name SIP-Method
Vendor ID 10415
This AVP specifies the name of the SIP Method (INVITE, or UPDATE) causing a credit-control request
to be sent to the OCF.
5.4.61 SIP-Request-Timestamp
AVP Name SIP-Request-Timestamp
Vendor ID 10415
This AVP specifies the time in UTC format of the SIP request (for example, Invite, Update), indicating
the number of seconds from January 1, 1900 00:00 UTC to the sending time of the AVP.
Example: 3504394089.420
5.4.62 SIP-Response-Timestamp
AVP Name SIP-Response-Timestamp
Vendor ID 10415
This AVP specifies the time in UTC format of the response to the SIP request (for example, 200 OK),
indicating the number of seconds from January 1, 1900 00:00 UTC to the sending time of the AVP.
Example: 3504394089.420
5.4.63 SDP-Media-Identifier
AVP Name SDP-Media-Identifier
Vendor ID 2011
This AVP indicates the type of SDP in CCR. It is applicable when the SDP-Session-Description AVP is
carried in CCR.
Values:
0: VoiceCall
The received SDP is voice media.
1: VideoCall
The received SDP is video media.
2: Fax
The received SDP is Fax.
3: CSD
4: PABX
5.4.64 Subgroup-ID
AVP Name Subgroup-ID
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., Ltd. It is an optional AVP, which indicates the user's
subgroup ID.
5.4.65 Subscription-ID
AVP Name Subscription-ID
Vendor ID 0
5.4.66 Subscription-Id-Type
AVP Name Subscription-Id-Type
Vendor ID 0
This AVP identifies the terminal ID type of this user. The detailed description is defined in IETF RFC
4006.
It is used inside the Subscription-Id AVP, and it indicates which kind of subscriber information is
contained in this Subscription-Id AVP.
The following values are currently defined for the Subscription-Id-Type AVP:
0: END_USER_E164
1: END_USER_IMSI
2: END_USER_SIP_URI
3: END_USER_NAI
4: END_USER_PRIVATE
5.4.67 Subscription-Id-Data
AVP Name Subscription-Id-Data
Vendor ID 0
This field contains the user data content, for example, the MSISDN. The details are defined in IETF
RFC 4006.
If the value is TEL URI, it can be a global number with the plus sign.
The TEL URI can be in two formats, for example:
+8675528420001
[email protected];user=phone
The SIP URI is as follows:
[email protected]
5.4.68 Termination-Cause
AVP Name Termination-Cause
Vendor ID 0
5.4.69 Time-Stamps
AVP Name Time-Stamps
Vendor ID 10415
This AVP specifies the time of the initial SIP request and the time of the response to the initial SIP
request.
The ABNF syntax is as follows:
<Time-Stamps>:: = < AVP Header: 833 >
[ SIP-Request-Timestamp ]
[ SIP-Response-Timestamp ]
5.4.70 Unit-Value
AVP Name Unit-Value
Vendor ID 0
This AVP specifies the number of consumed units that incur the charge. The ABNF syntax is as follows:
Unit-Value ::= < AVP Header: 445 >
{Value-Digits}
{Exponent}
5.4.71 Unit-Threshold
AVP Name Unit-Threshold
Vendor ID 2011
This AVP specifies the upper limit for consumed units where the rate is still valid.
5.4.72 Used-Service-Unit
AVP Name Used-Service-Unit
Vendor ID 0
This AVP specifies the number of total used units tested after the service is activated (if middle charging
time is adopted, then the number is counted from the end of the last test).
The ABNF syntax is as follows:
Used-Service-Unit ::= < AVP Header: 446>
[ CC-Time ]
5.4.73 User-Session-Id
AVP Name User-Session-Id
Vendor ID 10415
This AVP holds the session identifier. For a SIP session, the User-Session-ID contains the SIP Call ID,
as defined in RFC 3261 [405].
5.4.74 Value-Digits
AVP Name Value-Digits
Vendor ID 0
5.4.75 VPN-Call-property
AVP Name VPN-Call-property
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., Ltd. It indicates whether the call is an in-group call.
Values:
0: onnet (in-group)
1: offnet (out-group)
5.4.76 Call-Property
AVP Name Call-Property
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., Ltd. It indicates the call attribute.
This AVP in originating CCRs is set to the actual call attribute such as Local-Call and
International-Toll-Call.
This AVP in terminating CCRs is set based on the Called-Party-Address and Calling-Party-Address in
CDRs. For example, if the country codes of both the Calling-Party-Address and Called-Party-Address are
the same, but the national area codes are different, the AVP is set to National-toll (4).
Values:
5.4.77 Called-Asserted-Identity
AVP Name Called-Asserted-Identity
Vendor ID 10415
This AVP indicates the SIP URI or TEL URI of the final called party. It is contained only in originating
CCRs and is set to the called number in the P-Asserted-Identity header field of 18x or 200 responses
returned by the final called party.
The TEL URI can be in two formats, for example:
tel:+8675528420001
sip:[email protected];user=phone
The SIP URI is as follows:
sip:[email protected]
5.4.78 Number-Portability-Routing-Information
AVP Name Number-Portability-Routing-Information
Vendor ID 10415
It is an AVP defined by Huawei Technologies Co., This AVP contains the information about the new
number in the Number Portability service registered by the subscriber. The information is obtained from
the rn parameter in the Request-URI or P-Charging-Vector header field (the Request-URI header field is
preferable) of a SIP message.
5.4.79 Ringing-Duration
AVP Name Ringing-Duration
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., This AVP indicates the ringing duration, that is, the
interval between the 18x message and the 200 response to the INVITE message when the call is
connected.
5.4.80 Abnormal-Finish-Info
AVP Name Abnormal-Finish-Info
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., This AVP is of type Grouped and consists of
Abnormal-Finish-Warning and Abnormal-Finish-Reason.
5.4.81 Abnormal-Finish-Warning
AVP Name Abnormal-Finish-Warning
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., This AVP indicates the session failure information
contained in the Warning header field of SIP messages. It is contained only in CCR(Terminate).
5.4.82 Abnormal-Finish-Reason
AVP Name Abnormal-Finish-Reason
Vendor ID 2011
It is an AVP defined by Huawei Technologies Co., This AVP indicates the session failure information
contained in the Reason header field of SIP messages. It is contained only in CCR(Terminate).
5.4.83 Carrier-Select-Routing-Information
AVP Name Carrier-Select-Routing-Information
Vendor ID 10415
5.4.84 Session-Priority
AVP Name Session-Priority
Vendor ID 10415
The Session-Priority AVP indicates to the HSS the session's priority. The following values are defined:
PRIORITY-0 (0)
PRIORITY-1 (1)
PRIORITY-2 (2)
PRIORITY-3 (3)
PRIORITY-4 (4)
PRIORITY-0 is the highest priority.
INVITE
D1:CCR(initial)
D2:CCA(initial)
INVITE
180
180
200 OK
D3:CCR(update)
D4:CCA(update)
200 OK
ACK
ACK
D5:CCR(update)
D6:CCA(update)
BYE
D7:CCR(termination)
BYE
D8:CCA(termination)
200 OK
200 OK
D5: After the GSU expires, the ATS requests the quota for the subscriber through the
CCR (update) message with the USU.
D6: The OCS returns the CCA (update) message to the ATS with the GSU.
D7: After receiving the BYE message, the ATS requests the termination of the SIP
session using the CCR (termination) message with the USU.
D8: The OCS returns the CCA (termination) message to the ATS.
Scripts
MOD ATS: ATSID=0, AOCTYPE=Extern_ocs;
//Add the OCS device data.
ADD DMDEV: ATSID=0, DEVID=2, DEVTP=OCS, DN="OCS-main",
HN="ocs-0.home1.com", RN="home1.com", SVCID="0";
//Add the OCS link set data.
ADD DMLKS: DEVID=2, LKSID=0, LKSN="OCSmain-lks";
//Add the OCS link data.
ADD DMLNK: DEVID=2, LKSID=0, LNKID=1, LNKN="TO_OCS1", MID=501,
IPTP=IPV4, ADDRID1=0, LPORT=6300, PIP41="200.1.1.34";
ADD DMLNK: DEVID=2, LKSID=0, LNKID=2, LNKN="TO_OCS2", MID=502,
IPTP=IPV4, ADDRID1=0, LPORT=6302, PIP41="200.1.1.34";
ADD DMLNK: DEVID=2, LKSID=0, LNKID=3, LNKN="TO_OCS3", MID=503,
IPTP=IPV4, ADDRID1=0, LPORT=6301, PIP41="200.1.1.34";
ADD DMLNK: DEVID=2, LKSID=0, LNKID=4, LNKN="TO_OCS4", MID=504,
IPTP=IPV4, ADDRID1=0, LPORT=6303, PIP41="200.1.1.34";
A Result-Code Definition