Sunteți pe pagina 1din 221

infoX-AAA

V200R002

Interface Developer Guide - MML

Issue 04

Date 2007-12-29
Part Number

Huawei Technologies Proprietary


Huawei Technologies Co., Ltd. provides customers with comprehensive technical support and service. For
any assistance, please contact our local office or company headquarters.

Huawei Technologies Co., Ltd.


Address: Huawei Industrial Base
Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website: http://www.huawei.com
Email: support@huawei.com

Copyright © Huawei Technologies Co., Ltd. 2007. All rights reserved.


No part of this document may be reproduced or transmitted in any form or by any means without prior
written consent of Huawei Technologies Co., Ltd.

Trademarks and Permissions

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 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.

Huawei Technologies Proprietary


infoX-AAA
Interface Developer Guide - MML Contents

Contents

About This Document.....................................................................................................................1


1 Overview......................................................................................................................................1-1
1.1 Position of the Billing System in the Network ............................................................................................1-2
1.2 Format of the Message That Supports the MML Server Interface ..............................................................1-3

2 Developer Guide to the Billing System.................................................................................2-1


2.1 Overview .....................................................................................................................................................2-2
2.2 Instance........................................................................................................................................................2-3
2.3 Interconnection Debugging .........................................................................................................................2-9
2.3.1 Preparation ........................................................................................................................................2-9
2.3.2 Debug Method...................................................................................................................................2-9
2.3.3 Debug Analysis ...............................................................................................................................2-10
2.4 FAQ ........................................................................................................................................................... 2-11
2.4.1 Connecting the MML Server Fails .................................................................................................. 2-11
2.4.2 Grammar Is Incorrect or Command Codes Are Illegal.................................................................... 2-11

3 MML Interfaces for Operator Management .........................................................................3-1


3.1 Introduction .................................................................................................................................................3-1
3.2 MML Commands ........................................................................................................................................3-1
3.2.1 Command for Logging In to the infoX-AAA....................................................................................3-1
3.2.2 ACK to the Command for Logging In to the infoX-AAA.................................................................3-2
3.2.3 Command for Logging Out of the infoX-AAA.................................................................................3-5
3.2.4 ACK to the Command for Logging Out of the infoX-AAA..............................................................3-5
3.2.5 Command for Changing the Password ..............................................................................................3-6
3.2.6 ACK to the Command for Changing the Password ...........................................................................3-7

4 MML Interfaces for Broadband Service ................................................................................4-1


4.1 Introduction .................................................................................................................................................4-1
4.2 MML Commands ........................................................................................................................................4-1
4.2.1 Command for Adding a Broadband User ..........................................................................................4-1
4.2.2 ACK to the Command for Adding a Broadband User .......................................................................4-6
4.2.3 Command for Modifying the Information About a Broadband User ................................................4-9
4.2.4 ACK to the Command for Modifying the Information About a Broadband User ...........................4-13
4.2.5 Command for Deleting a Broadband User ......................................................................................4-15

Issue 04 (2007-12-29) Huawei Technologies Proprietary i


infoX-AAA
Contents Interface Developer Guide - MML

4.2.6 ACK to the Command for Deleting a Broadband User ...................................................................4-16


4.2.7 Command for Querying the Information About a Broadband User ................................................4-17
4.2.8 ACK to the Command for Querying the Information About a Broadband User .............................4-19
4.2.9 Command for Querying an Account................................................................................................4-22
4.2.10 ACK to the Command for Querying an Account...........................................................................4-23
4.2.11 Command for Activating an Account ............................................................................................4-27
4.2.12 ACK to the Command for Activating an Account .........................................................................4-28
4.2.13 Command for Deactivating an Account ........................................................................................4-29
4.2.14 ACK to the Command for Deactivating an Account .....................................................................4-30
4.2.15 Command for Resetting an Account..............................................................................................4-31
4.2.16 ACK to the Command for Resetting an Account...........................................................................4-33
4.2.17 Command for Changing a Password .............................................................................................4-34
4.2.18 ACK to the Command for Changing a Password ..........................................................................4-35
4.2.19 Command for Restricting a Port....................................................................................................4-36
4.2.20 ACK to the Command for Port Restriction ...................................................................................4-37
4.2.21 Command for Recharging an Account by Cash ............................................................................4-38
4.2.22 ACK to the Command for Recharging an Account by Cash .........................................................4-39
4.2.23 Command for Rolling Back the Cash Recharge............................................................................4-41
4.2.24 ACK to the Command for Rolling Back the Cash Recharge.........................................................4-41
4.2.25 Command for Querying a Recharge Record .................................................................................4-42
4.2.26 ACK to the Command for Querying a Recharge Record ..............................................................4-44
4.2.27 Command for Querying a Bill.......................................................................................................4-47
4.2.28 ACK to the Command for Querying a Bill....................................................................................4-48
4.2.29 Command for Ordering a Broadband Service ...............................................................................4-51
4.2.30 ACK to the Command for Ordering a Broadband Service ............................................................4-52
4.2.31 Command for Canceling a Service Order......................................................................................4-54
4.2.32 ACK to the Command for Canceling an Ordered Service.............................................................4-56
4.2.33 Command for Querying an Ordered Service .................................................................................4-58
4.2.34 ACK to the Command for Querying an Ordered Service..............................................................4-59
4.2.35 Command for Querying the Information About the User Sessions ...............................................4-61
4.2.36 ACK to the Command for Queryinging the Information About a User Session............................4-62

5 Interfaces for CDMA Service...................................................................................................5-1


5.1 Introduction .................................................................................................................................................5-2
5.2 MML Commands ........................................................................................................................................5-2
5.2.1 Command for Adding a CDMA User................................................................................................5-2
5.2.2 ACK to the Command for Adding a CDMA User.............................................................................5-6
5.2.3 Command for Deleting a CDMA User..............................................................................................5-8
5.2.4 ACK to the Command for Deregistering a CDMA User .................................................................5-10
5.2.5 Command for Querying for the Information About a CDMA User................................................. 5-11
5.2.6 ACK to the Command for Querying Information of a CDMA User ...............................................5-12
5.2.7 Command for Modifying the Information About a CDMA Subscriber...........................................5-15

ii Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML Contents

5.2.8 ACK to the Command for Modifying the Information About a CDMA User .................................5-19
5.2.9 Command for Changing the Password of an AN User ....................................................................5-21
5.2.10 ACK to the Command for Changing the Password of an AN User ...............................................5-22
5.2.11 Command for Modifying the User Password in the Self-Service System .....................................5-23
5.2.12 ACK to the Command for Modifying the User Password in the Self-Service System..................5-25
5.2.13 Command for Recharging a CDMA Local Prepaid Account.........................................................5-26
5.2.14 ACK to the Command for Recharging a CDMA Local Prepaid Account .....................................5-27
5.2.15 Command for Querying the Bill of a CDMA Account..................................................................5-28
5.2.16 ACK to the Command for Querying for a Bill of a CDMA Local Prepaid Account .....................5-30
5.2.17 Command for Querying for the Start Time and Accumulative Usage of a Service .......................5-32
5.2.18 ACK to Command for Querying for the Start Time and Accumulative Usage of a Service..........5-33

6 MML Interfaces for WCDMA Service ...................................................................................6-1


6.1 Introduction .................................................................................................................................................6-2
6.2 MML Commands ........................................................................................................................................6-2
6.2.1 Command for Adding a WCDMA User ............................................................................................6-2
6.2.2 ACK to the Command for Adding a WCDMA User .........................................................................6-5
6.2.3 Command for Deleting a WCDMA User ..........................................................................................6-7
6.2.4 ACK to the Command for Deleting a WCDMA User .......................................................................6-8
6.2.5 Command for Querying for the Information About a WCDMA User.............................................6-10
6.2.6 ACK to the Command for Querying for the Information About a WCDMA User..........................6-12
6.2.7 Command for Modifying the Information About a WCDMA User ................................................6-15
6.2.8 ACK to the Command for Modifying the Information About a WCDMA User .............................6-18
6.2.9 Command for Adding WCDMA Users in Batches..........................................................................6-20
6.2.10 ACK to the Command for Adding WCDMA Users in Batches.....................................................6-21
6.2.11 Command for Deleting WCDMA Users in Batches ......................................................................6-22
6.2.12 ACK to the Command for Deleting WCDMA Users in Batches...................................................6-23
6.2.13 Command for Resetting a WCDMA User .....................................................................................6-24
6.2.14 ACK to the Command for Resetting a WCDMA User..................................................................6-25
6.2.15 Command for Changing the Password of a WCDMA User ..........................................................6-26
6.2.16 ACK to the Command for Changing the Password of a WCDMA User .......................................6-27
6.2.17 Command for Unlocking a WCDMA User ...................................................................................6-28
6.2.18 ACK to the Command for Unlocking a WCDMA User ................................................................6-30
6.2.19 Command for Recharging a Prepaid WCDMA Account...............................................................6-31
6.2.20 ACK to the Command for Recharging a Prepaid WCDMA Account............................................6-32
6.2.21 Command for Ordering a Service for a WCDMA User ................................................................6-33
6.2.22 ACK to the Command for Ordering a Service for a WCDMA User .............................................6-34
6.2.23 Command for Canceling the Order of a WCDMA User ...............................................................6-35
6.2.24 ACK to the Command for Canceling the Order of a WCDMA User ............................................6-36
6.2.25 Command for Querying for the Bills of a WCDMA User.............................................................6-38
6.2.26 ACK to the Command for Querying for the Bills of a WCDMA User..........................................6-39
6.2.27 Command for Querying for the Start Time and Accumulative Usage of a Service .......................6-42

Issue 04 (2007-12-29) Huawei Technologies Proprietary iii


infoX-AAA
Contents Interface Developer Guide - MML

6.2.28 ACK to Command for Querying for the Start Time and Accumulative Usage of a Service..........6-44

7 MML Interfaces for WiMAX Service .....................................................................................7-1


7.1 Introduction .................................................................................................................................................7-2
7.2 MML Commands ........................................................................................................................................7-2
7.2.1 Command for Adding a WiMAX User..............................................................................................7-2
7.2.2 ACK to the Command for Adding a WiMAX User...........................................................................7-4
7.2.3 Command for Deleting a WiMAX User............................................................................................7-6
7.2.4 ACK to the Command for Deleting a WiMAX User.........................................................................7-7
7.2.5 Command for Modifying the WiMAX User Information .................................................................7-8
7.2.6 ACK to the Command for Modifying the WiMAX User Information ............................................ 7-11
7.2.7 Command for Querying for the Information About a WiMAX User ..............................................7-13
7.2.8 ACK to the Command for Querying for the Information About a WiMAX User ...........................7-14
7.2.9 Command for Changing the Password of a WiMAX User..............................................................7-17
7.2.10 ACK to the Command for Changing the Password of a WiMAX User.........................................7-18
7.2.11 Command for Recharging a Prepaid WiMAX User ......................................................................7-19
7.2.12 ACK to the Command for Recharging a Prepaid WiMAX User ...................................................7-20
7.2.13 Command for Querying for the Bills of a WiMAX User ..............................................................7-22
7.2.14 ACK to the Command for Querying for the Bills of a WiMAX User ...........................................7-23

A Checksum’s code..................................................................................................................... A-1


B Acronyms and Abbreviations ................................................................................................B-1

Index ................................................................................................................................................ i-1

iv Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML Figures

Figures

Figure 1-1 MML Server and billing system in the network..............................................................................1-2


Figure 1-2 Format of an ordinary message .......................................................................................................1-4
Figure 1-3 Format of a heartbeat message........................................................................................................1-7

Figure 2-1 Operating flow of the billing system...............................................................................................2-2

Issue 04 (2007-12-29) Huawei Technologies Proprietary v


infoX-AAA
Interface Developer Guide - MML Tables

Tables

Table 1-1 Fields in an ordinary message...........................................................................................................1-5


Table 1-2 Fields in a heartbeat message............................................................................................................1-7
Table 3-1 Parameters of the command for logging in to the infoX-AAA.........................................................3-1

Table 3-2 Parameters of the ACK command.....................................................................................................3-3


Table 3-3 Parameters of the command for logout.............................................................................................3-5
Table 3-4 Parameters of the ACK command.....................................................................................................3-6

Table 3-5 Parameters of the command for changing the operator password.....................................................3-7
Table 3-6 Parameters of the ACK command.....................................................................................................3-8
Table 4-1 Parameters of the command for adding a broadband user ................................................................4-2

Table 4-2 Parameters of the ACK command.....................................................................................................4-6


Table 4-3 Parameters of the command for modifying the user information .....................................................4-9
Table 4-4 Parameters of the ACK command...................................................................................................4-14

Table 4-5 Parameters of the command for deleting a broadband user ............................................................4-15
Table 4-6 Parameters of the ACK command...................................................................................................4-17
Table 4-7 Parameters of the command for querying the user information......................................................4-18

Table 4-8 Parameters of the ACK command...................................................................................................4-19


Table 4-9 Parameters of the command for querying an account.....................................................................4-22
Table 4-10 Parameters of the ACK command.................................................................................................4-24

Table 4-11 Parameters of the command for activating an account..................................................................4-27


Table 4-12 Parameters of the ACK command.................................................................................................4-28
Table 4-13 Parameters of the command for deactivating an account..............................................................4-29
Table 4-14 Parameters of the ACK command.................................................................................................4-31
Table 4-15 Parameters of the command for resetting an account ...................................................................4-32
Table 4-16 Parameters of the ACK command.................................................................................................4-33
Table 4-17 Parameters of a command for changing a password .....................................................................4-34
Table 4-18 Parameters of the ACK command.................................................................................................4-35

Issue 04 (2007-12-29) Huawei Technologies Proprietary vii


infoX-AAA
Tables Interface Developer Guide - MML

Table 4-19 Parameters of the command for restricting a port.........................................................................4-36


Table 4-20 Parameters for responding to the port restriction command .........................................................4-38
Table 4-21 Parameters of the command for recharging an account by cash ...................................................4-39
Table 4-22 Parameters of the ACK command.................................................................................................4-40
Table 4-23 Parameters of the command for rolling back the cash recharge....................................................4-41
Table 4-24 Parameters of the ACK command.................................................................................................4-42
Table 4-25 Parameters of the command for querying a recharge record.........................................................4-43
Table 4-26 Parameters of the ACK command.................................................................................................4-45
Table 4-27 Parameters of the command for querying a bill ............................................................................4-47
Table 4-28 Parameters of the ACK command.................................................................................................4-48
Table 4-29 Parameters for ordering a broadband service................................................................................4-51
Table 4-30 Parameters of the ACK command.................................................................................................4-53
Table 4-31 Parameters of the command for canceling a service order............................................................4-55

Table 4-32 Parameters of the ACK command.................................................................................................4-57


Table 4-33 Parameters of the command for querying an ordered service .......................................................4-58
Table 4-34 Parameters of the ACK command.................................................................................................4-59

Table 4-35 Parameters of the command for querying the session information ...............................................4-61
Table 4-36 Parameters of the ACK command.................................................................................................4-63
Table 5-1 Parameters for the command for adding a CDMA user ....................................................................5-2

Table 5-2 Parameters of the ACK command.....................................................................................................5-7


Table 5-3 Parameters for the command for deleting a CDMA user ..................................................................5-9
Table 5-4 Parameters of the ACK command...................................................................................................5-10
Table 5-5 Parameters for the command for querying for the information about a CDMA user...................... 5-11
Table 5-6 Parameters of the ACK command...................................................................................................5-12
Table 5-7 Parameters for the command for modifying the information about a CDMA user.........................5-15
Table 5-8 Parameters of the ACK command...................................................................................................5-20
Table 5-9 Parameters of the command for changing the password of an AN user..........................................5-21
Table 5-10 Parameters of the ACK command.................................................................................................5-23

Table 5-11 Parameters for the command for changing the user password in the self-service system.............5-24
Table 5-12 Parameters of the ACK command.................................................................................................5-25
Table 5-13 Parameters for the command for recharging a CDMA local prepaid account...............................5-26

Table 5-14 Parameters of the ACK command.................................................................................................5-28


Table 5-15 Parameters for the command for querying a bill...........................................................................5-29

viii Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML Tables

Table 5-16 Parameters of the ACK command.................................................................................................5-30


Table 5-17 Parameters of the QUERY C270 USAGE command....................................................................5-32
Table 5-18 Parameters of the ACK command.................................................................................................5-34
Table 6-1 Parameters of the command for adding a WCDMA user..................................................................6-2
Table 6-2 Parameters of the ACK command.....................................................................................................6-6
Table 6-3 Parameters of the command for deleting a WCDMA user................................................................6-7
Table 6-4 Parameters of the ACK command.....................................................................................................6-9
Table 6-5 Parameters of the command for querying for the user information ................................................ 6-11
Table 6-6 Parameters of the ACK command...................................................................................................6-12
Table 6-7 Parameters of the command for modifying the user information ...................................................6-15
Table 6-8 Parameters of the ACK command...................................................................................................6-19
Table 6-9 Parameters of the command for adding WCDMA users in batches................................................6-20
Table 6-10 Parameters of the ACK command.................................................................................................6-22

Table 6-11 Parameters of the command for deleting WCDMA users in batches ............................................6-23
Table 6-12 Parameters of the ACK command.................................................................................................6-24
Table 6-13 Parameters of the command for resetting a WCDMA user...........................................................6-25

Table 6-14 Parameters of the ACK command.................................................................................................6-26


Table 6-15 Parameters of the command for changing the password of a WCDMA user................................6-27
Table 6-16 Parameters of the ACK command.................................................................................................6-28

Table 6-17 Parameters of the command for unlocking a WCDMA user.........................................................6-29


Table 6-18 Parameters of the ACK command.................................................................................................6-30
Table 6-19 Parameters of the command for recharging a prepaid WCDMA account.....................................6-31
Table 6-20 Parameters of the ACK command.................................................................................................6-32
Table 6-21 Parameters of the command for ordering a service for a WCDMA user ......................................6-33
Table 6-22 Parameters of the ACK command.................................................................................................6-35
Table 6-23 Parameters of the command for canceling the order of a WCDMA user......................................6-36
Table 6-24 Parameters of the ACK command.................................................................................................6-37
Table 6-25 Parameters of the command for querying for the bills of a WCDMA user...................................6-38

Table 6-26 Parameters of the ACK command.................................................................................................6-39


Table 6-27 Parameters of the QUERY C260 USAGE command....................................................................6-43
Table 6-28 Parameters of the ACK command.................................................................................................6-45

Table 7-1 Parameters of the command for adding a WiMAX user ...................................................................7-2
Table 7-2 Parameters of the ACK command.....................................................................................................7-5

Issue 04 (2007-12-29) Huawei Technologies Proprietary ix


infoX-AAA
Tables Interface Developer Guide - MML

Table 7-3 Parameters of the command for deleting a WiMAX user .................................................................7-6
Table 7-4 Parameters of the ACK command.....................................................................................................7-7
Table 7-5 Parameters of the command for modifying the information about a WiMAX user. .........................7-8
Table 7-6 Parameters of the ACK command...................................................................................................7-12
Table 7-7 Parameters of the command for querying for the information about a WiMAX user.....................7-13
Table 7-8 Parameters of the ACK command...................................................................................................7-14
Table 7-9 Parameters of the command for changing the password of a WiMAX user ...................................7-17
Table 7-10 Parameters of the ACK command.................................................................................................7-18
Table 7-11 Parameters of the command for recharging a prepaid WiMAX user ............................................7-19
Table 7-12 Parameters of the ACK command.................................................................................................7-21
Table 7-13 Parameters of the command for querying for the bill of a WiMAX user......................................7-22
Table 7-14 Parameters of the ACK command.................................................................................................7-23

x Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML About This Document

About This Document

Purpose
This document describes the commands, functions, parameters, and instances of the MML
interfaces. The MML interfaces consist of the operator management, broadband service,
CDMA service, WCDMA service, and WiMAX service.

Related Versions
The following table lists the product versions related to this document.

Product Name Version

infoX-AAA V200R002

Intended Audience
This document is intended for:
Application Developer

Organization
This document consists of seven parts and is organized as follows.

Chapter Description

1 Overview This chapter describes the development procedure of the


billing system.
2 Interfaces for Operator This chapter describes the interfaces for the operator
Management management.
3 MML Interfaces for This chapter describes the MML interfaces for the
Broadband Service broadband service.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 1


infoX-AAA
About This Document Interface Developer Guide - MML

Chapter Description

4 MML Interfaces for This chapter describes the MML interfaces for the CDMA
CDMA Service service.
5 MML Interfaces for This chapter describes the MML interfaces for the
WCDMA Service WCDMA service.
6 MML Interfaces for This chapter describes the MML interfaces for the WiMAX
WCDMA Service service.
7 Appendix This chapter lists the ChSecksum’s codes, acronyms, and
abbreviations.

Conventions
Symbol Conventions
The following symbols may be found in this document. They are defined as follows.

Symbol Description

Indicates a hazard with a high level of risk which, if not


avoided, will result in death or serious injury.

Indicates a hazard with a medium or low level of risk which,


if not avoided, could result in minor or moderate injury.

Indicates a potentially hazardous situation that, if not


avoided, could cause equipment damage, data loss, and
performance degradation, or unexpected results.

Indicates a tip that may help you solve a problem or save


you time.
Provides additional information to emphasize or supplement
important points of the main text.

General Conventions
Convention Description

Times New Roman Normal paragraphs are in Times New Roman.


Boldface Names of files, directories, folders, and users are in
boldface. For example, log in as user root.
Italic Book titles are in italics.

2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML About This Document

Convention Description
Courier New Terminal display is in Courier New.

Command Conventions
Convention Description

Boldface The keywords of a command line are in boldface.


Italic Command arguments are in italic.
[] Items (keywords or arguments) in square brackets [ ] are
optional.
{ x | y | ... } Alternative items are grouped in braces and separated by
vertical bars. One is selected.
[ x | y | ... ] Optional alternative items are grouped in square brackets
and separated by vertical bars. One or none is selected.
{ x | y | ... } * Alternative items are grouped in braces and separated by
vertical bars. A minimum of one or a maximum of all can be
selected.

GUI Conventions
Convention Description

Boldface Buttons, menus, parameters, tabs, window, and dialog titles


are in boldface. For example, click OK.
> Multi-level menus are in boldface and separated by the “>”
signs. For example, choose File > Create > Folder.

Keyboard Operation
Format Description
Key Press the key. For example, press Enter and press Tab.
Key 1+Key 2 Press the keys concurrently. For example, pressing
Ctrl+Alt+A means the three keys should be pressed
concurrently.
Key 1, Key 2 Press the keys in turn. For example, pressing Alt, A means
the two keys should be pressed in turn.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 3


infoX-AAA
About This Document Interface Developer Guide - MML

Mouse Operation
Action Description

Click Select and release the primary mouse button without


moving the pointer.
Double-click Press the primary mouse button twice continuously and
quickly without moving the pointer.
Drag Press and hold the primary mouse button and move the
pointer to a certain position.

Update History
Updates between document versions are cumulative. Therefore, the latest document version
contains all updates made to previous versions.

Updates in Issue 04 (2007-12-29)


The fourth commercial release.

Updates in Issue 03 (2007-09-30)


The third commercial release.

Updates in Issue 02 (2007-07-31)


The second commercial release.

Updates in Issue 01 (2007-04-15)


The initial commercial release.

4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 1 Overview

1 Overview

About This Chapter

The following table lists the contents of this chapter.

Section Describes

1.1 Position of the Billing The position of the billing system in the network.
System in the Network
1.2 Format of the Message The format of the MML Server message.
That Supports the MML
Server Interface

Issue 04 (2007-12-29) Huawei Technologies Proprietary 1-1


infoX-AAA
1 Overview Interface Developer Guide - MML

1.1 Position of the Billing System in the Network


Figure 1-1 shows the position of the billing system and infoX-AAA in the network.

Figure 1-1 MML Server and billing system in the network

Operator
infoX-AAA

MML/Socket/TCP/IP

Billing MML Server

Internet

Access ISP
IP Core Network
Network
User

Intranet

MML Server
As the server that manages the service, the Man Machine Language Server (MML Server) is
an important part of the infoX-AAA system.
The functions of the MML Server are as follows:
z System management
z Service management
z User management
z Charging management
z Operating log management
In addition, the MML Server provides an open MML interface and a service management
function based on the interface. The third-party system, such as the billing system, can
manage the user data through the MML interface. The management includes adding a user,
deleting a user, and changing the user password.

Billing System
As the client of the MML Server, the billing system provides a platform for carriers to manage
the business. The carrier then can manage the user data by accessing the billing system.

1-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 1 Overview

Relation Between Billing System and MML Server


The relation between the billing system and the MML Server involves the following concepts:
z Connection
The billing system and MML Server creates the connection and exchanges the
information through TCP/IP.
z Session
The session is a virtual connection (logical connection) between the billing system and
the MML Server.
After the connection is created, the billing system can create a session with the MML
Server. The billing system creates the session when the operator logs in. The session
identifies a valid login of the operator to the MML Server. When the operator logs out,
the session is released. If the operator does not operate for more than one hour after login,
the session between the billing system and the MML Server is released.
One connection can have multiple sessions at the same time. That is, several operators
can log in to the MML Server at the same time. In addition, the session ID must be
unique on one connection.

The session ID is a unique ID for an operator of the billing system to log in to the MML Server. The
billing system specifies the session ID. The value is an integer.
z Transaction
After the session is created successfully, the operator of the billing system can send the
MML request to the MML Server through a session. One MML request is a transaction
between the operator and the MML Server.
When an operator sends the MML request to the MML Server, a transaction starts. When
the MML Server returns the MML response to the operator, the transaction ends.
On a session initiated by the billing client, multiple concurrent transactions are not
recommended. The MML Server, however, can process multiple concurrent transactions.
z Operation
An operation is a specific task of the service application, which is run by the operator on
the client of the billing system. For example, the operator queries the balance of a card.
The transaction ID in the MML request sent to the MML Server must map the current
operation. When the MML Server returns the response, the client finds the current
operation according to the transaction ID of the response. Then, the client proceed with
the operation.
An operation contains only one interactive transaction between the billing system and the
MML Server.

1.2 Format of the Message That Supports the MML Server


Interface
The MML interface is an interface through which the billing client interacts with the MML
Server.
The billing system manages the user through the MML Server. The MML interface supports
the formats of the following messages:
z Ordinary message

Issue 04 (2007-12-29) Huawei Technologies Proprietary 1-3


infoX-AAA
1 Overview Interface Developer Guide - MML

z Heartbeat message

Format of an Ordinary Message


The ordinary message is used to exchange the information between the billing system and the
MML Server.
Figure 1-2 shows the format of an ordinary message.

Figure 1-2 Format of an ordinary message

An message = Start flag + Size + Message header + Session header + Transaction header +
Operation information + Checksum
z Message header = Version number + Terminal ID + Service name
z Session header = Session ID + Session control word + Reserved session word
z Transaction header = Transaction ID + Transaction control word + Reserved transaction
word
Table 1-1 lists the fields in an ordinary message.

1-4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 1 Overview

Table 1-1 Fields in an ordinary message

Field Description Value Range

Start flag Indicates the fixed value is A string of four bytes.


\x1C\x1D\x1E\x1F.
Size Indicates the total length of a A four-byte hexadecimal integer.
message from the message header Value range: 0–6500
to the operation information.
Version Has a fixed value 1.00. A string of four bytes.
number
Terminal ID Has a fixed value internal. A string of eight bytes.
Service Indicates the name of a service. It A string of eight bytes.
name is the medium part of an MML
command.
For example, if an MML
command is ADD C280
Account, the service name is
C280.
Session ID The session ID is a unique ID for An eight-byte hexadecimal integer.
an operator of the billing system Value range: An integer that is 1 or
to log in to the MML Server. The greater than 1.
billing system specifies the
session ID.
The session ID retains the same
value from the login to the logout.
If several operator logs in on one
connection, the session IDs must
be different.
Session Includes the DLGLGN, A string of six bytes.
control word DLGBEG, DLGCON, and
DLGEND.
NOTE
The billing system sends DLGLGN
only when an operator logs in to the
MML Server. For other operations,
however, the billing system sends
DlGCON.
When the operator logs out, Session
control word in the response sent by
the MML Server to the billing
system is DLGEND, indicating that
the session ends.

Reserved A string of four-byte zero. A string of four bytes.


session
word

Issue 04 (2007-12-29) Huawei Technologies Proprietary 1-5


infoX-AAA
1 Overview Interface Developer Guide - MML

Field Description Value Range

Transaction Generated by the client. An eight-byte hexadecimal integer.


ID z If there is no concurrent
operation, all transaction IDs
can be 1.
z If concurrent operations are
required, the client must ensure
that all transaction IDs of the
concurrent operations are
different with each other.
Transaction Includes the TXBEG, TXCON, A string of six bytes.
control word and TXEND.
NOTE
If the operation is initiated by the
billing system, Transaction control
word is TXBEG.
If the MML Server complete
operating the MML command, the
value of Transaction control word
that the MML Server returns to
billing system is TXEND, indicating
that the transaction ends.

Reserved A string of four-byte zero. A string of four bytes.


transaction
word
Operation Format: command An MML command.
information code[:command parameter] NOTE
The value of Operation information is the
multiples of four bytes. If the length is less
than four bytes, add spaces after the value.

Checksum A 32-bit bitwise Exclusive-OR A string of four bytes.


negation value of "message
header + session header +
transaction header + operation
information".

Format of a Heartbeat Message


The heartbeat message is used to monitor the communication between the billing system and
the MML Server.
Figure 1-3 shows the format of a heartbeat message.

A heartbeat message must be sent between the bill system and MML Server every 60 seconds. If one
party cannot receive 10 responses of the heartbeat message from the other in succession, it indicates that
the bill system and MML Server are disconnected.

1-6 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 1 Overview

Figure 1-3 Format of a heartbeat message

A heartbeat message = Start flag + Size + HBHB + Checksum


Table 1-2 lists the fields in a heartbeat message.

Table 1-2 Fields in a heartbeat message


Field Description Value Range

Start flag Has a fixed value A string of four bytes.


\x1C\x1D\x1E\x1F.
Size Indicates the total length of a A four-byte hexadecimal integer.
message from the message header Value range: 0–65000
to the operation information.
NOTE
The value is fixed in the heartbeat
message.

Content Has a fixed value HBHB. A string of four bytes.


Checksum A 32-bit bitwise Exclusive-OR A string of four bytes.
negation value of Content
(HBHB).

Issue 04 (2007-12-29) Huawei Technologies Proprietary 1-7


infoX-AAA
Interface Developer Guide - MML 2 Developer Guide to the Billing System

2 Developer Guide to the Billing System

About This Chapter

The following table lists the contents of this chapter.

Section Describes

2.1 Overview The objective and prerequisite for developing the billing
system, and the operating flows of the billing system.
2.2 Instance An instance of developing the billing client.
2.3 Interconnection Debugging The interconnection debugging between the billing
system and the MML Server.
2.4 FAQ How to troubleshoot the problems during the debugging.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 2-1


infoX-AAA
2 Developer Guide to the Billing System Interface Developer Guide - MML

2.1 Overview
Objective
The objective of development is to enables the billing system to communicate with the MML
Server.

Prerequisite
Before developing the billing system, obtain the IP address and port number of the server
where the MML Server resides. The port number of the MML Server is 19999 by default.

The billing system has a super administrator on the MML Server. The login name is billopr. The initial
password is TELLIN.

Operating Flow
Figure 2-1 shows the operating flow of the billing system.

Figure 2-1 Operating flow of the billing system

Billing MML Server

login

login ACK

operation1

operation1 ACK
......
......
operationN

operationN ACK

logout

logoutACK

The detailed operating process is as follows:


1. The billing system sends the login message to the MML Server to request the login.
2. The MML Server receives the login message and authenticates the user of the billing
system. Then, the MML Server returns the login ACK message.
3. If the authentication is successful, the billing system sends the operation message to the
MML Server requesting an operation.

2-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 2 Developer Guide to the Billing System

4. The MML Server operates internally according to the message from the billing system.
After the operation is complete, the MML Server returns the operation ACK message.
5. The billing system sends the logout message to the MML Server requesting the logout.
6. The MML Server receives the logout message and returns the logout ACK message.

z The operation message is a message initiated by the billing system. The number of the operation
messages is specified by the billing system. The billing system can also send the operation requests
consecutively.
z If the operator does not operate for more than one hour after login, the session between the billing
system and the MML Server is released.

2.2 Instance
The following is an instance for developing the billing system:

Step 1 Connect to the MML Server.


The billing system sets up a Socket connection between the client and the service port of the
MML Server.
The following codes in C programming language are as follows (only for your reference):
//Function for creating the Socket connection.

void connectMML(Int& m_sockfd, Int& m_ip, Int& m_port)


{
struct sockaddr_in m_server_addr;
Int m_result;
memset((char*)&m_server_addr,'\0',(int)sizeof(m_server_addr));
m_server_addr.sin_family = AF_INET;
m_server_addr.sin_addr.s_addr = m_ip;
m_server_addr.sin_port = htons( m_port );
m_sockfd = socket( AF_INET, SOCK_STREAM, 0 );
if (0 >= m_sockfd)
{
printf("socket creat failed\n");
exit(0);
}
//Internal function of the Socket for setting up a connection between the client
and the server.
m_result = connect(m_sockfd, (struct sockaddr * ) & m_server_addr
, sizeof( m_server_addr ));
if (0 != m_result)
{
printf("connect server failed\n");
exit(0);
}

Issue 04 (2007-12-29) Huawei Technologies Proprietary 2-3


infoX-AAA
2 Developer Guide to the Billing System Interface Developer Guide - MML

Step 2 Encode the information.


Though the encoding, the billing system on the client encapsulates the information to be sent
into a message that meets the MML interface standard.

The billing system must be able to encode the ordinary message and heartbeat message.

The referential codes are as follows:


//Encode function
EnRet Encode(MsgInfo & sendMsg,char * sendBuff, int & sendLen, int send_type)
{
//The exception handling is omitted.
......
//The method of encoding a heartbeat message is as follows:
if (TYPE_OF_HB_MSG == send_type)
{
int temp_len;
char * p_num, hb_checksum [MAX_HB_CHCKSUM];
temp_len = 0;
strncpy(sendBuff+ temp_len,MSG_STARTTAG, MSG_STARTTAG_LEN);
temp_len += MSG_STARTTAG_LEN;
p_num = Int2ToHex(HB_MSG_LEN);
strncpy(sendBuff + temp_len, p_num, MAX_HB_MSG_LEN);
temp_len += MAX_HB_MSG_LEN;
strncpy (sendBuff + temp_len, HB_CONTENT, MAX_HB_CONTENT_LEN);
temp_len = MSG_STARTTAG_LEN + MAX_HB_MSG_LEN;
GetChkSum(MAX_HB_MSG_LEN,sendBuff + temp_len,hb_checksum);
temp_len = HB_MSG_LEN - MAX_HB_CHCKSUM;
strncpy(sendBuff + temp_len, hb_checksum, MAX_HB_CHCKSUM);
printf("\ncode HB secceed!\n%s",sendBuff);
return Success;
}
//The method of encoding an ordinary message is as follows:
Int msglen,cmdlen,len;
char *p,chksum[MSG_CHKSUM_LEN];
char *pTx[ ] = { "TXBEG" , "TXCON" , "TXCAN" , "TXEND" };
char *pDlg[ ] = { "DLGLGN" , "DLGBEG" , "DLGCON" , "DLGEND" };
//Printing the message sent by the billing system.
PrintMsg(sendMsg);
//Counting the length of a message.
cmdlen=strlen(sendMsg.cmd);
msglen=MAX_HEAD_LEN+cmdlen;
len=(4 - msglen % 4);

2-4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 2 Developer Guide to the Billing System

msglen+=len;
sendLen=msglen+MSG_COMM_LEN;
memset(sendBuff,' ',MAX_MSG_LEN);
len=0;
//Encapsulating Start flag.
strncpy(sendBuff+len, MSG_STARTTAG, MSG_STARTTAG_LEN);
len+=MSG_STARTTAG_LEN;
//Encapsulating Size
p=Int2ToHex(msglen);
strncpy(sendBuff+len, p, MSG_INFOLEN_LEN);
len+=MSG_INFOLEN_LEN;
//Encapsulating Message header.
strncpy(sendBuff+len, MSG_VERSION, MAX_LEN_VERSION);
len+=MAX_LEN_VERSION;
strncpy(sendBuff+len, MSG_TERMINAL, MAX_LEN_TERMINAL);
len+=MAX_LEN_TERMINAL;
strncpy(sendBuff+len,sendMsg.service, strlen(sendMsg.service));
len+=MAX_LEN_SERVNAME;
//Encapsulating Session header.
p=Int4ToHex(sendMsg.snLogin);
strncpy(sendBuff+len, p, MAX_LEN_DLGID);
len+=MAX_LEN_DLGID;
strncpy(sendBuff+len,pDlg[sendMsg.dlgCtrl],strlen(pDlg[sendMsg.dlgCtrl
]));
len+=MAX_LEN_DLGCTRL;
strncpy(sendBuff+len, MSG_DLGRSVD, MAX_LEN_DLGRSVD);
len+=MAX_LEN_DLGRSVD;
//Encapsulating Transaction header.
p=Int4ToHex(sendMsg.sequence);
strncpy(sendBuff+len, p, MAX_LEN_TXID);
len+=MAX_LEN_TXID;
strncpy(sendBuff+len,pTx[sendMsg.txCtrl],strlen(pTx[sendMsg
.txCtrl]));
len+=MAX_LEN_TXCTRL;
strncpy(sendBuff+len, MSG_TXRSVD, MAX_LEN_TXRSVD);
len+=MAX_LEN_TXRSVD;
//Encapsulating Operation information.
strncpy(sendBuff+len, sendMsg.cmd, cmdlen);
//Encapsulating Checksum.
len=MSG_STARTTAG_LEN + MSG_INFOLEN_LEN;
GetChkSum(msglen,sendBuff+len,chksum);
len=sendLen-MSG_CHKSUM_LEN;
strncpy(sendBuff+len, chksum, MSG_CHKSUM_LEN);
return Success;

Issue 04 (2007-12-29) Huawei Technologies Proprietary 2-5


infoX-AAA
2 Developer Guide to the Billing System Interface Developer Guide - MML

For details about the GetChkSum() function, see Appendix B.

Step 3 Decode the information.


Though the decoding, the billing system obtains the relevant information from the message
sent through the MML Server interface.

The billing system must be able to decode the ordinary message and heartbeat message.

The referential codes are as follows:


//Decode function
EnRet Decode(MsgInfo &recMsg,char * recBuff,Int & recLen, int recv_type)
{
//The exception processing is omitted.
......
int msglen,len,tmpInt;
char chksum[MSG_CHKSUM_LEN],tmpStr[MAX_MSG_LEN];
char *pTx[ ] = { "TXBEG" , "TXCON" , "TXCAN" , "TXEND" };
char *pDlg[ ] = { "DLGLGN" , "DLGBEG" , "DLGCON" , "DLGEND" };
len=0;
//Decoding Start flag.
strncpy(tmpStr, recBuff+len, MSG_STARTTAG_LEN);
tmpStr[MSG_STARTTAG_LEN]='\0';
len+=MSG_STARTTAG_LEN;
if(strncmp(tmpStr,MSG_STARTTAG,MSG_STARTTAG_LEN) != 0)
{
printf("Msg head error.");
return NotCMD;
}
//Decoding Size.
strncpy(tmpStr, recBuff+len, MSG_INFOLEN_LEN);
tmpStr[MSG_INFOLEN_LEN]='\0';
len+=MSG_INFOLEN_LEN;
HexToInt2(tmpStr,tmpInt);
msglen=tmpInt;
if ( recv_type == TYPE_OF_CMD_MSG )
{
if(msglen+MSG_COMM_LEN != recLen)
{
printf("Msg length error.");
return Failure;
}
}

2-6 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 2 Developer Guide to the Billing System

//The method of decoding the heartbeat messages is as follows:


if ( recv_type == TYPE_OF_HB_MSG )
{
tmpInt=HB_MSG_LEN;
char HBtempStr[HB_MSG_LEN],HBStr[HB_MSG_LEN];
strncpy(HBtempStr, recBuff, tmpInt);
HBtempStr[tmpInt]='\0';
StrTrim(HBtempStr);
strcpy(HBStr,"HBHB");
for (int i=0; i<4; i++)
{
if( recBuff[MSG_STARTTAG_LEN+MAX_HB_MSG_LEN+i]!=HBStr[i])
{
return Failure;
}
}
return Success;
}
//The method of encoding the ordinary message is as follows:
//Decoding Message header.
strncpy(tmpStr, recBuff+len, MAX_LEN_VERSION);
tmpStr[MAX_LEN_VERSION]='\0';
len+=MAX_LEN_VERSION;
StrTrim(tmpStr);
strncpy(tmpStr, recBuff+len, MAX_LEN_TERMINAL);
tmpStr[MAX_LEN_TERMINAL]='\0';
len+=MAX_LEN_TERMINAL;
StrTrim(tmpStr);
strncpy(tmpStr, recBuff+len, MAX_LEN_SERVNAME);
tmpStr[MAX_LEN_SERVNAME]='\0';
len+=MAX_LEN_SERVNAME;
StrTrim(tmpStr);
strcpy(recMsg.service,tmpStr);
//Decoding Seesion header.
strncpy(tmpStr, recBuff+len, MAX_LEN_DLGID);
tmpStr[MAX_LEN_DLGID]='\0';
len+=MAX_LEN_DLGID;
HexToInt4(tmpStr,tmpInt);
recMsg.snLogin=tmpInt;
strncpy(tmpStr, recBuff+len, MAX_LEN_DLGCTRL);
tmpStr[MAX_LEN_DLGCTRL]='\0';
len+=MAX_LEN_DLGCTRL;
StrTrim(tmpStr);
for(tmpInt=0;tmpInt<4;tmpInt++) if(strcmp(pDlg[tmpInt],tmpStr)==0)

Issue 04 (2007-12-29) Huawei Technologies Proprietary 2-7


infoX-AAA
2 Developer Guide to the Billing System Interface Developer Guide - MML

break;
recMsg.dlgCtrl=tmpInt;
strncpy(tmpStr, recBuff+len, MAX_LEN_DLGRSVD);
tmpStr[MAX_LEN_DLGRSVD]='\0';
len+=MAX_LEN_DLGRSVD;
//Decoding Transaction header.
strncpy(tmpStr, recBuff+len, MAX_LEN_TXID);
tmpStr[MAX_LEN_TXID]='\0';
len+=MAX_LEN_TXID;
HexToInt4(tmpStr,tmpInt);
recMsg.sequence=tmpInt;
strncpy(tmpStr, recBuff+len, MAX_LEN_TXCTRL);
tmpStr[MAX_LEN_TXCTRL]='\0';
len+=MAX_LEN_TXCTRL;
StrTrim(tmpStr);
for(tmpInt=0;tmpInt<4;tmpInt++) if(strcmp(pTx[tmpInt],tmpStr)==0)
break;
recMsg.txCtrl=tmpInt;
strncpy(tmpStr, recBuff+len, MAX_LEN_TXRSVD);
tmpStr[MAX_LEN_TXRSVD]='\0';
len+=MAX_LEN_TXRSVD;
//Decoding Operation information.
tmpInt=msglen-(MAX_HEAD_LEN);
strncpy(tmpStr, recBuff+len, tmpInt);
tmpStr[tmpInt]='\0';
len+=tmpInt;
StrTrim(tmpStr);
strcpy(recMsg.cmd, tmpStr);
//Decoding Checksum.
strncpy(tmpStr, recBuff+len, MSG_CHKSUM_LEN);
tmpStr[MSG_CHKSUM_LEN]='\0';
len=MSG_STARTTAG_LEN + MSG_INFOLEN_LEN;
GetChkSum(msglen,recBuff+len,chksum);
if(strncmp(tmpStr,chksum,MSG_CHKSUM_LEN) != 0)
{
printf("Msg chksum error.");
return Failure;
}
//Printing messages after decoding
PrintMsg(recMsg);
return Success;
}

Step 4 The sender or the receiver returns the response.

2-8 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 2 Developer Guide to the Billing System

The billing system sends a message to the MML Server and receives the returned result from
the MML Server.
The referential codes are as follows:
//Content irrelevant to message sending and receiving is omitted.
......
//Sending a message.
send(m_sockfd,sendBuff,sendLen,0);
outp_strm(sendBuff);
//Receiving a message.
while(1)
{
recLen=recv( m_sockfd, recBuff, sizeof(recBuff),0 );
if(recLen>0)
{
printf("\nreceive login ack message...\n\n");
outp_strm(recBuff);
//Decoding a message and obtaining the operation result.
Decode(recMsg,recBuff,recLen,TYPE_OF_CMD_MSG);
break;
}
}

The heartbeat message must be sent to and fro between the bill system and MML Server every 60
seconds. If one party cannot receive the response of the heartbeat message from the other party for 10
times in succession, it indicates that the bill system and MML Server are disconnected. You need release
the current connection and reconnect them.

----End

2.3 Interconnection Debugging


2.3.1 Preparation
Debug engineers must ensure that the server runs normally and that the client and the server
are connected normally. In addition, the debug engineers must install the software of the client
and server correctly.

2.3.2 Debug Method


During debugging the billing system, capture the packets by running the snoop command and
analyze the result.
Example: The snoop command is snoop -d hme0 –t a -x 54 port 19999. In the command,
hme0 indicates the name of the network interface card (NIC); 19999 indicates the port
number. That is, the packets are captured on the 19999 port.

If the NIC name is unknown, you can run the ifconfig –a command to view the NIC information.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 2-9


infoX-AAA
2 Developer Guide to the Billing System Interface Developer Guide - MML

The snoop command is an internal command of the Solaris system. To use the snoop command, refer to
the related documents of Solaris. When the operating system of the server is Suse, run the tcpdump
command to capture packets. To use the command, refer to the related documents of Suse.

2.3.3 Debug Analysis


By analyzing the captured packets, you can judge whether the debugging process is
successful.
The debugging process has the following cases:
z If the captured packets of an operation do not exist, it indicates that the billing system
did not send the command to the MML Server, or the billing system and the MML
Server are disconnected.
z If the captured packets of an operation exist, check whether the MML commands in the
captured packets are correct. Then you can judge whether the commands are sent
correctly.
The following is an example of analyzing the captured packets as an operator of the billing
system:
Step 1 Log in to the server where the MML Server resides.
Step 2 Run the following command to obtain the information about the captured packets.
snoop -d hme0 -t a -x 42 port 19999

The captured packets are as follows:

2-10 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 2 Developer Guide to the Billing System

The analysis of the captured packets is as follows:


z In the fourth line of the first paragraph, 1c1d 1e1f in bold indicates that the login
message sent by the operator of the billing system is started.
z From the eighth line to the tenth line of the first paragraph, the characters in bold
indicates the MML commands sent by the operator of the billing system.
z In the fourth line of the second paragraph, 1c1d 1e1f in bold indicates that the login
response received by the operator of the billing system is started.
z From the ninth line to the tenth line of the second paragraph, the characters in bold
indicates the login result. You can check whether the login of the operator of the billing
system is logged in to the MML Server successfully.

For detailed meaning of the preceding captured packets, see Table 1-1.

----End

2.4 FAQ
2.4.1 Connecting the MML Server Fails
Symptom
When you debug the interconnection between the billing system and the MML Server, the
billing system fails to connect to the MML Server.

Solution
Check the IP address in the caa.cfg file of the MML Server. If the IP address is configured
incorrectly, check the configuration file and restart the two-node cluster where the MML
Server resides. Then connect the billing system with the MML Server again.

2.4.2 Grammar Is Incorrect or Command Codes Are Illegal


Symptom
When you debug the interconnection between the billing system and the MML Server, the
MML prompts "Grammar is incorrect or command codes are illegal."

Solution
z The command codes are incorrectly entered. The MML command does not exist in the
specified service process.
z The MML command is incorrect in grammar. Check the MML command.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 2-11


infoX-AAA
Interface Developer Guide - MML 3 MML Interfaces for Operator Management

3 MML Interfaces for Operator


Management

About This Chapter

The following table lists the contents of this chapter.

Section Describes

3.1 Introduction The functions of the MML interfaces for the operator
management.
3.2 MML Commands The MML commands relevant to the operator
management.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 3-1


infoX-AAA
Interface Developer Guide - MML 3 MML Interfaces for Operator Management

3.1 Introduction
The MML interfaces of the infoX-AAA supports the operator management. Through the
MML interfaces, you can log in to and out of the infoX-AAA, and modify the operator
password as a billing operator.
In the MML commands of the operator management, the services of the command for
changing the operator password and the matching ACK commands are named OPRM. Other
commands, however, do not contain service names.

The acknowledgement (ACK) command is used for the infoX-AAA to respond to the running of an
MML command. For example, the ACK command of login is the response of the command for logging
in to the infoX-AAA.

3.2 MML Commands


3.2.1 Command for Logging In to the infoX-AAA
Command
LOGIN

Function
This command is used to log in to the infoX-AAA.

Parameter Description
Table 3-1 lists the parameters of the command for logging in to the infoX-AAA.

Table 3-1 Parameters of the command for logging in to the infoX-AAA

Parameter Description Whether Can Be Whether Value Range


Omitted Can Be
Null

USER User name for No No A string of 1 to 16


login. bytes.
The string can include
characters, numerals,
periods, minus signs,
underscores, but the
initial must be a
character.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 3-1


infoX-AAA
3 MML Interfaces for Operator Management Interface Developer Guide - MML

Parameter Description Whether Can Be Whether Value Range


Omitted Can Be
Null

PSWD Password for No No A string of 6 to 16


login. bytes.
The string can include
characters, numerals,
periods, minus signs,
or underscores.

Instance
The following is an instance of running the command for logging in to the infoX-AAA.
z Scenario
− The USER parameter is billopr.
− The PSWD parameter is TELLIN.
z Command
login billopr TELLIN internal

3.2.2 ACK to the Command for Logging In to the infoX-AAA


Command
ACK: LOGIN

Function
This command is used to the respond to the command for logging in to the infoX-AAA.

Parameter Description
Table 3-2 lists the parameters of the ACK command.

3-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 3 MML Interfaces for Operator Management

Table 3-2 Parameters of the ACK command

Parameter Description Value Range

RETN Value returned by the ACK Decimal integers:


command. z 0: Success.
z 2: The session control flag is incorrect.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 9: The command does not match.
z 10: Incorrect number of operations.
z 11: The operation timed out.
z 31: Reached the maximum number of users
specified in the License.
z 1001: The operator does not exist.
z 1002: Incorrect password.
z 1003: Login ID expired.
z 1004: password expired.
z 1005: Incorrect operator state.
z 1006: The operator does not allow to
access this time.
z 1007: Term not found.
z 1008: Term access does not allow this time.
z 1009: Reached the maximum number of
operator logins.
z 1010: Authentication failed.
z 1102: Login Failed. The operator session
count exceeds the max session number.
DESC Description of failure cause. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is
Success.
z When RETN is another return code, this
parameter is the matching message.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 3-3


infoX-AAA
3 MML Interfaces for Operator Management Interface Developer Guide - MML

Parameter Description Value Range

ATTR Names of attributes returned The character string is as follows:


that are separated by the & ROLEID & ROLENAME & CREATOR &
symbol. AGENTID & AGENTNAME & SERVKEY
The attributes are as follows: & USER & LVLID
z ROLEID: role ID
z ROLENAME: role name
z CREATOR: creator of the
operator
z AGENTID: agent ID
z AGENTNAME: agent
name
z SERVKEY: service of the
agent
NOTE
The value 260 of SERVKEY
indicates the WCDMA service.
The value 270 of SERVKEY
indicates the CDMA service.
The value 280 of SERVKEY
indicates the broadband
service. The field is null to the
servadm and root user.
z USER: operator name
z LVLID: level ID
z SCPID: SCP ID of the
matching resource
manager
RESULT Queries the data list. Lines Result returned based on the actual situation.
are separated by the &
symbol and parameters are
separated by the | symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for logging in to the
infoX-AAA.
z Command
ACK:LOGIN: RETN=0, DESC=Success, ATTR=ROLEID & ROLENAME & CREATOR & AGENT
ID & AGENTNAME & SERVKEY & USER & LVLID & SCPID
RESULT="7|BILLopr|billopr|200000|Administrator 280 Agent|280|billopr|999|100",;

If an operator fails to log in, the message returned does not contain the ATTR and RESULT parameters.
The DESC parameter describes the cause of the failure.

3-4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 3 MML Interfaces for Operator Management

3.2.3 Command for Logging Out of the infoX-AAA


Command
LOGOUT

Function
This command is used to log out of the infoX-AAA system.

Parameter Description
Table 3-3 lists the parameters of the command for logout.

Table 3-3 Parameters of the command for logout

Parameter Description Whether Can Whether Value Range


Be Omitted Can Be
Null

USER User name for Yes Yes A string of 1 to 16


login. bytes.
This parameter is The string can
used when a senior include characters,
operator deletes a numerals, periods,
junior operator. If minus signs,
this parameter is underscores, but the
omitted, the current initial must be a
user is used. character.

Instance
The following is an instance of running the command for logging in to the infoX-AAA.
z Scenario
An operator of the billing system logs out.
z Command
LOGOUT:

3.2.4 ACK to the Command for Logging Out of the infoX-AAA


Command
ACK: LOGOUT

Function
This command is used to respond to the logout of an operator.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 3-5


infoX-AAA
3 MML Interfaces for Operator Management Interface Developer Guide - MML

Parameter Description
Table 3-4 lists the parameters of the ACK command.

Table 3-4 Parameters of the ACK command

Parameter Description Value Range

RETN Value returned by the Decimal integers:


ACK command. z 0: Success.
z 2: The session control flag is incorrect.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 9: The command does not match.
z 10: Incorrect number of operations.
z 11: The operation timed out.
z 1001: The current operator is not authorized to quit
this operator.
z 1002: The operator not login.
z 1003: The operator not found.
DESC Description of failure A string of 0 to 256 bytes.
cause. z When RETN is 0, this parameter is Success.
z When RETN is another return code, this parameter
is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for logout.
z Command
ACK:LOGOUT:RETN=0,DESC=”Succeeded”;

3.2.5 Command for Changing the Password


Command
CHG OPRM OWNPSWD

Function
This command is used to change the operator password.

3-6 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 3 MML Interfaces for Operator Management

Parameter Description
Table 3-5 lists the parameters of the command for changing the operator password.

Table 3-5 Parameters of the command for changing the operator password

Parameter Description Whether Can Whether Value Range


Be Omitted Can Be
Null

OLDPSWD Current No Yes A string of 6 to 16 bytes.


password. The string can include
characters, numerals,
periods, minus signs, or
underscores.
NEWPSWD New No Yes A string of 6 to 16 bytes.
password. The string can include
characters, numerals,
periods, minus signs, or
underscores.
CFMPSWD Password for No Yes A string of 6 to 16 bytes.
confirmation. The string can include
characters, numerals,
periods, minus signs, or
underscores.

Instance
The following is an instance of running the command for changing the operator password.
z Scenario
− The OLDPSWD parameter is TELLIN.
− The NEWPSWD parameter is 123456.
− The CFMPSWD parameter is 123456.
z Command
CHG OPRM OWNPSWD:OLDPSWD=TELLIN,NEWPSWD=123456,CFMPSWD=123456;

3.2.6 ACK to the Command for Changing the Password


Command
ACK:CHG OPRM OWNPSWD

Function
This command is used to respond to the command for changing the operator password.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 3-7


infoX-AAA
3 MML Interfaces for Operator Management Interface Developer Guide - MML

Parameter Description
Table 3-6 lists the parameters of the ACK command.

Table 3-6 Parameters of the ACK command

Parameter Description Value Range

RETN Value returned by the Decimal integers:


ACK command. z 0: Modifying password succeeded.
z 3: The transaction control flag is incorrect.
z 4: The message and command are incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 9: The command does not match.
z 10: Incorrect number of operations.
z 11: The operation timed out.
z 13: The authentication failed.
z 14: Connecting database failed.
z 1001: Failed to get the current operator ID.
z 1002: The old password is incorrect.
DESC Description of failure A string of 0 to 256 bytes.
cause. z When RETN is 0, the parameter is Modifying
password succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the command for logging in to the infoX-AAA.
z Scenario
The infoX-AAA responds to the successful running of the command for changing the operator
password.
z Command
ACK:CHG OPRM OWNPSWD:RETN=0,DESC="Modifying password succeeded."

3-8 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

4 MML Interfaces for Broadband Service

About This Chapter

The following table lists the contents of this chapter.

Section Describes

4.1 Introduction The functions of the MML interface in the broadband


service.
4.2 MML Commands The MML commands relevant to the broadband service.

4.1 Introduction
The MML interfaces of the infoX-AAA supports the broadband service. Through the MML
interfaces, you can add and delete a broadband user, and modify and query the user
information in the billing system.
In the MML commands of the broadband service, the services of all the MML commands are
named C280.

The acknowledgement (ACK) command is used for the infoX-AAA to respond to the running of an
MML command. For example, the ACK command of adding a broadband user is the response of the
command for adding a broadband user to the infoX-AAA.

4.2 MML Commands


4.2.1 Command for Adding a Broadband User
Command
ADD C280 USER

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-1


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Function
This command is used to add a broadband user.

Parameter Description
Table 4-1 lists parameters of the command for adding a broadband user.

Table 4-1 Parameters of the command for adding a broadband user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERID ID of a user Yes No A string of 1 to 20 bytes,


consisting of letters,
numerals, periods, minus
signs, or underscores.
BATCH Batch Yes No A string of 1 to 14 bytes.
LOGINNAME Login name Yes No Login name: A string of 1
and domain (If to 20 bytes, consisting of
no domain is letters, numerals, periods,
applicable to minus signs, or
the customer, underscores.
set Domain: A string of 1 to
LOGINNAME 40 bytes, consisting of
to login letters, numerals, periods
name@-1). or minus signs. It cannot
start with or end with a
period or minus sign.
PSWD Password No No A string of 6 to 16 bytes,
consisting of letters,
numerals, periods, minus
signs, or underscores.
USERTYPE Type of a user Yes No z 0: ordinary user
z 1: enterprise user
z 2: family user
USERNAME User name No No A string of 1 to 30 bytes,
consisting of non-reserved
characters.
IDNUMBER ID card number Yes Yes A string of 0 to 30 bytes,
consisting of numerals
and letters.
COMPANY Company name Yes Yes A string of 0 to 100 bytes,
consisting of non-reserved
characters.

4-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERADDRES Address of a Yes Yes A string of 0 to 100 bytes,


S user consisting of non-reserved
characters.
CONTACTMA Name of the Yes No A string of 0 to 20 bytes,
N contact consisting of non-reserved
characters.
PHONE Phone number Yes Yes A string of 0 to 20 bytes,
consisting of numerals or
minus signs. It cannot
start with or end with a
minus sign.
EMAIL E-mail address Yes Yes A string of 0 to 30 bytes,
consisting of non-reserved
characters. It must contain
an @, but cannot start
with or end with an @.
PAYMODE Mode of No No z 0: bank
payment. The z 1: cash
default value is
1.
z 2: call number

BANK Bank name. It Yes Yes A string of 0 to 50 bytes,


is mandatory consisting of non-reserved
when the value characters.
of PAYMODE
is 0.
BANKACCOU Bank account. Yes Yes A string of 0 to 30 bytes,
NT It is mandatory consisting of numerals or
when the value letters.
of PAYMODE
is 0.
PAYPHONE Number for Yes Yes A string of 0 to 20 bytes,
payment. It is consisting of numerals or
mandatory minus signs. It cannot
when the value start with or end with a
of PAYMODE minus sign.
is 2.
DESCRIPTION Remark Yes Yes A string of 0 to 100 bytes,
consisting of non-reserved
characters and the < and >
symbols.
ZIPCODE Postal code Yes Yes A string of 0 to 10 bytes,
consisting of numerals.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-3


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

MOBILE MSISDN Yes Yes A string of 0 to 20 bytes,


consisting of numerals or
minus signs. It cannot
start with or end with a
minus sign.
BP Beep pager Yes Yes A string of 0 to 20 bytes,
number consisting of numerals or
minus signs. It cannot
start with or end with a
minus sign.
AGENTNAME Name of the Yes No A string of 1 to 40 bytes.
agent
ADMPSWD Administrative Yes No A string of 1 to 16 bytes,
password of the consisting of letters,
account numerals, periods, minus
signs, or underscores.
SERVICELEV Service type Yes Yes z 1: Postpaid (type A)
EL z 2: Rechargeable prepaid
(Type B)
z 3: Non-rechargeable
prepaid (type C)
z 4: Postpaid in Hotel
(type D)
z 5: Prepaid in Hotel (type
E)
z 6: Virtual Private
Network (VPN) user
(type F)
z 7: Roaming card
z 8: Calling number (type
H)
z 9: Fixed period (type I)
z a: Recharge card (type
K)
NOTE
z At present, only the
types A, B, C, and K are
available.
CONSUMERI Consumption Yes Yes z 0: access and content
GHT right z 1: only access
z 2: only content

4-4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERTEMPLA Numbering of a Yes No A decimal integer


TE user template.
The default
value is -1.
MAXUSERNU Maximum Yes No A decimal integer
MBER number of
concurrent
users
IPADDRESS IP address Yes No A decimal integer
IPMASK Subnet mask Yes No A decimal integer
IPPOOLID ID of an IP Yes No A decimal integer larger
address pool than 0 or the numeral –1.
PAYTYPE Type of the No No z 1: postpaid
account z 2: prepaid
LIMITFLAG Whether to Yes No z 0: no
restrict the port z 1: yes
number
ACCOUNTNU Account of a Yes No A string of 1 to 20 bytes.
MBER user
AREAID Area ID Yes No A positive integer or –1.
The number –1 indicates
the area ID is not required.
(This parameter is valid
only when the system is in
the area management
mode.)
ACCESSPOLI ID of the access Yes No A positive integer or –1.
CYID policy The number –1 indicates
the ID of the access policy
is not required.
ACCESSPROF ID of the access Yes No A positive integer or –1.
ILEID profile. The number –1 indicates
NOTE the ID of the access
This parameter profile is not required.
is valid only
when the
broadband
service is in
NGN/IMS
mode.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-5


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for adding a broadband user.
z Scenario
− The USERID parameter is sun.
− The LOGINNAME parameter is sun.
− The PSWD parameter is 123456.
− The DOMAIN parameter is domain-usr-psw.
− The MAXUSERNUMBER parameter is 1.
− The user type is prepaid. That is, the PAYTYPE parameter is 2.
− The number of the restricted port is 1. That is, the LIMITFLAG parameter is 1.
− The ACCESSPOLICYID parameter is 2.
− The USERTEMPLATE parameter is 4.
− The payment mode of the user is by cash. That is, the PAYMODE parameter is 1.
− The user is a common user. That is, the USERTYPE parameter is 0.
− The IPADDRESS parameter is 168430090.
− The IPMASK parameter is –256.
z Command
ADD C280 USER: MAXUSERNUMBER=1, PAYTYPE="2", IPMASK=-256, USERNAME="sun",
IPADDRESS=168430090, PAYMODE=1, ACCESSPOLICYID=2, USERADDRESS="", USERTYPE=0,
DESCRIPTION="", USERTEMPLATE=4, MOBILE="", IDNUMBER="",
LOGINNAME="sun@domain-usr-psw", LIMITFLAG=1, COMPANY="", PSWD="123456"

The IP address and subnet mask exist in the command for adding a broadband user must be integers.
The ACCOUNTNUMBER and BATCH parameters cannot coexist.
The values of LOGINNAME and USERID cannot coexist and cannot be null at the same time.

4.2.2 ACK to the Command for Adding a Broadband User


Command
ACK: ADD C280 USER

Function
This command is used to respond to the command for adding a broadband user.

Parameter Description
Table 4-2 lists the parameters of the ACK command.

Table 4-2 Parameters of the ACK command


Parameter Description Value Range

4-6 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Value Range

RETN Returned value A decimal integer.


of the ACK z 0: Adding user succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are not authorized to access the data.
z 14: The database operation failed.
z 1000: Sorry, the access profile does not exist.
z 1002: Sorry, the account does not exist or it has been
used.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-7


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

RETN Returned value z 1002: The template does not exist.


of the ACK z 1002: Sorry, the area ID does not exist.
command.
z 1003: The login name already exists.
z 1008: LDAP failed to roll back.
z 1010: LDAP rollback succeeded.
z 1012: Invalid account.
z 1015: Adding LDAP data failed.
z 1052: Sorry, the authentication must be based on user
name and password if the domain is for VPDN.
z 1054: The subscriber already exists in the external
data.
z 1055: Sorry, the subscriber can be registered with local
domain or VPDN domain only.
z 1112: Sorry, the login name cannot be the same as the
calling access account.
z 1113: The login name is overlapped with the existing
number segment.
z 1115: Sorry, the login name cannot be the same as the
calling access number.
z 1125: The domain does not exist.
z 1125: Sorry, the accesspolicy does not exist.
z 1156: The IP address pool does not exist.
z 1157: Sorry, the static IP address already exists.
z 1160: The account cannot be used because it is out of
the validity period.
z 1226: Sorry, the domain cannot be the skip domain.
z 7001: Entry already exists.
z 7002: Adding LDAP data failed.
z 7003: Deleting LDAP data failed.
z 7004: Modifying LDAP data failed.
z 7005: Connecting to the LDAP failed.
z 7006: Binding to the LDAP failed.
z 7007: Number of key fields is not consistent with that
of field values.

DESC Error cause. A string of 0 to 256 bytes.


z When RETN is set to 0, this parameter is Adding user
succeeded.
z When RETN is another return code, this parameter is
the matching message.

4-8 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for adding a
broadband user.
z Command
ACK: ADD C280 USER:RETN=0,DESC="Adding user succeeded";

Be sure to enter a login name or an account.

4.2.3 Command for Modifying the Information About a


Broadband User
Command
MOD C280 USER

Function
This command is used to modify the information about a broadband user.

Parameter Description
Table 4-3 lists the parameters of the command for modifying the information about a
broadband user.

Table 4-3 Parameters of the command for modifying the user information

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name and Yes No z Login name: A string


domain (If no of 1 to 20 bytes,
domain is consisting of letters,
applicable to the numerals, periods,
customer, set minus signs, or
LOGINNAME to underscores.
login name@-1). z Domain: A string of 1
NOTE to 40 bytes, consisting
Type the of letters, numerals,
LOGINNAME or periods or minus signs.
ACCOUNTNUM It cannot start with or
BER. end with a period or
minus sign.
USERTYPE Type of a user. The Yes No z 0: ordinary user
current version z 1: enterprise user
only supports
ordinary users.
z 2: family user

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-9


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERNAME Name of a user. No No A string of 1 to 30 bytes,


consisting of
non-reserved characters.
IDNUMBER ID card number. Yes Yes A string of 1 to 30 bytes,
consisting of letters,
numerals, periods, minus
signs, or underscores.
COMPANY Company name. Yes Yes A string of 0 to 100
bytes, consisting of
non-reserved characters.
USERADDRE Address of the Yes Yes A string of 0 to 100
SS contact. bytes, consisting of
non-reserved characters.
CONTACTM Name of the Yes No A string of 0 to 20 bytes,
AN contact. consisting of
non-reserved characters.
PHONE Phone number. Yes Yes A string of 0 to 20 bytes,
consisting of numerals or
minus signs. It cannot
start with or end with a
minus sign.
EMAIL E-mail address of a Yes Yes A string of 0 to 30 bytes,
user. consisting of
non-reserved characters.
It must contain an @, but
cannot start with or end
with an @.
PAYMODE Payment mode. Yes No z 0: bank
The default value is z 1: cash
1.
z 2: phone
BANK Bank name. It is Yes Yes A string of 0 to 50 bytes,
mandatory when consisting of
the value of non-reserved characters.
PAYMODE is 0.
BANKACCO Bank account. It is Yes Yes A string of 0 to 30 bytes,
UNT mandatory when consisting of numerals or
the value of letters.
PAYMODE is 0.
PAYPHONE Number for Yes Yes A string of 0 to 20 bytes,
payment. It is consisting of numerals or
mandatory when minus signs. It cannot
the value of start with or end with a
PAYMODE is 2. minus sign.

4-10 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DESCRIPTIO Remark. Yes Yes A string of 0 to 100


N bytes, consisting of
non-reserved characters
and the characters "<"
and ">".
ZIPCODE Postal code. Yes Yes A string of 0 to 10 bytes,
consisting of numerals.
MOBILE Mobile phone Yes Yes A string of 0 to 20 bytes,
number. consisting of numerals or
minus signs. It cannot
start with or end with a
minus sign.
BP Beep pager Yes Yes A string of 0 to 20 bytes,
number. consisting of numerals or
minus signs. It cannot
start with or end with a
minus sign.
USERTEMPL Number of a user Yes Yes A decimal integer or the
ATE template. numeral –1.
The default value is –1.
MAXUSERN Maximum number Yes No A decimal integer.
UMBER of concurrent users.
IPADDRESS IP address. Yes No A decimal integer.
IPMASK Mask of the IP Yes No A decimal integer.
address.
IPPOOLID ID of the IP Yes No A decimal integer larger
address pool. than 1 or the number –1
DOMAIN Domain name. Yes No A string of 1 to 20 bytes.
ACCOUNTN Account number of Yes No A string of 1 to 40 bytes,
UMBER the user. consisting of letters,
numerals, periods, minus
signs, and underscores.
AREAID Area ID Yes No An integer or the numeral
–1.
The numeral –1 indicates
the area ID is not
required. (This parameter
is valid only when the
system is in the area
management mode.)

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-11


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCESSPOLI ID of the access Yes No An integer or the numeral


CYID policy –1.
The numeral –1 indicates
the ID of the access
policy is not required.
ACCESSPRO ID of the access Yes No A positive integer or –1.
FILEID profile. The number –1 indicates
NOTE the ID of the access
This parameter is profile is not required.
valid only when the
broadband service is
in NGN/IMS mode.

Instance
The following is an instance of running the command for changing the information about a
broadband user.
z Scenario
Modify the mobile phone number of a broadband user.
− The COMPANY parameter is A.
− The MOBILE parameter is 13851771240.
− The USERADDRESS parameter is china.
− The PHONE parameter is 0755-21569856.
− The ZIPCODE parameter is 110056.
− The IDNUMBER parameter is 321322198402212000.
− The USERNAME parameter is sun.
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The MAXUSERNUMBER parameter is 1.
− The user type is prepaid. That is, the PAYTYPE parameter is 2.
− The ACCESSPOLICYID parameter is 2.
− The USERTEMPLATE parameter is 4.
− The IPADDRESS parameter is 168430090.
− The IPMASK parameter is –256.
z Command
MOD C280 USER: COMPANY="company A", MOBILE="13851771240", USERADDRESS="china",
PHONE="0755-21569856", ZIPCODE="110056", IPMASK=-256, USERTEMPLATE=4, IPPOOLID=-1,
IPADDRESS=168430090, ACCESSPOLICYID=2, LOGINNAME="sun@domain-usr-psw", USERNAME="sun",
MAXUSERNUMBER=1, IDNUMBER="321322198402212000

4-12 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

The IP address and subnet mask exist in the command for modifying the information about a broadband
user must be integers.
The ACCOUNTNUMBER and LOGINNAME cannot coexist and cannot be null at the same time.

4.2.4 ACK to the Command for Modifying the Information About


a Broadband User
Command
ACK: MOD C280 USER

Function
This command is used to respond to the command for modifying the information on a
broadband user.

Parameter Description
Table 4-4 lists the parameters of the ACK command.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-13


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Table 4-4 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Modifying user information succeeded.
command.
z 3:The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: The system is not allowed to access the data.
z 14: The database operation failed.
z 1000: Sorry, the access profile does not exist.
z 1002: The template does not exist.
z 1002: Sorry, the area ID does not exist.
z 1003: The login user name already exists.
z 1011: Modifying LDAP data failed.
z 1051: Sorry, you cannot modify the domain because
the subscriber has purchased for the service.
z 1052: Sorry, the authentication must be based on
user name and password if the domain is for VPDN.
z 1053: Sorry, you cannot modify the domain because
the subscriber belongs to a parent account.
z 1053: Sorry, you cannot modify the domain because
the subscriber belongs to a parent account.
z 1054: The subscriber already exists in the external
data.
z 1101: The user group cannot be modified.
z 1102: The user is not activated. You cannot modify
the user.
z 1125: The domain does not exist.
z 1125: Sorry, the accesspolicy does not exist.
z 1156: The IP address pool does not exist.
z 1157: Sorry, the static IP address already exists.
z 1160: Sorry, the maximum number of prepaid users
must be 1.
z 1226: Sorry, the domain cannot be the skip domain.
z 1002: Sorry, the area ID does not exist.
z 1125: Sorry, the accesspolicy does not exist.
DESC Description of the A string of 0 to 256 bytes.
error cause. z When RETN is 0, this parameter is Modifying user
information succeeded.
z When RETN is another return code, this parameter
is the matching message.

4-14 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for modifying the
information about a broadband user.
z Command
ACK:MOD C280 USER:RETN=0,DESC="Modifying user information succeeded";

4.2.5 Command for Deleting a Broadband User


Command
DEL C280 USER

Function
This command is used to delete a broadband user.

Parameter Description
Table 4-5 lists the parameters of the command for deleting a broadband user.

Table 4-5 Parameters of the command for deleting a broadband user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCOUNTNUM Account Yes No A string of 1 to 20 bytes,


BER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name Yes No Login name: A string of
and domain (If 1 to 20 bytes, consisting
no domain is of letters, numerals,
applicable to periods, minus signs, or
the customer, underscores.
set Domain: A string of 1 to
LOGINNAM 40 bytes, consisting of
E to login letters, numerals, periods
name@-1). or minus signs. This
parameter cannot start
with or end with a period
or minus sign.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-15


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

REMOVEALL Whether to No No z 0: yes


reserve user z 1: no
information
during
deletion.
SCPID ID of the Yes No 100–999
session
resource
manager.

Instance
The following is an instance of running the command for deleting a broadband user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− Delete the user information that need not be reserved. That is, the REMOVEALL
parameter is 1.
− The SCPID parameter is 100.
z Command
DEL C280 USER: REMOVEALL=0, LOGINNAME=sun@domain-usr-psw, SCPID=100

The values of LOGINNAME or ACCOUNTNUMBER cannot coexist and cannot be null at the same
time.

4.2.6 ACK to the Command for Deleting a Broadband User


Command
ACK: DEL C280 USER

Function
This command is used to respond to the command for deleting a broadband user.

Parameter Description
Table 4-6 lists the parameters of the ACK command.

4-16 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Table 4-6 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK command. z 0: Deleting the user information succeeded.
z 3:The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: The system is not allowed to access the data.
z 14: The database operation failed.
z 1001: The account does not exist.
z 1003: The SCP is not connected.
z 1004: Sorry, forcing the user to log off failed.
z 1120: Deleting LDAP data failed.
DESC Describes cause of A string of 0 to 256 bytes.
the error. z When RETN is set to 0, this parameter is
Deleting the user information succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for deleting a
broadband user.
z Command
ACK:DEL C280 USER:RETN=0,DESC="Deleting the user information succeeded.";

4.2.7 Command for Querying the Information About a Broadband


User
Command
QUERY C280 USER

Function
This command is used to query the information about a broadband user.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-17


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description
Table 4-7 lists the parameters of the command for querying the information about a
broadband user.

Table 4-7 Parameters of the command for querying the user information

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERID User ID. Yes Yes A string of 1 to 20 bytes,


consisting of letters,
numerals, periods, minus
signs, or underscores.
USERNAME User name. Yes Yes A string of 1 to 20 bytes,
consisting of
non-reserved characters.
PHONE Phone Yes Yes A string of 0 to 20 bytes,
number. consisting of numerals or
minus signs. It cannot
start with or end with a
minus sign.
IDNUMBER ID card Yes Yes A string of 0 to 18 bytes,
number. consisting of numerals
and letters.
LOGINNAME Login name Yes Yes Login name: A string of
and domain (If 1 to 20 bytes, consisting
no domain is of letters, numerals,
applicable to periods, minus signs, or
the customer, underscores.
set Domain: A string of 1 to
LOGINNAM 40 bytes, consisting of
E to login letters, numerals, periods
name@-1). or minus signs. This
parameter cannot start
with or end with a period
or minus sign.
ACCOUNTNU Account. Yes No A string of 1 to 20 bytes,
MBER consisting of letters,
numerals, periods, minus
signs, or underscores.

Instance
The following is an instance of running the command for querying the information about a
broadband user.
z Scenario

4-18 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Query the information about a broadband user.


− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
z Command
QUERY C280 USER:LOGINNAME=sun@domain-usr-psw;

z When querying the information about a broadband user, you must enter the value of a parameter.
z The values of LOGINNAME and ACCOUNTNUMBER cannot coexist.
z The values of ACCOUNTNUMBER and USERID cannot coexist.

4.2.8 ACK to the Command for Querying the Information About a


Broadband User
Command
ACK: QUERY C280 USER

Function
This command is used to respond to the command for querying information on a broadband
user.

Parameter Description
Table 4-8 lists the parameters of the ACK command.

Table 4-8 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the ACK A decimal integer.


command. z 0: Querying user succeeded.
z 3: The transaction control flag is
incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 14: The database operation failed.
z 1001: The account does not exist.
DESC Describes causes of the error. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is
Querying user succeeded.
z When the value of RETN is another
return code, the value of this
parameter is the matching message.
TOTAL Number of queried records. A decimal integer.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-19


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

FINISHED Indicates whether the operation z 0: no


ends. z 1: yes
START Start line of the current batch. A decimal integer.
ROWNUM Number of records in the current A decimal integer.
batch.

4-20 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Value Range

ATTR List of queried attributes. Fields Must be the following strings:


are separated by ampersands LOGINNAME &
(&). ACCOUNTNUMBER & USERID &
Including the following USERNAME & IDNUMBER &
parameters: CONTACTMAN & PAYMODE &
z ACCOUNTNUMBER: COMPANY & USERADDRESS &
account BANK & BANKACCOUNT &
PHONE & PAYPHONE & ZIPCODE
z Login name and domain in the & MOBILE & EMAIL & BP &
form of login name@domain. DESCRIPTION & SERVICELEVEL
z BROADNUMBER: & MAXUSERNUMBER &
broadband number. It can be IPADDRESS & IPMASK & STATUS
ignored. & TEMPLATEID &
z USERID: user ID. It can be TEMPLATENAME & IPPOOLID &
ignored. IPPOOLTYPE & IPPOOLNAME &
LIMITFLAG & LIMITPORT &
z SERVICELEVEL: service ACCESSPOLICYID & AREAID &
type. PROVIDERID & ACCPROFID &
0: Agent card ACCPROFNAME &
1: Postpaid Card (Type A) REGISTERTIME &
2: Rechargeable Prepaid Card UNREGISTERTIME
(Type B)
3: Non-Rechargeable Prepaid
Card (Type C)
z CONSUMERIGHT:
consumption right
0: access and content
1: only access
2: only content
3: commissioned sales point
4: only VOIP
z BATCH: batch
z SEQUENCE: sequence
number of a batch
z PROVIDERID: Agent ID. It
can be ignored.
z STATUS: status of a card.
0: not activated
1: activated
2: To be deleted
3: Free
z SUBSTATE: indicating
whether a card is available.
0: No
1: Yes
z USESTATE: indicating
whether a card is being used
0: no
1: yes
z RELATIVEDAYS: Relative
validity period. The validity
period starts from the first use.
z COUNTTOTAL: Amount of a
Issue 04 (2007-12-29) Huawei Technologies Proprietary
card. 4-21
z ACCOUNTLEFT: Balance of
a card
infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

RESULT List of queried data. Lines are Result set returned when an operation
separated by the & symbol and command is run.
parameters are separated by the |
symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for modifying the
information about a broadband user.
z Command
QUERY C280 USER:RETN=0,DESC="Querying user
succeeded",TOTAL=1,FINISHED=1,START=0,ROWNUM=1,
ATTR=LOGINNAME & ACCOUNTNUMBER & USERID & USERNAME & IDNUMBER & CONTACTMAN & PAYMODE
& COMPANY & USERADDRESS & BANK & BANKACCOUNT & PHONE & PAYPHONE & ZIPCODE & MOBILE &
EMAIL & BP & DESCRIPTION & SERVICELEVEL & MAXUSERNUMBER & IPADDRESS & IPMASK & STATUS
& TEMPLATEID & TEMPLATENAME & IPPOOLID & IPPOOLTYPE & IPPOOLNAME & LIMITFLAG & LIMITPORT
& ACCESSPOLICYID & AREAID & PROVIDERID & ACCPROFID & ACCPROFNAME & REGISTERTIME &
UNREGISTERTIME ,RESULT="sun@domain-
usr-psw|test00000001|20070621103842351235|sun|||1||||||||||||2|1|168430090|-256|1|4
|commontemplet|-1|||1||2|-1|200000|-1||20070621103842||;

4.2.9 Command for Querying an Account


Command
QUERY C280 ACCOUNT

Function
This command is used to query an account.

Parameter Description
Table 4-9 lists the parameters of the command for querying an account.

Table 4-9 Parameters of the command for querying an account


Parameter Description Whether Whether Value Range
Can Be Can Be
Omitted Null

ACCOUNTNUM Account. Yes No A string of 1 to 20 bytes,


BER consisting of letters,
numerals, periods, minus
signs, or underscores.

4-22 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name Yes No Login name: a string of 1


and domain to 20 bytes, consisting of
(If no letters, numerals, periods,
domain is minus signs, or
applicable to underscores.
the customer, Domain: a string of 1 to
set 40 bytes, consisting of
LOGINNAM letters, numerals, periods
E to login or minus signs. It cannot
name@-1). start with or end with a
periods or minus sign.

Instance
The following is an instance of running the command for querying the account information
about a broadband user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
z Command
QUERY C280 ACCOUNT:LOGINNAME=sun@domain-usr-psw;

The values of ACCOUNTNUMBER and LOGINNAME cannot coexist and cannot be null at the same
time.

4.2.10 ACK to the Command for Querying an Account


Command
ACK: QUERY C280 ACCOUNT

Function
This command is used for the infoX-AAA to respond to the command for querying an account

Parameter Description
Table 4-10 lists the parameters of the ACK command.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-23


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Table 4-10 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the ACK command. A decimal integer.


z 0: Querying account
succeeded.
z 3: The transaction control
flag is incorrect.
z 7: system internal error.
z 8: The parameter is
incorrect.
z 11: The operation timed out.
z 14: Database operation
failed.
z 1001: The account does not
exist.
z 1500: Sorry, the user does
not belong to the current
operator. (The prompt is
valid when the system is in
the area management mode.)
DESC Error cause. String of 0 to 256 bytes.
z When RETN is set to 0, the
value of the parameter is
Querying account
succeeded.
z When the value of RETN is
another return code, the
value of this parameter is the
matching message.
TOTAL Number of queried records. A decimal integer.
FINISHED Indicates whether the operation ends. z 0: no
z 1: yes
START Start line of the current batch. A decimal integer.
ROWNUM Number of records in the current batch. A decimal integer.

4-24 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Value Range

ATTR List or queried attributes. Fields are Must be the following strings:
separated by ampersands (&). ACCOUNTNUMBER &
Including the following parameters: LOGINNAME & SERID
z ACCOUNTNUMBER: account & SERVICELEVEL &
z LOGINNAME : Login name and CONSUMERIGHT &
domain in the form of login BATCH & SEQUENCE &
name@domain. PROVIDERID & STATUS &
SUBSTATE & USESTATE &
z USERID: User ID. It can be ignored. RELAT
z SERVICELEVEL: Service type IVEDAYS & COUNTTOTAL
0: Agent card & ACCOUNTLEFT &
1: Postpaid Card (Type A) LIMITTYPE &
2: Rechargeable Prepaid Card (Type LIMITACCDAY &
B) LIMITACCLEFTDAY &
3: Non-Rechargable Prepaid Card AREAID & FIRSTUSEDATE
(Type C) & SERVICESTART &
z CONSUMERIGHT: reserved field SERVICESTOP &
0: access and content LASTUSEBEGINTIME &
1: only access LASTUSEENDTIME &
2: only content LIMITACCMONTH &
3: commissioned sales point LIMITACCLEFTMONTH &
4: only VOIP LIMITFLAG & LIMITPORT
z BATCH: batch. & CREDITFLAG &
CREDITUNION &
z SEQUENCE: sequence number of a CREDITACCLEFT &
batch. REALNAME & PHONE &
z PROVIDERID: Agent ID. It can be ACCESSPOLICYID &
ignored. REGISTERTIME &
z STATUS: status of a card. UNREGISTERTIME
0: not activated.
1: activated
2: to be deleted
3: Idle
z SUBSTATE: whether the card is
available.
0: no
1: yes
z USESTATE: whether a card is being
used.
0: No
1: Yes
z RELATIVEDAYS: relative validity
period. The validity period starts
from the first use.
z COUNTTOTAL: total amount in a
card
z ACCOUNTLEFT: balance of a card
z LIMITTYPE: reserved field

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-25


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range


z LIMITACCDAY: reserved field.
z LIMITACCLEFTDAY: reserved
field.
z AREAID: zone code.
z FIRSTUSEDATE: date of the first
use.
z SERVICESTART: start date.
z SERVICESTOP: end date.
z LASTUSEBEGINTIME: start time
for the latest use.
z LASTUSEENDTIME: end time for
the latest use.
z LIMITACCMONTH: reserved field.
z LIMITACCLEFTMONTH: reserved
field.
z LIMITPORT: reserved field.
z CREDITFLAG: reserved field.
z CREDITUNION: reserved field.
z CREDITACCLEFT: reserved field.
z REALNAME: real name of the user.
z PHONE: phone number of the user.
z ACCESSPOLICYID: ID of the
access policy.
z REGISTERTIME: time when the
user is registered.
z UNREGISTERTIME: time when the
user is deregistered.
RESULT List of queried data. Lines are Result set returned when an
separated by the & symbol and operation command is run.
parameters are separated by the |
symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying the
account information about a broadband user.
z Command
QUERY C280 ACCOUNT:RETN=0,DESC="Querying account succeeded",ATTR= ACCOUNTNUMBER &
LOGINNAME & USERID & SERVICELEVEL & CONSUMERIGHT & BATCH & SEQUENCE & PROVIDERID & STATUS
& SUBSTATE & USESTATE & RELATIVEDAYS & COUNTTOTAL & ACCOUNTLEFT & LIMITTYPE & LIMITACCDAY

4-26 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

& LIMITACCLEFTDAY & AREAID & FIRSTUSEDATE& SERVICESTART & SERVICESTOP & LASTUSEBEGINTIME
& LASTUSEENDTIME & LIMITACCMONTH & LIMITACCLEFTMONTH & LIMITFLAG & LIMITPORT & CREDITFLAG
& CREDITUNION & CREDITACCLEFT & REALNAME & PHONE & ACCESSPOLICYID & REGISTERTIME &
UNREGISTERTIME,RESULT="test00000001|sun@domain-usr-psw|20070621103842351235|2|1|200
7062100|1|200000|1|1|0|365|5000|5000|0|0||-1|00000000|20070621|20080620|||0||1||0|0
||sun||2|20070621103842||",;

4.2.11 Command for Activating an Account


Command
ACT C280 ACCOUNT

Function
This command is used to activate an account.

Parameter Description
Table 4-11 lists the parameters of the command for activating an account.

Table 4-11 Parameters of the command for activating an account

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCOUNTNU Account. Yes No A string of 1 to 20 bytes,


MBER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name and Yes No Login name: a string of 1
domain (If no to 20 bytes, consisting of
domain is letters, numerals, periods,
applicable to the minus signs, or
customer, set underscores.
LOGINNAME Domain: a string of 1 to
to login 40 bytes, consisting of
name@-1). letters, numerals, periods
or minus signs. It cannot
start with or end with a
period or minus sign.

Instance
The following is an instance of running the command for activating an account.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-27


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

z Command
ACT C280 ACCOUNT:LOGINNAME=sun@ domain-usr-psw

The values of ACCOUNTNUMBER and LOGINNAME cannot coexist and cannot be null at the same
time.

4.2.12 ACK to the Command for Activating an Account


Command
ACK: ACT C280 ACCOUNT

Function
This command is used to respond to the command for activating an account.

Parameter Description
Table 4-12 lists the parameters of the ACK command.

Table 4-12 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Enabling the account succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: The system is not allowed to access the data.
z 14: Database operation failed.
z 1001: The account does not exist.
z 1002: Sorry, the account is not in the disable state.
z 1003: The account is not activated.
z 1003: The account has already been activated.
z 1005: The account cannot be resumed because it has
not been used.
z 1007: LDAP failed to enable the account.
z 1008: LDAP failed to roll back.
z 1009: Failed to update the account status in the
database.
DESC Describes causes String of 0 to 256 bytes.
of the error. z When RETN is 0, this parameter is Enabling the
account succeeded.
z When RETN is another return code, this parameter
is the matching message.

4-28 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for activating an
account.
z Command
ACK:ACT C280 ACCOUNT:RETN=0,DESC="Enabling the account succeeded.";

4.2.13 Command for Deactivating an Account


Command
DEACT C280 ACCOUNT

Function
This command is used for operators to deactivate an account.

Parameter Description
Table 4-13 lists the parameters of the command for deactivating an account.

Table 4-13 Parameters of the command for deactivating an account

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCOUNTNUM Account. Yes No A string of 1 to 20 bytes,


BER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name Yes No Login name: a string of 1
and domain to 20 bytes, consisting of
(If no letters, numerals, periods,
domain is minus signs, or
applicable to underscores.
the customer, Domain: a string of 1 to
set 40 bytes, consisting of
LOGINNA letters, numerals, periods
ME to login or minus signs. It cannot
name@-1). start with or end with a
period or minus sign.
SCPID ID of the Yes No 100–999
session
resource
manager.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-29


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for deactivating an account.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The SCPID parameter is 100.
z Command
DEACT C280 ACCOUNT:LOGINNAME=sun@domain-usr-psw

The values of LOGINNAME and USERID cannot be coexist and cannot be null at the same time.

4.2.14 ACK to the Command for Deactivating an Account


Command
ACK: DEACT C280 ACCOUNT

Function
This command is used to respond to the command for deactivating an account.

Parameter Description
Table 4-14 lists the parameters of the ACK command.

4-30 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Table 4-14 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK command. z 0: Disabling the account succeeded.
z 3: The transaction control flag is incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: The system is not allowed to access the data.
z 14: The database operation failed.
z 1001: The account does not exist.
z 1002: Sorry, the account is not in the enable state.
z 1003: The account is not activated.
z 1004: LDAP failed to suspend the account.
z 1004: Sorry, forcing the user to log off failed.
z 1006: The account cannot be suspended, because
it has not been used.
z 1008: LDAP failed to roll back.
z 1009: Failed to update the power-up status of the
database account.
DESC Error cause. String of 0 to 256 bytes.
z When RETN is 0, this parameter is Disabling the
account succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for deactivating an
account.
z Command
ACK:DEACT C280 ACCOUNT:RETN=0,DESC="Disabling the account succeeded.";

4.2.15 Command for Resetting an Account


Command
RESET C280 ACCOUNT

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-31


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Function
This command is used for operators to reset an account.

Parameter Description
Table 4-15 lists the parameters of the command for resetting an account.

Table 4-15 Parameters of the command for resetting an account

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCOUNTNU Account. Yes No A string of 1 to 20 bytes,


MBER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name Yes No Login name: a string of 1 to
and domain 20 bytes, consisting of
(If no domain letters, numerals, periods,
is applicable minus signs, or
to the underscores.
customer, set Domain: a string of 1 to 40
LOGINNAM bytes, consisting of letters,
E to login numerals, periods or minus
name@-1). signs. It cannot start with or
end with a periods or minus
sign.
SESSIONINFO Session Yes No Type of a string.
information.
SCPID ID of the Yes No 100–999
session
resource
manager.

Instance
The following is an instance of running the command for resetting an account.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
z Command
RESET C280 ACCOUNT:LOGINNAME=sun@ domain-usr-psw

The values of ACCOUNTNUMBER and LOGINNAME cannot coexist and cannot be null at the same
time.

4-32 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

4.2.16 ACK to the Command for Resetting an Account


Command
ACK: RESET C280 ACCOUNT

Function
This command is used to respond to the command for resetting an account.

Parameter Description
Table 4-16 lists the parameters of the ACK command.

Table 4-16 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the A decimal integer.


ACK command. z 0: Resetting the account succeeded.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are not authorized to access the
data.
z 14: The database operation failed.
z 1001: The account does not exist.
z 1002: Sorry, the account is offline now.
z 1003: Sorry, the user is connecting now.
Please try again later.
z 1003: The SCP is not connected.
z 1004: Forcing the user to log off failed.
DESC Describes cause of the A string of 0 to 256 bytes.
error. z When RETN is 0, this parameter is
Resetting account succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for resetting an
account.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-33


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

z Command
ACK:RESET C280 ACCOUNT:RETN=0,DESC="Resetting the account succeeded.";

4.2.17 Command for Changing a Password


Command
MOD C280 PASSWD

Function
This command is used to change a password.

Parameter Description
Table 4-17 lists the parameters of a command for changing a password.

Table 4-17 Parameters of a command for changing a password


Parameter Description Whether Whether Value Range
Can Be Can Be
Omitted Null

ACCOUNTNUMB Account. Yes No A string of 1 to 20 bytes,


ER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name Yes No Login name: a string of 1
and domain to 20 bytes, consisting of
(If no domain letters, numerals, periods,
is applicable minus signs, or
to the underscores.
customer, set Domain: a string of 1 to
LOGINNA 40 bytes, consisting of
ME to login letters, numerals, periods
name@-1). or minus signs. It cannot
start with or end with a
period or minus sign.
PASSWORD Password. No No A string of 6 to 16 bytes.
CHKPASSWORD Password for No No A string of 6 to 16 bytes.
confirmation.

Instance
The following is an instance of running the command for changing the password.
z Scenario
− The login name is sun.
− The home domain of the user is domain-usr-psw.

4-34 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

− The new password is 123456.


− The password for confirming the new password is 123456.
z Command
MOD C280 PASSWD: CHKPASSWORD="123456", LOGINNAME="sun@domain-usr-psw",
PASSWORD="123456"

The value of LOGINNAME or ACCOUNTNUMBER cannot coexist and cannot be null at the same
time.
The values of PASSWORD and CHKPASSWORD must be the same.

4.2.18 ACK to the Command for Changing a Password


Command
ACK: MOD C280 PASSWD

Function
This command is used for the infoX-AAA to respond to the command for changing a
password.

Parameter Description
Table 4-18 lists the parameters of the ACK command.

Table 4-18 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the A decimal integer.


ACK command. z 0: Modifying the password succeeded.
z 3: The transaction control flag is incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: The system is not allowed to access the
data.
z 14: Database oepration failed.
z 1002: Sorry, the account is not in the enable
state.
z 1003: The account is not activated.
z 1001: LDAP failed to modify the password.
z 1008: LDAP failed to roll back.
z 1009: Failed to update the power-up status
of the database account.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-35


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

DESC Error cause A string of 0 to 256 bytes.


z When RETN is 0, this parameter is
Modifying the password succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for changing a
password.
z Command
ACK: MOD C280 PASSWD:RETN=0,DESC="Modifying the password succeeded.";

4.2.19 Command for Restricting a Port


Command
SET C280 LMTPORT

Function
This command is used to restrict a port used.

Parameter Description
Table 4-19 lists the parameters of the command for restricting a port.

Table 4-19 Parameters of the command for restricting a port

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name No No Login name: a string of 1 to


and domain 20 bytes, consisting of letters,
(If no domain numerals, periods, minus
is applicable signs, or underscores.
to the Domain: a string of 1 to 40
customer, set bytes, consisting of letters,
LOGINNA numerals, periods or minus
ME to login signs. It cannot start with or
name@-1). end with a period or minus
sign.

4-36 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

LIMITPORT Port number Yes Yes A string of 1 to 64 bytes,


restriction. If consisting of letters,
it is null, the numerals, periods, minus
port signs, and underscores.
restriction
can be
canceled.
LIMITFLAG Indicates Yes No z 0: no
whether to z 1: yes
restrict the
port

Instance
The following is an instance of running the command for restricting a port.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The number of the restricted port is 1. That is, the LIMITFLAG parameter is 1.
− The LIMITPORT parameter is 1000–4568.
z Command
SET C280 LMTPORT: LIMITFLAG=1, LOGINNAME=sun@domain-usr-psw, LIMITPORT=1000-4568

4.2.20 ACK to the Command for Port Restriction


Command
ACK: SET C280 LMTPORT

Function
This command is used to respond to the command for restricting a port.

Parameter Description
Table 4-20 lists the parameters of the ACK command.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-37


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Table 4-20 Parameters for responding to the port restriction command

Parameter Description Value Range

RETN Returned value of the A decimal integer.


ACK command. z 0: Setting limitport succeeded.
z 3: The transaction control flag is incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 14: The database operation failed.
z 1001: The account does not exist.
z 1002: Sorry, the account is not in the enable
state.
z 1003: The account is not activated.
z 1011: Modifying the LDAP data failed.
z 1008: LDAP failed to roll back.
z 1010: The LDAP succeeded in rolling back
DESC Description of the error A string of 0 to 256 bytes.
cause. z When RETN is 0, this parameter is Setting
limitport succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for restricting a
port.
z Command
ACK:SET C280 LMTPORT:RETN=0,DESC="Setting restricted port succeeded.";

4.2.21 Command for Recharging an Account by Cash


Command
CHARGE C280 ACCOUNT

Function
This command is used for recharge an account by cash.

4-38 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description
Table 4-21 lists the parameters for recharging an account by cash.

Table 4-21 Parameters of the command for recharging an account by cash

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCOUNT Account. Yes No A string of 1 to 20 bytes,


NUMBER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name Yes No Login name: a string of 1 to
and domain 20 bytes, consisting of letters,
(If no numerals, periods, minus
domain is signs, or underscores.
applicable to Domain: a string of 1 to 40
the customer, bytes, consisting of letters,
set numerals, periods or minus
LOGINNA signs. It cannot start with or
ME to login end with a period or minus
name@-1). sign.
CHGVAL Amount to No No A decimal integer, in minutes.
recharge.

Instance
The following is an instance of running the command for recharging an account by cash.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The CHGVAL parameter is 2000.
z Command
CHARGE C280 ACCOUNT:CHGVAL=2000,LOGINNAME="sun@domain-usr-psw";

The values of ACCOUNTNUMBER and LOGINNAME cannot coexist and cannot be null at the same
time.

4.2.22 ACK to the Command for Recharging an Account by Cash


Command
ACK: CHARGE C280 ACCOUNT

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-39


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Function
This command is used to respond to the command for recharge an account by cash.

Parameter Description
Table 4-22 lists the parameters of the ACK command.

Table 4-22 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the A decimal integer.


ACK command. z 0: Cash recharging succeeded.
z 3: The transaction control flag is incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 14: The database oepration failed.
z 1001: The account does not exist.
z 1005: Sorry, the user has not been defined.
z 1004: It is not a rechargeable prepaid
account.
z 1035: Cannot recharge because the total
amount of money exceed the limitation.
z 1036: Cannot recharge because the
deferment factor equals zero.
z 1041: You cannot recharge because the
account is out of the validity period.
z 1003: Invalid account.
z 1042: The upper-limit fee for class B card is
not defined.
DESC Description of the error A string of 0 to 256 bytes.
cause. z When RETN is 0, this parameter is Cash
recharging succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for recharging an
account by cash.
z Command

4-40 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

ACK:CHARGE C280 ACCOUNT:RETN=0,DESC="Cash recharge succeeded.";

4.2.23 Command for Rolling Back the Cash Recharge


Command
BACK C280 CHARGE

Function
This command is used to roll back cash recharge.

Parameter Description
Table 4-23 lists the parameters of the command for rolling back the cash recharge.

Table 4-23 Parameters of the command for rolling back the cash recharge

Parameter Description Whether Can Whether Can Value Range


Be Omitted Be Null

SN Sequence No No A decimal integer.


number of an
operation

Instance
The following is an instance of running the command for rolling back the cash recharge.
z Scenario
The sequence number of an operation is 2.
z Command
BACK C280 CHARGE: SN=2

4.2.24 ACK to the Command for Rolling Back the Cash Recharge
Command
ACK: BACK C280 CHARGE

Function
This command is used to respond to the command for rolling back the cash recharge.

Parameter Description
Table 4-24 lists the parameters of the ACK command.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-41


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Table 4-24 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the A decimal integer.


ACK command. z 0: Rolling back the cash recharge succeeded.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 14: Database operaton failed.
z 1045: Rolling back recharge of other agents
is not allowed.
z 1046: Rolling back recharge again is not
allowed.
z 1047: The cash recharging record does not
exist.
z 1048: Sorry, user is online.
z 1049: Sorry, not enough balance.
z 1050: The user does not exist in the basic
table.
DESC Description of the error A string of 0 to 256 bytes.
cause. z When RETN is 0, this parameter is Rolling
back the cash recharge succeeded.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for rolling back the
cash recharge.
z Command
ACK: BACK C280 CHARGE:RETN=0,DESC="Rolling back the cash recharge succeeded.";

4.2.25 Command for Querying a Recharge Record


Command
QUERY C280 CHARGE

Function
This command is used for operators to query a recharge record.

4-42 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description
Table 4-25 lists the parameters of the command for querying a recharge record,

Table 4-25 Parameters of the command for querying a recharge record

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCOUNT Account Yes No A string of 1 to 20 bytes,


NUMBER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name Yes No Login name: a string of 1
and domain to 20 bytes, consisting of
(If no domain letters, numerals,
is applicable periods, minus signs, or
to the underscores.
customer, set Domain: a string of 1 to
LOGINNA 40 bytes, consisting of
ME to login letters, numerals, periods
name@-1). or minus signs. It cannot
start with or end with a
period or minus sign.
CHARGETYPE Type of Yes No z 0:advertisement
recharge. recharge
z 1:cash recharge
z 2:card recharge
z 3: balance transfer
BEGINTIME Start time, in Yes No A string of 1 to 14 bytes.
the form of
YYYYMMDD
HHMMSS.
ENDTIME End time, in Yes No A string of 1 to 14 bytes.
the form of
YYYYMMDD
HHMMSS.
TOP Maximum Yes No A decimal integer.
number of
queried
records.
STATE Current status No No z 1: Normal
of cash z 2: Rollback
recharge.
OPERATOR Operator. Yes No A string of 1 to 16 bytes.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-43


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for querying a recharge record.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The BEGINTIME parameter is 20070521000000.
− The ENDTIME parameter is 20070621235959.
− The recharge type is normal. That is, the CHARGETYPE parameter is 1.
z Command
QUERY C280
CHARGE:ENDTIME=20070621235959,CHARGETYPE=1,LOGINNAME=sun@domain-usr-psw,STATE=2,BEG
INTIME=20070521000000,

The value of LOGINNAME or ACCOUNTNUMBER cannot coexist and cannot be null at the same
time.
The BEGINTIME and ENDTIME must coexist and cannot be null at the same time.
The values of both BEGINTIME and ENDTIME must be entered.

4.2.26 ACK to the Command for Querying a Recharge Record


Command
ACK: QUERY C280 CHARGE

Function
This command is used to respond to the command for querying cash recharge records.

Parameter Description
Table 4-26 lists the parameters of the ACK command.

4-44 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Table 4-26 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the ACK A decimal integer.


command. z 0: Querying recharging record
succeeded.
z 3: The transaction control flag is
incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are not authorized to access
the data.
z 14: The database operation failed.
z 1043: No recharge is rolled back.
z 1044: No recharge record is available.
DESC Error cause. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is
Querying recharging record
succeeded.
z When RETN is another return code,
this parameter is the matching
message.
TOTAL Number of queried records. A decimal integer.
FINISHED Whether the operation ends. z 0: no
z 1: yes
START Start line of the current batch. A decimal integer.
ROWNUM Number of records in the current A decimal integer.
batch

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-45


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

ATTR List or attributes names that are z Ordinary recharge records that are
separated by the & symbol. queried must be the following strings:
The attributes are as follows: SN & LOGINNAME &
CHARGENUMBER &
z SN: sequence number of an CHARGETYPE & CHARGETIME
operation. & CHARGEACCOUNT &
z Login name and domain in the BEFOREACCOUNT &
form of login name@domain. AFTERACCOUNT & PROVIDERID
z CHARGENUMBER: & OPERATOR & STATE
rechargable card number. z Recharge rollback records that are
z CHARGETYPE: type of queried must be the following strings:
recharge. SN & LOGINNAME &
CHARGENUMBER &
z CHARGETIME: recharge CHARGETYPE & CHARGETIME
time. & CHARGEACCOUNT &
z CHARGEACCOUNT: BEFOREACCOUNT &
recharge amount. AFTERACCOUNT & PROVIDERID
z BEFOREACCOUNT: balance & OPERATOR & STATE &
before recharge. OPTIME & WITHDRAWER &
ChargeSN
z AFTERACCOUNT: balance
after recharge.
z PROVIDERID: ID of the cash
recharge agent.
z OPERATOR: cash recharge
operator.
z STATE: status of cash
recharge records .
z 1: Normal (default)
z 2: Rollback
z OPTIME: rollback duration in
the form of
YYYYMMDDHHMMSS.
z WITHDRAWER: account of
an operator who performs
rollback.
z CHARGESN: sequence
number of a recharge log.
RESULT List of queried data. Lines are Result set returned when an operation
separated by the & symbol and command is run.
parameters are separated by the |
symbol.

Instance
The following is an instance of running the ACK command.
z Scenario

4-46 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

The infoX-AAA responds to the successful running of the command for querying a
recharge record of a broadband user.
z Command
QUERY C280 CHARGE:RETN=0,DESC="Querying recharging record
succeeded.",TOTAL=1,FINISHED=1,START=0, ROWNUM=1,ATTR=SN & LOGINNAME & CHARGENUMBER &
CHARGETYPE & CHARGETIME & CHARGEACCOUNT & BEFOREACCOUNT & AFTERACCOUNT & PROVIDERID &
OPERATOR &
STATE,RESULT="1|sun@domain-usr-psw||1|2007-06-2113:59:02|2000|5000|7000|200000|unsa
dm|2|20070621140142|unsadm|1",;

4.2.27 Command for Querying a Bill


Command
QUERY C280 BILL

Function
This command is used to query a bill.

Parameter Description
Table 4-27 lists the parameters of the command for querying a bill.

Table 4-27 Parameters of the command for querying a bill

Parameter Description Whether Can Whether Value Range


Be Omitted Can Be Null

ACCOUNT Account. Yes No A string of 1 to 20 bytes,


NUMBER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNA Login name Yes No Login name: A string of
ME and domain 1 to 20 bytes, consisting
(If no domain of letters, numerals,
is applicable periods, minus signs, or
to the underscores.
customer, set Domain: A string of 1 to
LOGINNA 40 bytes, consisting of
ME to login letters, numerals, periods
name@-1). or minus signs. This
parameter cannot start
with or end with periods
or commas.
BILLTIME Time when a No No A string of 1 to 14 bytes.
bill is
generated

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-47


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for querying a bill.
z Scenario
− The DOMAIN parameter is domain-usr-psw.
− The BILLTIME parameter is 20060501000000.
z Command
QUERY C280 BILL:LOGINNAME="sun@domain-usr-psw",BILLTIME="20060501000000";

The values of LOGINNAME and ACCOUNTNUMBER cannot coexist and cannot be null at the same
time.

4.2.28 ACK to the Command for Querying a Bill


Command
ACK: QUERY C280 BILL

Function
This command is used for the infoX-AAA to respond to the command for querying a bill.

Parameter Description
Table 4-28 lists the parameters of the ACK command.

Table 4-28 Parameters of the ACK command


Parameter Description Value Range

RETN Returned value of the ACK A decimal integer.


command. z 0: Querying succeeded.
z 3:The transaction control flag is
incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are not authorized to access
the data.
z 14: The database operation failed.
z 1000: Sorry, the bill does not exist.
z 1001: The account does not exist.
z 1032: No bill is recorded in the
specified period.
z 1034: System internal error.

4-48 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Value Range

DESC Error cause. A string of 0 to 256 bytes.


z When the value of RETN is 0, the
value of this parameter is Querying
succeeded.
z When the value of RETN is another
return code, the value of this
parameter is the matching message.
TOTAL Number of queried records. A decimal integer.
FINISHED Whether the operation ends. z 0: no
z 1: yes
START Start line of the current batch. A decimal integer.
ROWNUM Number of records in the current A decimal integer.
batch.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-49


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

ATTR List or queried attributes. Fields are Must be the following strings:
separated by ampersands (&). ACCOUNTNUMBER &
Including the following attributes: LOGINNAME
z ACCOUNTNUMBER: Card & SERVICEKEY &
number. SERVICELEVEL & PROVIDERID
z Login name and domain in the & LOGICPORTNO
form of login name@domain. & SERVICESTARTTIME &
z SERVICEKEY: service key. BEGINTIME
z SERVICELEVEL: service type. & ENDTIME & CHARGEMODE &
CHARGECLASS & FEE &
z PROVIDERID: ID of the agent SENDBYTES
z LOGICPORTNO: logical port & RECEIVEBYTES &
reported by the ISN SENDPACKES
z SERVICESTARTTIME: start & RECEIVEPACKES &
time of the service. TIMELENGTH
z BEGINTIME: start time of the & CONTENTTITLE & BILLTYPE
charging. & ACCOUNTREASON & SN &
z BEGINTIME: end time of the SERVICEITEMID &
charging. SERVICEITEMNAME
z CHARGEMODE: charging & USERIP & ISNIP &
mode. LOGICALPORTNO
z 0: flow-based
z 1: duration-based
z 2: based on flow and duration
z 3: Piece-based
z CHARGECLASS: charging type.
z FEE: fee to be paid.
z SENDBYTES: Upstream
bandwidth in Kilobytes.
z RECEIVEBYTES: Downstream
bandwidth in Kilobytes.
z SENDPACKES: number of
upstream packets.
z RECEIVEPACKES: number of
downstream packets
z TIMELENGTH: online duration.
z CONTENTTITLE: name of a
content.
z BILLTYPE: type of a bill.
z ACCOUNTREASON: Charging
reason, that is, cause for
generating bills.
z SN: Sequence number.
z SERVICEITEMID: ID of a
service.
z SERVICEITEMNAME: Name of
a service.
4-50 z USERIP:
HuaweiIPTechnologies
address of the user
Proprietary Issue 04 (2007-12-29)
assigned by the device.
z ISNIP: IP of the ISN, in the form
of a string.
infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description Value Range

RESULT List of queried data. Lines are Result set returned when an operation
separated by the & symbol and command is carried out.
parameters are separated by the |
symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying a bill.
z Command
ACK:QUERY C280 BILL:RETN=0,DESC="Querying the bill
succeeded.",TOTAL=1,FINISHED=1,START=0
,ROWNUM=1,ATTR=ACCOUNTNUMBER & LOGINNAME & SERVICEKEY & SERVICELEVEL & PROVIDERID &
LOGICPORTNO & SERVICESTARTTIME & BEGINTIME & ENDTIME & CHARGEMODE & CHARGECLASS & FEE
& SENDBYTES & RECEIVEBYTES & SENDPACKES & RECEIVEPACKES
& TIMELENGTH & CONTENTTITLE & BILLTYPE & ACCOUNTREASON & SN & SERVICEITEMID &
SERVICEITEMNAME & USERIP & ISNIP &
LOGICALPORTNO,RESULT="test00000001|sun@domain-usr-psw|280|2|200000||20060608012740|
20060608012740|20060608012744||-1|0|0.000000|0.000000|0.000000|0.000000|4|11|1|2|10
002000000000000001|-1||0.0.0.1|10.164.26.127||",;

4.2.29 Command for Ordering a Broadband Service


Command
ADD C280 ORDER

Function
The command is used to order a broadband service.

Parameter Description
Table 4-29 lists the parameters of the command for ordering a broadband service.

Table 4-29 Parameters for ordering a broadband service


Parameter Description Whether Whether Value Range
Can Be Can Be
Omitted Null

ACCOUNTNU Account. Yes No A string of 1 to 20 bytes,


MBER consisting of letters,
numerals, periods, minus
signs, or underscores.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-51


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name and Yes No Login name: a string of 1


domain (If no to 20 bytes, consisting of
domain is letters, numerals, periods,
applicable to the minus signs, or
customer, set underscores.
LOGINNAME Domain: a string of 1 to
to login 40 bytes, consisting of
name@-1). letters, numerals, periods
or minus signs. This
parameter cannot start
with or end with a period
or minus sign.
SERVICEID ID of a service to No No A decimal integer that is
be canceled. An greater than 1.
account can order
only one access
service.
BATCH Batch. Yes No A string of 1 to 14 bytes,
consisting of letters,
numerals, underscores,
periods, and minus signs.

Instance
The following is an instance of running the command for ordering a broadband service.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The SERVICEID parameter is 100.
z Command
ADD C280 ORDER:SERVICEID=100,LOGINNAME="sun@domain-usr-psw"

Be sure to enter the value of LOGINNAME, ACCOUNTNUMBER, or BATCH.

4.2.30 ACK to the Command for Ordering a Broadband Service


Command
ACK: ADD C280 ORDER

Function
This command is used to respond to the command for ordering a broadband service.

4-52 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description
Table 4-30 lists the parameters of the ACK command.

Table 4-30 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value A decimal integer.


of the ACK z 0: Subscribing the service for account succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are not authorized to access the data.
z 14: The database operation failed.
z 1000: Sorry, the service does not exist.
z 1000: System internal error.
z 1012: The account has subscribed to an access service
and cannot subscribe to another one.
z 1009: Sorry, the account cannot subscribe the access
service because it has subscribed one.
z 1010: Sorry, the account has subscribed the
value-added service.
z 1003: Sorry, the batch number does not exist.
z 1030: The account is not activated.
z 1002: The account does not exist.
z 1003: The batch number does not exist.
z 1004: The login name or batch number is missing.
z 1005: The service does not exist.
z 1006: The proxy service cannot be subscribed.
z 1007: The charge policy does not exist.
z 1010: The account cannot subscribe this service.
z 1011: This account cannot subscribe the service
because its validity period has expired.
z 1012: The account cannot subscribe the access service
because it has subscribed one.
z 1013: The service has been subscribed for the account.
z 1014: The domain doesn't exist.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-53


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

RETN Returned value z 1015: The service is not contained in the visibility
of the ACK table of service domains.
command. z 1016: This account has already subscribed the VPDN
service.
z 1017: The service cannot be subscribed by the
account.
z 1021: The accounts of the batch cannot subscribe this
service.
z 1022: The service has been subscribed for all the
accounts of this batch.
z 1023: Access service has been subscribed for the
accounts of this batch.
z 1024: This account has already subscribed the VPDN
service.
z 1500: Sorry, the user does not belong to the current
operator. (The prompt is valic when the system is in
the area management mode.)

DESC Describes cause A string of 0 to 256 bytes.


of the error. z When RETN is 0, this parameter is Subscribing the
service for account succeeded.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for ordering a
service.
z Command
ACK:ADD C280 ORDER:RETN=0,DESC="Subscribing the service for account succeeded.";

4.2.31 Command for Canceling a Service Order


Command
DEL C280 ORDER

Function
This command is used for operators to cancel subscriptions.

4-54 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Parameter Description
Table 4-31 lists the parameters of the command for canceling a service order.

Table 4-31 Parameters of the command for canceling a service order

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

ACCOUNTNU Account. Yes No A string of 1 to 20 bytes,


MBER consisting of letters,
numerals, periods, minus
signs, or underscores.
LOGINNAME Login name and Yes No Login name: a string of 1
domain (If no to 20 bytes, consisting of
domain is letters, numerals,
applicable to the periods, minus signs, or
customer, set underscores.
LOGINNAME Domain: a string of 1 to
to login 40 bytes, consisting of
name@-1). letters, numerals, periods
or minus signs. It cannot
start with or end with a
period or minus sign.
SERVICEID ID of a service No No A decimal integer of 0 to
to be subscribed 1000.
to. An account A decimal integer that is
can subscribe to greater than 1.
only one access
service.
BATCH Batch Yes No A string of 1 to 14 bytes.

Instance
The following is an instance of running the command for canceling a service order.
z Scenario
The operator cancels an ordered service of a user.
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The SERVICEID parameter is 100.
z Command
DEL C280 ORDER:SERVICEID=100,LOGINNAME="sun@domain-usr-psw"

Be sure to enter the value of LOGINNAME, ACCOUNTNUMBER, or BATCH.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-55


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

4.2.32 ACK to the Command for Canceling an Ordered Service


Command
ACK: DEL C280 ORDER

Function
This command is used to respond to the command for canceling an ordered service.

Parameter Description
Table 4-32 lists the parameters of the ACK command.

4-56 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Table 4-32 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK command. z 0: Cancelling the service for account succeeded.
z 3: The transaction control flag is incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are not authorized to access the data.
z 14: The database operation failed.
z 1006: Sorry, the service is not subscribed for the
account.
z 1003: Sorry, the batch number does not exist.
z 1130: The account is not activated.
z 1102: The account does not exist.
z 1103: The batch does not exist.
z 1104: The login name or batch number is missing.
z 1105: The service does not exist.
z 1106: Cannot delete the access service for this
account.
z 1107: This account has not subscribed the service.
z 1108: Refunding basic fee failed.
z 1109: Cannot cancel the subscription because the
subscriber is using the service.
z 1110: This batch is not authorized to subscribe the
access service.
z 1111: The service is not subscribed for all the
accounts of this batch.
z 1112: The domain doesn't exist.
z 1500: Sorry, the user does not belong to the current
operator. (The prompt is valid when the system is
in the area management mode.)
DESC Describes cause of A string of 0 to 256 bytes.
the error. z When RETN is set to 0, this parameter is
Cancelling the service for account succeeded.
z When RETN is another return code, this parameter
is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-57


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

The infoX-AAA responds to the successful running of the command for canceling an
ordered service.
z Command
ACK:DEL C280 ORDER:RETN=0,DESC="Cancelling the service for account succeeded.";

4.2.33 Command for Querying an Ordered Service


Command
QUERY C280 ORDER

Function
This command is used to query an ordered service.

Parameter Description
Table 4-33 lists the parameters of the command for querying an ordered service.

Table 4-33 Parameters of the command for querying an ordered service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name Yes No Login name: a string of


and domain (If 1 to 20 bytes, consisting
no domain is of letters, numerals,
applicable to periods, minus signs, or
the customer, underscores.
set Domain: a string of 1 to
LOGINNAM 40 bytes, consisting of
E to login letters, numerals,
name@-1). periods or minus signs.
It cannot start or end
with a period or minus
sign.
ACCOUNTNUM Account. Yes No A string of 1 to 20
BER bytes, consisting of
letters, numerals,
periods, minus signs, or
underscores.

Instance
The following is an instance of running the command for querying an ordered service.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.

4-58 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

z Command
QUERY C280 ORDER:LOGINNAME=sun@domain-usr-psw;

The values of ACCOUNTNUMBER and LOGINNAME cannot coexist and cannot be null at the same
time.

4.2.34 ACK to the Command for Querying an Ordered Service


Command
ACK: QUERY C280 ORDER

Function
This command is used to respond to the command for querying an ordered service.

Parameter Description
Table 4-34 lists the parameters of the ACK command.

Table 4-34 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the A decimal integer.


ACK command. z 0: Querying the service by account
succeeded.
z 3: The transaction control flag is incorrect.
z 7: system internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 14: The database operation failed.
z 1001: The account does not exist.
z 1000: The account does not subscribe to any
service.
z 1500: Sorry, the user does not belong to the
current operator. (The prompt is valid when
the system is in the area management mode.)
DESC Error cause. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is
Querying the service by account
succeeded.
z When RETN is another return code, this
parameter is the matching message.
TOTAL Number of queried A decimal integer.
records.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-59


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

FINISHED Indicates whether the z 0: no


operation ends. z 1: yes
START Start line of the current A decimal integer.
batch.
ROWNUM Number of records of the A decimal integer.
current batch.
ATTR List or queried attributes. Must be the following strings:
Fields are separated by LOGINNAME & SERVICEID &
ampersands (&). ORDERTIME & STATUS &
Including the following SERVICENAME & SERVICETYPE
parameters:
z LOGINNAME: Login
name and domain
z SERVICEID: ID of a
servie
z SERVICENAME:
Name of a service
z SERVICETYPE: Type
of a service
z ORDERTIME: Order
time
z STAUTS: Status of an
order
RESULT List of queried data. Result set returned when an operation
Lines are separated by the command is run.
& symbol and parameters
are separated by the |
symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
query the information about an ordered service.
z Command
QUERY C280 ORDER:RETN=0,DESC="Querying the service by account
succeeded.",TOTAL=1,FINISHED=1,START=0, ROWNUM=1,ATTR=LOGINNAME &SERVICEID &
ORDERTIME & STATUS & SERVICENAME
&SERVICETYPE,RESULT="sun@domain-usr-psw|100|20070621143808|1|test_service|1|",;

4-60 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

4.2.35 Command for Querying the Information About the User


Sessions
Command
QUERY C280 USERSESS

Function
This command is used to query the information about the sessions of the broadband user.

Parameter Description
Table 4-35 lists the parameters of the command for querying the session information about the
user.

Table 4-35 Parameters of the command for querying the session information

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERNAME Login name of No No A string of 1 to 20 bytes,


the user. consisting of letters,
numerals, periods, minus
signs, and underscores.
DOMAIN Domain name. No No A string of 1 to 40 bytes,
consisting of letters,
numerals, periods and
minus signs. It cannot start
with or end with periods or
minus signs.
SCPID ID of the Yes No 100–199
session Default value: 100
resource
manager.
USERIPADD IP address of Yes No 1.1.1.1–223.255.255.255
RESS the user.
SERVICEFA Type of the No No A string of 1 to 10 bytes.
LG installation The service types are as
service. follows:
z AAA: AAA service
z SSS: SSS service

Instance
The following is an instance of running the command for querying the session information
about a user.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-61


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is domain-usr-psw.
− The service type that the user uses is AAA service. That is, the SERVICEFLAG
parameter is AAA.
− The SCPID parameter is 100.
z Command
QUERY C280 USERSESS:SERVICEFLAG=AAA,DOMAIN="domain-usr-psw",USERNAME="sun"
,SCPID=100;

4.2.36 ACK to the Command for Queryinging the Information


About a User Session
Commands
ACK: QUERY C280 USERSESS

Function
This command is used to respond the command for querying the information about the user
sessions.

Parameter Description
Table 4-36 lists the parameters of the ACK command.

4-62 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

Table 4-36 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the ACK Commands. A decimal integer. The


integers are as follows:
z 0: Querying the session
succeeded.
z 3: The transaction
control flag is
incorrect.
z 7: System internal
error.
z 8: The parameter is
incorrect.
z 11: The operation
timed out.
z 12: You are not
authorized to access the
data.
z 14: The database
operation failed.
z 1000: Sorry, no session
for the user.
DESC Error cause. A string of 0 to 256
bytes.
z When RETN is 0, this
parameter is Querying
user succeeded.
z When RETN is another
return code, this
parameter is the
matching message.
TOTAL Number of queried records. A decimal integer.
FINISHED Indicates whether the operation ends. z 0: no
z 1: yes
START Start line of the current batch. A decimal integer.
ROWNUM Number of records in the current batch. A decimal integer.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-63


infoX-AAA
4 MML Interfaces for Broadband Service Interface Developer Guide - MML

Parameter Description Value Range

ATTR For the AAA service, the parameters are as In the AAA service, the
follows: stings must be as follows:
z USERNAME: login name. USERNAME & USERIP
z USERIP: IP address of the user. & ISNIP &
NASPORTID &
z ISNIP: IP address of the ISN device. ACCUTIME &
z NASPORTID: port type. It is used to judge ACCTSESSIONID &
whether the user accesses the Wireless Local INPUTVOLUMN &
Area Network (WLAN). OUTPUTVOLUMN
z SERSTARTTIME: time when the user goes In the SSS service, the
online stings must be as follows:
z ACCTSESSIONID: session ID. INTERFACEALIAS &
z INPUTVOLUMN: downlink traffic flow. INTERFACEDESC &
INTERFACENAME &
z OUTPUTVOLUMN: uplink traffic flow. IPADDRESS &
For the SSS service, the parameters are as USERNAME &
follows: LOGINTIME &
z INTERFACEALIAS: alias SERVICECLASS &
USERSESSIONID &
z INTERFACEDESC: description of the NASIDENTIFIER
interface that the user accesses.
z INTERFACENAME: name of the interface
that the user accesses.
z IPADDRESS: IP address of the user.
z USERNAME: login name of the user.
z LOGINTIME: the time when the user accesses
the network.
z SERVICECLASS: service type.
z USERSESSIONID: AcctSessionId of the
basic access service of the user.
z NASIDENTIFIER: identifier of the device.
List of queried attributes. Fields are separated by
the & symbol.
RESULT List of queried data. Lines are separated by the Result set returned when
& symbol and parameters are separated by the | an operation command is
symbol. run.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying the
session information about a user.
z Command

4-64 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 4 MML Interfaces for Broadband Service

QUERY C280 USERSESS:RETN=0,DESC="Querying the session


succeeded.",TOTAL=1,FINISHED=1,START=0, ROWNUM=1,ATTR= USERNAME & USERIP & ISNIP &
NASPORTID & SERSTARTTIME& ACCTSESSIONID & INPUTVOLUMN & OUTPUTVOLUMN,
RESULT="sun|178538878|0||35|2342345432|1024|512",;

Issue 04 (2007-12-29) Huawei Technologies Proprietary 4-65


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

5 Interfaces for CDMA Service

About This Chapter

The following table lists the contents of this chapter.

Section Describes

5.1 Introduction The functions of the MML interfaces in the CDMA service.
5.2 MML Commands The MML commands relevant to the CDMA service.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-1


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

5.1 Introduction
The MML interfaces of the infoX-AAA supports the CDMA service. Through the MML
interfaces, you can add and delete a CDMA user, and modify and query for the user
information in the billing system.
In the MML commands of the CDMA service, the services of all the MML commands are
named C270.

The acknowledgement (ACK) command is used for the infoX-AAA to respond to the running of an
MML command. For example, the ACK command of adding a CDMA user is the response of the
command for adding a CDMA user to the infoX-AAA.

5.2 MML Commands


5.2.1 Command for Adding a CDMA User
Command
ADD C270 ACCOUNT

Function
The command is used to register a CDMA user.

Parameter Description
Table 5-1 lists the parameters of the command for adding a CDMA user.

Table 5-1 Parameters for the command for adding a CDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of Yes No A string of 1 to 20


a CDMA user. bytes. The value can
consist of letters,
numerals, periods,
minus signs, underlines,
or a combination of the
preceding characters.

5-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that a Yes No A string of 1 to 40


CDMA user bytes. The value can
belongs to. consist of letters,
numerals, periods, or
minus signs, or a
combination of the
preceding characters. It
cannot start or end with
a period or comma.
PAYMENTMO Payment mode Yes No z 1: postpaid user.
DE of a CDMA z 2: prepaid user.
user.
GROUPID ID of the group No No A decimal integer.
that the user
belongs to.
PSWD Password of a Yes No A string of 6 to 16
MN user. bytes. The value can
consist of letters,
numerals, periods,
minus signs, underlines,
or a combination of the
preceding characters.
ANPSWD Password of an Yes No A string of 1 to 16
AN user. bytes, consisting of
letters, numerals,
periods, minus signs,
and underscores.
MSID ID of a mobile Yes No A string of 1 to 20
user. bytes, consisting of only
numerals.
MDN Mobile phone Yes No A string of 1 to 28
number of a bytes.
CDMA user.
EXTTEMPLET Template Yes No A string of one or more
number of a bytes.
user. Set it to The number –1 or a
–1 when the decimal integer greater
parameter is not than 0.
needed.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-3


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

IPASSIGN Mode of Yes No z 0: not assign IP


assigning the IP address
address. z 1: assign static IP
address
z 2: assign dynamic IP
address
IP IP address that Yes No A decimal integer.
is assigned
statically to a
CDMA user.
IPMASK Subnet mask of Yes No A decimal integer.
the IP address.
IPPOOLID ID of an IP Yes No z 1: device address pool
address pool. z 2: AAA address pool
When
IPASSIGN is
set to 2, the
field cannot be
omitted.
RK Registry key of Yes No A string of 1 to 32
the BCMCS. bytes.
NEEDIRS Whether to Yes No z 0: no
support IP z 1: yes
Reachability.
UZID Area where a Yes No A decimal integer.
subscriber
roams.
ISAUTH Whether the Yes No z 0: no
user group is z 1: yes
authenticated.
MSIDENTIFIE Terminal type. Yes No z 0: Not set when the
R user is added
z 1: ESN
z 2: MEID

5-4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

UIMID Sequence Yes Yes z When the


number. When MSIDENTIFIER
the user is an value is ESN, the
AN user, this parameter is a
parameter need hexadecimal string of
not be set. 8 bytes.
z When the
MSIDENTIFIER
value is MEID, the
parameter is a
hexadecimal string of
14 bytes.
AUTHFAILCN Count of Yes No A decimal integer.
TTRH authentication
failure.
CHGVAL Amount for Yes No A decimal integer.
registration.
MSTYPE Type of a Yes No z 0: single mode
terminal. z 1: dual mode
SSDSYNCNTT SSD Yes No A decimal integer.
RH synchronous
counter.
SERVICESTO Validity period Yes No A string in the
P of an account. YYYYMMDDHHMMSS
format.

NOTE
AN = Access Network
MN = Mobile Network

Instance
The following is an instance of running the command for adding a CDMA user.
z Scenario
− The DOMAIN parameter is usr-psw-imsi.
− The user needs to be authenticated. That is, the ISAUTH parameter is 1.
− The AUTHFAILCNTTRH parameter is 0.
− The mode of assigning the IP address is static. That is, the IPASSIGN parameter is 1.
− The IP parameter is 168430090. The IPMASK parameter is –256.
− The UZID parameter is 12.
− The EXTTEMPLET parameter is 2.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-5


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

− The IP reachability is supported. That is, the NEEDIRS parameter is 1.


− The SERVICESTOP parameter is 20380101000000.
− The MSID parameter is 1234.
− The GROUPID parameter is 1.
− The MDN parameter is 13851771249.
− The LOGINNAME parameter is sun.
− The PSWD parameter is 123456.
− The payment type is prepaid. That is, the PAYMENTMODE parameter is 2.
z Command
ADD C270 ACCOUNT:UZID=12,DOMAIN="usr-psw-imsi",IP=168430090,
IPASSIGN=1,EXTTEMPLET=2,ISAUTH=1,IPMASK=-256,AUTHFAILCNTTRH=0,NEEDIRS=1,
SERVICESTOP=20380101000000,MSID=1234,GROUPID=1,MDN=13851771249,LOGINNAME="sun",
PAYMENTMODE=2,PSWD=123456

1. The IP address and subnet mask in the command for adding a CDMA user must be integers.
2. The values of LOGINNAME, PSWD, and MSID are subject to Authtype of a domain.
z When Authtype of a domain is 0, LOGINNAME, PSWD, and MSID can be omitted.
z When Authtype of a domain is 1, MSID cannot be omitted.
z When Authtype of a domain is 4, LOGINNAME cannot be omitted.
z When Authtype of a domain is 5, LOGINNAME and MSID cannot be omitted.
z When Authtype of a domain is 6, LOGINNAME and PSWD cannot be omitted.
z When Authtype of a domain is 7, LOGINNAME, PSWD, and MSID cannot be omitted.
3. The CHGVAL parameter can be used only for the local prepaid CDMA user.
4. When the system does not support the local prepaid mode but the payment is in prepaid mode,
MDN cannot be omitted or null.
5. The values of IP, IPMASK, and IPPOOLID are subject to the mode of assigning the IP
addresses.
z When IPASSIGN is 0, IP, IPMASK, and IPPOOLID must be omitted.
z When IPASSIGN is 1, IP and IPMASK cannot be omitted; IPPOOLID must be omitted.
z When IPASSIGN is 2, IP and IPMASK must be omitted.

5.2.2 ACK to the Command for Adding a CDMA User


Command
ACK: ADD C270 ACCOUNT

Function
The command is used to respond to the command for adding a CDMA user.

5-6 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description
Table 5-2 lists the parameters of the ACK command.

Table 5-2 Parameters of the ACK command

Parameter Description Value Range

RETN Returned A decimal integer.


value of the z 0: Succeeded in registering the WCDMA user.
ACK
command.
z 3: The transaction control flag is incorrect.
z 7: Internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1001: Sorry, the user group does not exist.
z 1002: Sorry, the domain does not exist.
z 1004: Sorry, login name is required.
z 1005: Sorry, IMSI is required
z 1006: Sorry, the extended attribute does not exist.
z 1007: Sorry, both password and IMSI are required.
z 1008: Sorry. The license you want to query for does not
exist.
z 1008: Sorry, the IP address pool does not exist.
z 1009: Sorry, password is required
z 1010: Sorry, the subscriber already exists.
z 1013: The LDAP failed to roll back the data.
z 1014: The LDAP succeeded in rolling back the data.
z 1020: Sorry, the static IP address already exists.
z 1085: User Zone doesn't exist.
z 1089: Sorry, the Paymode Type must input.
z 1203: Failed to register the user in CDMA service.
z 1205: The parameter UIMID no need.
z 7007: Number of key columns does not match number of
key values.
z 7009: Require one parameter with value at least.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-7


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Parameter Description Value Range

RETN Returned z 1015: Adding LDAP data failed.


value of the z 1088: Sorry, the assign mode of IP address must be
ACK input.
command
z 1088: Sorry, the loginname and IMSI must be input.
z 1088: Sorry, password must be input if needing
authentication.
z 1090: This user group has no AN right, so the User Zone
cannot be entered.
z 1092: Sorry, the IMSI already exists.
z 1100: Sorry, the license is not enough.
z 1117: Local prepaid user cannot choose the domain of
authentication-user-name type.
z 1119: Sorry, the management of user can't choose
skipping domain.
z 1903: UppLimitB not found.
z 1904: Charge value exceed upper limit.
z 7001: Entry has already existed.
z 7002: Adding LDAP data failed.
z 7003: Deleting the LDAP data failed.
z 7004: Modifying the LDAP data failed.
z 7005: Connecting LDAP failed.
z 7006: Bind LDAP failed.
DESC Cause of the A string of 0 to 256 bytes.
error. z When RETN is 0, this parameter is Succeeded in
adding a CDMA subscriber.
z When RETN is another return code, this parameter is the
matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for adding a CDMA
user.
z Command
ACK:ADD C270 ACCOUNT:RETN=0,DESC="Succeeded in adding a CDMA subscriber.";

5.2.3 Command for Deleting a CDMA User


Command
DEL C270 ACCOUNT

5-8 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Function
The command is used to deregister a CDMA user.

Parameter Description
Table 5-3 lists the parameters of the command for deleting a CDMA user.

Table 5-3 Parameters for the command for deleting a CDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of Yes No A string of 1 to 20 bytes.


a CDMA user The value can consist of
(If no domain letters, numerals, periods,
is applicable to minus signs, underlines, or
the customer, a combination of the
set preceding characters.
LOGINNAME
to login
name@-1).
DOMAIN Domain that a No No A string of 1 to 40 bytes.
CDMA user The value can consist of
belongs to. letters, numerals, periods,
or minus signs, or a
combination of the
preceding characters. It
cannot start or end with a
period or comma.
MSID ID of a mobile Yes No A string of 1 to 20 bytes.
user.
REMOVEALL Whether to Yes No z 0: no
delete all z 1: yes
information of
users.

Instance
The following is an instance of running the command for deleting a CDMA user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
− Delete all the user information. That is, the REMOVEALL parameter is 1.
z Command
DEL C270 ACCOUNT: DOMAIN=usr-psw-imsi, REMOVEALL=0, LOGINNAME=sun;

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-9


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

The LOGINNAME and MSID cannot coexist and cannot be null at the same time.

5.2.4 ACK to the Command for Deregistering a CDMA User


Command
ACK: DEL C270 ACCOUNT

Function
The command is used to respond to the command for deregistering a CDMA user.

Parameter Description
Table 5-4 lists the parameters of the ACK command.

Table 5-4 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Succeeded in deleting the CDMA subscriber.
command.
z 3: The transaction control flag is incorrect.
z 7: Internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1001: Sorry, the user group does not exist.
z 1011: Sorry, the account does not exist.
z 1009: Deleting the LDAP data failed.
z 2222: Sorry, the user cannot be deleted while system
is deducting basic fee.
DESC Cause of the A string of 0 to 256 bytes.
error. z When RETN is 0, this parameter is Succeeded in
deleting the CDMA subscriber.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for deleting a
CDMA user.

5-10 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

z Command
ACK:DEL C270 ACCOUNT:RETN=0,DESC="Succeeded in deleting the CDMA subscriber.";

5.2.5 Command for Querying for the Information About a CDMA


User
Command
QUERY C270 ACCOUNT

Function
This command is used to query for the information about a CDMA user.

Parameter Description
Table 5-5 lists the parameters of the command for querying for the information about a
CDMA user.

Table 5-5 Parameters for the command for querying for the information about a CDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a Yes No A string of 1 to 20


CDMA user (If no bytes. The value can
domain is consist of letters,
applicable to the numerals, periods,
customer, set minus signs,
LOGINNAME to underlines, or a
login name@-1). combination of the
preceding characters.
DOMAIN Domain that a Yes No A string of 1 to 40
CDMA user bytes. The value can
belongs to. consist of letters,
numerals, periods, or
minus signs, or a
combination of the
preceding characters.
It cannot start or end
with a period or
comma.
MSID ID of a mobile Yes No A string of 1 to 20
user. bytes.

Instance
The following is an instance of running the command for querying for the information about a
CDMA user.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-11


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
z Command
QUERY C270 ACCOUNT:DOMAIN=usr-psw-imsi,LOGINNAME=sun

The LOGINNAME and MSID cannot coexist and cannot be null at the same time.

5.2.6 ACK to the Command for Querying Information of a CDMA


User
Command
ACK: ADD C270 ACCOUNT

Function
The command is used to respond to the command for querying information of a CDMA user.

Parameter Description
Table 5-6 lists the parameters of the ACK command.

Table 5-6 Parameters of the ACK command


Parameter Description Value Range

RETN Returned value of the ACK command. A decimal integer.


z 0: Succeeded in
querying the CDMA
subscriber.
z 3: The transaction
control flag is
incorrect.
z 7: Internal error.
z 8: The parameter is
incorrect.
z 11: The operation
timed out.
z 12: You are
unauthorized to access
the data.
z 14: The database
operation failed.
z 1011: Sorry, the
account does not exist.

5-12 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Value Range

DESC Cause of the error. A string of 0 to 256


bytes.
z When RETN is 0, this
parameter is
Succeeded in
querying the CDMA
subscriber.
z When RETN is
another return code,
this parameter is the
matching message.
TOTAL Total number of lines of queried results. A decimal integer.
FINISHED Whether the operation is complete. z 0: no
z 1: yes
START Start line number in the current batch. A decimal integer.
ROWNUM Number of records in the current batch. A decimal integer.
ATTR List of query attribute names that are separated The value must be the
by the & symbols. following string:
The attribute names are as follows: DOMAIN &
z DOMAIN: home domain LOGINNAME & US
z LOGINNAME: login name ERGROUPID &
NEWUSERGROUPID
z USERGROUPID: user group ID &
z USERGROUPNAME: user group name NEWGRPEFFECTTIM
z GROUPSTATE: user state E&
USERGROUPNAME &
z PAYMENTMODE: payment type NEWUSERGROUPNA
z MSID: MSID of a CDMA user ME & GROUPSTATE
z IP: IP address that is assigned statically & USERTYPE &
PAYMENTMODE &
z EXTTEMPLET: common template ID of a MSID & ANMSID & IP
user & EXTTEMPLET &
z STATUS: user state STATUS & REGTIME
z REGTIME: time when an account is & DEREGTIME &
registered MDN & IPASSIGN &
IPMASK & RK &
z MDN: mobile phone number NEEDIRS &
z IPASSIGN: mode of assigning the IP address AUTHTYPE &
z IPMASK: subnet mask of the IP address LOCKFLAG &
LOCKTIME &
z RK: BCMCS registered secret key PSWERRORCOUNT &
z NEEDIRS: whether to support the IP IPPOOLNAME &
reachability IPPOOLID &
z AUTHTYPE: authentication mode of the ACCOUNTLEFT &
home domain IPPOOLTYPE &
ISAUTH &
z LOCKFLAG: lock flag of a CDMA user MSIDENTIFIER &
z LOCKTIME: time when the blacklist is UIMID &

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-13


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Parameter Description Value Range


updated. AUTHFAILCNTTRH
z PSWERRORCOUNT: times of putting into & SSDSYNCNTTRH &
the blacklist SERVICESTOP &
UZID &
z IPPOOLNAME: name of the IP address pool TEMPLATENAME
z IPPOOLID: ID of the IP address pool
z ACCOUNTLEFT: balance of the local
prepaid user
z IPPOOLTYPE: type of the IP address pool
z MSTYPE: terminal type
z ISAUTH: whether the user group is
authenticated
z UIMID: electronic serial number
z NEWUSERGROUPID: ID of a new user
group
z NEWGRPEFFECTTIME: time when the new
user group takes effect
z USERTYPE: user type
z ANMSID: user identifier delivered when an
AN user is authenticated and authorized
z MSIDENTIFIER: terminal type
RESULT List of queried data. Every two lines are Result set returned by
separated by the & symbol and every two the operation command
parameters are separated by the | symbol. according to the actual
situation.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying for the
information about a CDMA user.
z Command
ACK:QUERY C270 ACCOUNT:RETN=0, DESC=" Succeeded in querying the CDMA subscriber",
TOTAL=1, FINISHED=1, START=0, ROWNUM=1, ATTR=DOMAIN & LOGINNAME & USERGROUPID &
NEWUSERGROUPID & NEWGRPEFFECTTIME & USERGROUPNAME & NEWUSERGROUPNAME & GROUPSTATE
& USERTYPE & PAYMENTMODE & MSID & ANMSID & IP & EXTTEMPLET & STATUS & REGTIME & DEREGTIME
& MDN & IPASSIGN & IPMASK & RK & NEEDIRS & AUTHTYPE & LOCKFLAG & LOCKTIME & PSWERRORCOUNT
& IPPOOLNAME & IPPOOLID & ACCOUNTLEFT & IPPOOLTYPE & ISAUTH & MSIDENTIFIER & UIMID
& AUTHFAILCNTTRH & SSDSYNCNTTRH & SERVICESTOP & UZID & TEMPLATENAME,
RESULT="-1|test|21|-1|20380101000000|21||0|1|1|4644765|4644765|-1|-1|0|20080101
005755||123456789|0|-1||0|6|||||-1|0||1|0||0|0|20380101000000|-1|",;

5-14 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

5.2.7 Command for Modifying the Information About a CDMA


Subscriber
Command
MOD C270 ACCOUNT

Function
This command is used to modify the information about a CDMA user.

Parameter Description
Table 5-7 lists the parameters of the command for modifying the information about a CDMA
user.

Table 5-7 Parameters for the command for modifying the information about a CDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a Yes No A string of 1 to


CDMA user (If on 20 bytes. The
domain is applicable value can consist
to the customer, set of letters,
LOGINNAME to numerals,
login name@-1). periods, minus
signs,
underlines, or a
combination of
the preceding
characters.
DOMAIN Domain that a Yes No A string of 1 to
CDMA user belongs 40 bytes. The
to. value can consist
of letters,
numerals,
periods, or
minus signs, or a
combination of
the preceding
characters. It
cannot start or
end with a
period or
comma.
PAYMENTMO Payment mode of a Yes No z 1: postpaid
DE CDMA user. user
z 2: prepaid user

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-15


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

STATUS Status of a CDMA Yes No z 0: normal


user. z 1: frozen
z 2: deregistered
GROUPID ID of the group that Yes No A decimal
the user belongs to. integer.
REPLACEGRP Whether to replace Yes No z 0: not replace
FLAG the flag of the user z 1: replace
group.
NEWUSERGR ID of the new user Yes No The value –1 or
OUPID group. a decimal integer
that is greater
than 0.
When
REPLACEGRP
FLAG is set to
1, the parameter
is mandatory.
NEWGRPEFF Time when the new Yes No Format:
ECTTIME user group takes YYYYMMDDhh
effect. mmss
PSWD Password used by a Yes No A string of 1 to
CDMA user for 16 bytes. The
login. value can consist
of letters,
numerals,
periods, minus
signs,
underlines, or a
combination of
the preceding
characters.
MSID ID of a mobile user. Yes Yes A string of 1 to
20 bytes,
consisting of
only numerals.
MDN Number of a mobile Yes No A string of 1 to
phone of a CDMA 20 bytes.
user.
LOCKFLAG Lock flag of a Yes No z 0: available
CDMA user. z 1: locked

5-16 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

EXTTEMPLET Number of a common Yes No The number –1


attribute template of a or a decimal
user. integer greater
than 0.
IPASSIGN Mode of assigning IP Yes No z 0: not assign
addresses. z 1: static IP
address
z 2: dynamic IP
address
IP Static IP address of a Yes No A decimal
CDMA user. integer.
IPMASK Subnet mask of an IP Yes No A decimal
address. integer.
When IPASSIGN is
set to 1, the field
cannot be omitted.
IPPOOLID ID of an IP address Yes No The number –1
pool. or a decimal
When IPASSIGN is integer greater
set to 2, the field than 0.
cannot be omitted.
RK Registry key of the Yes No A string of 1 to
BCMCS. 32 bytes.
NEEDIRS Whether to support Yes No z 0: no
the IP reachability. z 1: yes
UZID Area where a Yes No A decimal
subscriber roams. integer.
ISAUTH Whether the user Yes No z 0: no
group is z 1: yes
authenticated.
MSIDENTIFIE Terminal type. Yes No z 0: Not set
R when the user
is added
z 1: ESN
z 2: MEID

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-17


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

UIMID Sequence number. Yes Yes z When the


MSIDENTIFI
ER value is
ESN, the
parameter is a
hexadecimal
string of 8
bytes.
z When the
MSIDENTIFI
ER value is
MEID, the
parameter is a
hexadecimal
string of 14
bytes.
AUTHFAILCN Count of Yes No A decimal
TTRH authentication failure. integer.
MSTYPE Type of a terminal. Yes No z 0: single mode
z 1: dual mode
SSDSYNCNTT SSD synchronous Yes No A decimal
RH counter. integer.
SERVICESTO Validity period of an Yes No A string in the
P account. YYYYMMDDHH
MMSS format.

Instance
The following is an instance of running the command for modifying the information about a
CDMA user.
z Scenario 1
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
− The EXTTEMPLET parameter is 2.
− The payment type is prepaid. That is, the PAYMENTMODE parameter is 2.
− The user status is normal. That is, the STATUS parameter is 0.
− The MSID parameter is 1234.
− The GROUPID parameter is 1.
− The new MDN is 13851771249.
− The mode of assigning the IP address is static. That is, the IPASSIGN parameter is 2.
− The IPPOOLID parameter is 3.

5-18 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

− The UZID parameter is 12.


− The IP reachability is supported. That is, the NEEDIRS parameter is 1.
− The SERVICESTOP parameter is 20380101000000.
z Command
MOD C270 ACCOUNT:UZID=12,DOMAIN="usr-psw-imsi",IPASSIGN=2,EXTTEMPLET=2,STATUS=0,
IPPOOLID=3,NEEDIRS=1,SERVICESTOP=20380101000000,MSID="1234",GROUPID=1,MDN=13851
771249,LOGINNAME=sun,PAYMENTMODE=2

1. The IP address and subnet mask in the command for modifying a CDMA user must be integers.
2. The values of LOGINNAME, PSWD, and MSID are subject to the Authtype of a domain.
z When Authtype of a domain is 0, the parameters LOGINNAME, PSWD, and MSID can be
omitted.
z When Authtype of a domain is 1, the MSID cannot be omitted.
z When Authtype of a domain is 4, the LOGINNAME parameter cannot be omitted.
z When Authtype of a domain is 5, the LOGINNAME and MSID cannot be omitted.
z When Authtype of a domain is 6, the LOGINNAME and PSWD cannot be omitted.
z When Authtype of a domain is 7, the LOGINNAME, PSWD, and MSID cannot be omitted.
3. The CHGVAL parameter can be used only for the local prepaid CDMA user.
4. When the system does not support the local prepaid mode but the payment is in prepaid mode,
MDN cannot be omitted or null.
5. The values of IP, IPMASK, and IPPOOLID are subject to the mode of assigning the IP
addresses.
z When IPASSIGN is 0, IP, IPMASK, and IPPOOLID must be omitted.
z When IPASSIGN is 1, IP and IPMASK cannot be omitted. The IPPOOLID must be omitted.
z When IPASSIGN is 2, IP and IPMASK must be omitted.
z Scenario 2
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
− The user group needs to be replaced. That is, the REPLACEGRPFLAG parameter
is 1.
− The NEWUSERGROUPID parameter is 77.
− The effective time of the new user group is 2008-01-01-00:00:00. That is, the
NEWGRPEFFECTTIME parameter is 20080101000000. The parameter can be
null. If the parameter is null and the command is used to modify the information
about a user group, you can set the effective time of the new user group according to
the NDT or the current time.
z Command
MOD C270 ACCOUNT:DOMAIN="usr-psw-imsi", LOGINNAME=sun, REPLACEGRPFLAG=1,
NEWUSERGROUPID=77,NEWGRPEFFECTTIME=20080101000000

5.2.8 ACK to the Command for Modifying the Information About


a CDMA User
Command
ACK: MOD C270 ACCOUNT

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-19


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Function
The command is used to respond to the command for modifying information of a CDMA user.

Parameter Description
Table 5-8 lists the parameters for the ACK command.

Table 5-8 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Succeeded in modifying the CDMA subscriber.
command.
z 0: Succeeded in changing the CDMA subscriber
password.
z 0: Succeeded in unlocking the CDMA subscriber.
z 3: The transaction control flag is incorrect.
z 7: Internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1001: Sorry, the user group does not exist.
z 1002: Sorry, the domain doesn't exist.
z 1005: Sorry, IMSI is required.
z 1006: Sorry, the extended template does not exist.
z 1008: Sorry, the IP address pool does not exist.
z 1009: Sorry, IMSI cannot be modified for the
subscriber that authenticates IMSI.
z 1011: Sorry, the account does not exist.
z 1011: Modifying the LDAP data failed.
z 1014: Sorry, no matching CDMA subscriber exists.
z 1018: Sorry, needing username.
z 1085: User Zone doesn't exist.
z 1088: Sorry, the loginname and IMSI must be input.
z 1090: This user group has no AN right, so the User
Zone cannot be entered.
z 1020: Sorry, the static IP address already exists.
z 1093: The user does not support MN password.
z 1100: Sorry, the license is not enough.
z 1116: Sorry. The subscriber is not locked.
z 1117: Local prepaid user cannot choose the domain of
authentication-user-name type.
z 1119: Sorry, the account has been deleted.

5-20 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Value Range


z 1119: Sorry, the management of user can't choose
skipping domain.
z 1202: Deducting fee… The user group cannot be
modified now. Please try later.
z 1301: The user type of the new user group can not be
changed.
z 1300: The parameter GroupID is not correct.
DESC Cause of the A string of 0 to 256 bytes.
error. z When RETN is 0, this parameter is Succeeded in
modifying the CDMA subscriber.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
modify the information about a CDMA user.
z Command
ACK:MOD C270 ACCOUNT:RETN=0,DESC="Succeeded in modifying the CDMA subscriber.";

5.2.9 Command for Changing the Password of an AN User


Command
MOD C270 ANPWD

Function
This command is used to change the password of an AN user.

Parameter Description
Table 5-9 lists the parameters of the command for changing the password of an AN user.

Table 5-9 Parameters of the command for changing the password of an AN user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a Yes No A string of 1 to 20 bytes,


CDMA user. consisting of letters,
numerals, periods, minus
signs, and underscores.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-21


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Home domain of Yes No A string of 1 to 40 bytes.


a CDMA user. The value can consist of
letters, numerals, periods,
or minus signs, or a
combination of the
preceding characters. The
string cannot start or end
with a period or a minus
sign.
ANPSWD New password. No Yes A string of 1 to 16 bytes.
The value can consist of
letters, numerals, periods,
minus signs, underlines,
or a combination of the
preceding characters.

Instance
The following is an instance of running the command for changing the password of an AN
user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
− The ANPSWD parameter is 000000.
z Command
MOD C270 ANPWD: ANPSWD=000000,DOMAIN=usr-psw-imsi,LOGINNAME=sun

The LOGINNAME and DOMAIN parameters must be omitted at the same time or coexist.

5.2.10 ACK to the Command for Changing the Password of an AN


User
Command
ACK: MOD C270 ANPWD

Function
The command is used to respond to the command for changing the password of an AN user.

5-22 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description
Table 5-10 lists the parameters of the ACK command.

Table 5-10 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Changing AN password succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1011: Sorry, this account does not exist.
z 1001: Sorry, the user group does not exist.
z 1001: The user does not support AN password.
z 1002: LDAP operation failed when changing NAI.
z 1013: The LDAP failed to roll back the data.
z 1003: Failed to change AN password.
z 1119: Sorry, the account has been deleted.
DESC Cause of the error. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is Changing AN
password succeeded.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for changing the
user password.
z Command
ACK: MOD C270 ANPWD:RETN=0, DESC=" Changing AN password succeeded";

5.2.11 Command for Modifying the User Password in the


Self-Service System
Command
MOD C270 PASSWD

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-23


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Function
The command is used to modify the user password in the self-service system.

Parameter Description
Table 5-11 lists the parameters of the command for changing the user password in the
self-service system.

Table 5-11 Parameters for the command for changing the user password in the self-service system

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a No No A string of 1 to 20


CDMA user (If on bytes. The value can
domain is applicable consist of letters,
to the customer, set numerals, periods,
LOGINNAME to minus signs, underlines,
login name@-1). or a combination of the
preceding characters.
DOMAIN Domain that a No No A string of 1 to 40
CDMA user belongs bytes. The value can
to. consist of letters,
numerals, periods, or
minus signs, or a
combination of the
preceding characters. It
cannot start or end with
a period or comma.
OLDPASSWD Old password. No No A string of 1 to 16
bytes. The value can
consist of letters,
numerals, periods,
minus signs, underlines,
or a combination of the
preceding characters.
NEWPASSWD New password. No No A string of 1 to 16
bytes. The value can
consist of letters,
numerals, periods,
minus signs, underlines,
or a combination of the
preceding characters.

Instance
The following is an instance of running the command for changing the user password in the
self-service system.

5-24 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
− The OLDPASSWD parameter is 123456.
− The NEWPASSWD parameter is 654321.
z Command
MOD C270 PASSWD: DOMAIN=usr-psw-imsi, OLDPASSWD=123456, NEWPASSWD=654321,
LOGINNAME=sun

5.2.12 ACK to the Command for Modifying the User Password in


the Self-Service System
Command
ACK: MOD C270 PASSWD

Function
The command is used for the infoX-AAA system to respond to the command for modifying
the user password in the self-service system.

Parameter Description
Table 5-12 lists the parameters of the ACK command.

Table 5-12 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Succeeded in changing the CDMA subscriber
command. password.
z 3: The transaction control flag is incorrect.
z 7: Internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1011: Sorry, the account does not exist.
z 1013: Sorry, the old password is incorrect.
DESC Description of A string of 0 to 256 bytes.
error cause. z When RETN is 0, this parameter is Succeeded in
changing the CDMA subscriber password.
z When RETN is another return code, this parameter is
the matching message.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-25


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for changing the
user password in the self-service system.
z Command
ACK: MOD C270 PASSWD:RETN=0,DESC="Succeeded in changing the CDMA subscriber
password.";

5.2.13 Command for Recharging a CDMA Local Prepaid Account


Command
CHARGE C270 ACCOUNT

Function
This command is used to recharge a CDMA local prepaid account.

Parameter Description
Table 5-13 lists the parameters of the command for recharging a CDMA local prepaid
account.

Table 5-13 Parameters for the command for recharging a CDMA local prepaid account

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a No No A string of 1 to 20


CDMA user (If bytes. The value can
no domain is consist of letters,
applicable to the numerals, periods,
customer, set minus signs, underlines,
LOGINNAME or a combination of the
to login preceding characters.
name@-1).
DOMAIN Domain that a No No A string of 1 to 40
CDMA user bytes. The value can
belongs to. consist of letters,
numerals, periods, or
minus signs, or a
combination of the
preceding characters. It
cannot start or end with
a period or comma.
MSID ID of a mobile Yes No A string of 1 to 20
user. bytes, consisting of
only numerals.

5-26 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

CHGVAL Amount. No No From zero to the


maximum balance of
the prepaid account.

Instance
The following is an instance of running the command for recharging a CDMA local prepaid
account.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
− The CHGVAL parameter is 2000 cents.
z Command
CHARGE C270 ACCOUNT: LOGINNAME=sun, DOMAIN=usr-psw-imsi, CHGVAL=2000

The LOGINNAME and MSID cannot coexist and cannot be null at the same time.

5.2.14 ACK to the Command for Recharging a CDMA Local


Prepaid Account
Command
ACK: CHARGE C270 ACCOUNT

Function
The command is used to respond to the command for recharging a CDMA local prepaid
account.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-27


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Parameters Description
Table 5-14 lists the parameters of the ACK command.

Table 5-14 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Cash recharging succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: Internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1011: Sorry, the account does not exist.
z 1903: UppLimitB does not exist.
z 1904: Charge value exceed upper limit.
z 1905: Account left overflow after charge.
z 1910: Account not found.
z 1911: Parameter not match prepay user type.
z 1912: Postpaid user cannot be charged.
z 1913: The user will be deleted, cannot been charged.
DESC Cause of the error. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is Cash recharging
succeeded.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for recharging a
local prepaid CDMA user.
z Command
ACK:CHARGE C270 ACCOUNT:RETN=0, DESC="Cash recharging succeeded.";

5.2.15 Command for Querying the Bill of a CDMA Account


Command
QUERY C270 BILL

5-28 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Function
This command is used to query for the bill of a CDMA account.

Parameters Description
Table 5-15 lists the parameters of the command for querying a bill.

Table 5-15 Parameters for the command for querying a bill

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a No No A string of 1 to 20


CDMA user (If bytes. The value can
no domain is consist of letters,
applicable to the numerals, periods,
customer, set minus signs, underlines,
LOGINNAME or a combination of the
to login preceding characters.
name@-1).
DOMAIN Domain that a No No A string of 1 to 40
CDMA user bytes. The value can
belongs to. consist of letters,
numerals, periods, or
minus signs, or a
combination of the
preceding characters. It
cannot start or end with
a period or minus sign.
BILLTIME Time of the bill. No No z Format:
YYYYMMDDhhmmss
z You can only query
for the bill in the past
three months.

Instance
The following is an instance of running the command for querying for a bill.
z Scenario
− The LOGINAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
− The BILLTIME parameter is 20060901010101.
z Command
QUERY C270 BILL:LOGINNAME=sun, DOMAIN=usr-psw-imsi, BILLTIME=20060901010101

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-29


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

5.2.16 ACK to the Command for Querying for a Bill of a CDMA


Local Prepaid Account
Command
ACK: QUERY C270 BILL

Function
The command is used to respond to the command for querying for a bill of a CDMA local
prepaid account.

Parameter Description
Table 5-16 lists the parameters of the ACK command.

Table 5-16 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of the A decimal integer.


ACK command. z 0: Querying the bill succeeded.
z 3: The transaction control flag is incorrect.
z 7: Internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1000: System internal error.
z 1011: Sorry, the account does not exist.
z 1012: Sorry, the bill does not exist.
z 1034: System internal error.
DESC Cause of the error. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is Querying the
bill succeeded.
z When RETN is another return code, this
parameter is the matching message.
TOTAL Total number of lines A decimal integer.
of queried results.
FINISHED Whether the operation z 0: no
is complete. z 1: yes
START Start line number in A decimal integer.
the current batch.
ROWNUM Number of records in A decimal integer.
the current batch.

5-30 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Value Range

ATTR List of query attribute The value must be the following string:
names that are STREAMNUMBER & LOGINNAME &
separated by the & DOMAIN & USERIP & ACCOUNTREASON &
symbol. MDN & SERVICESTARTTIME & STARTTIME
Including the & ENDTIME & SESSIONTIME &
following parameters: SESSIONVOLUME & FEE & RATEPOLICYIDX
z LOGINNAME: & GROUPID & SERVICEID
login name.
z ACCOUNTREASO
N: bill type.
z MDN: mobile phone
number.
z SERVICESTARTTI
ME: time of access.
z STARTTIME: time
of last request.
z ENDTIME: time of
current request.
z SESSIONTIME:
session duration.
z SESSIONVOLUME
: session volume.
z FEE: online fee.
RESULT List of queried data. Result set returned by the operation command
Every two lines are according to the actual situation.
separated by the &
symbol, and every two
parameters are
separated by the |
symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying for a
bill.
z Command
ACK: QUERY C270 BILL:RETN=0, DESC="Querying the bill succeeded.", TOTAL=211,
FINISHED=1, START=200, ROWNUM=11, ATTR=STREAMNUMBER & L
OGINNAME & DOMAIN & USERIP & ACCOUNTREASON & MDN & SERVICESTARTTIME & STARTTIME &
ENDTIME & SESSIONTIME & SESSIONVOLUME & FEE & RATEPOLICYIDX & GROUPID & SERVICEID,
RESULT="211|sun|usr-psw-imsi|10.164.9.72|2||20060916180725|20060
916180725|20060916180726|3|0|1|3|1|10000|&217|sun|usr-psw-imsi|10.164.9.72|2||2
0060916180731|20060916180731|20060916180732|3|0

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-31


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

|1|3|1|10000|&218|sun|usr-psw-imsi|10.164.9.72|2||20060916180732|
20060916180732|20060916180733|3|0|1|3|1|10000|&219|sun|-1|10.164.9.72|2||200609
16180733|20060916180733|20060916180734|3|0|1|3|1|10000|&220|sun|1|10.164.9.72|2
||20060916180734|20060916180734|20060916180735|3|0|1|3|1|10000|&221|sun|-1|10.1
64.9.72|2||20060916180734|20060916180734|20060916180737|3|0|1|3|1|10000|",

5.2.17 Command for Querying for the Start Time and


Accumulative Usage of a Service
Command
QUERY C270 USAGE

Function
The command is used for CDMA users to query for the start time and accumulative service
usage of a service.

Parameter Description
Table 5-17 lists the parameters of the QUERY C270 USAGE command.

Table 5-17 Parameters of the QUERY C270 USAGE command


Parameter Description Whethe Wheth Value Range
r Can er Can
Be Be Null
Omitte
d

LOGINNAME Login name of a No No A string of 1 to 20 bytes.


CDMA user (If no The value can consist of
domain is applicable letters, numerals,
to the customer, set periods, minus signs,
LOGINNAME to underlines, or a
login name@-1). combination of the
preceding characters.
DOMAIN Domain that a CDMA No No A string of 1 to 40 bytes.
user belongs to. The value can consist of
letters, numerals,
periods, or minus signs,
or a combination of the
preceding characters. It
cannot start or end with a
period or minus sign.
SERVICEID ID of the service that a Yes No A positive integer from 1
CDMA user wants to to 2147483647.
query for.

5-32 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Instance
The following is an instance of running the command to query for the start time and
accumulative service usage of a service.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
z Command
QUERY C270 USAGE:LOGINNAME="sun",DOMAIN="usr-psw-imsi"

z If a user omits the service ID in the command, the user can query for the start periods and
accumulative service usage of the services in the user group that the user belongs to. Currently, one
user group can associate with only one service.
z If the user enters the ID of a service in the command, the user can query for the start time and
accumulative service usage of the service.

5.2.18 ACK to Command for Querying for the Start Time and
Accumulative Usage of a Service
Command
ACK: QUERY C270 USAGE

Function
The command is used to respond to the command for CDMA users to query for the start time
and accumulative service usage of a service.

Parameter Description
Table 5-18 lists the parameters of the ACK command.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-33


infoX-AAA
5 Interfaces for CDMA Service Interface Developer Guide - MML

Table 5-18 Parameters of the ACK command


Parameter Description Value Range
RETN Returned value of the ACK command. A decimal integer.
z 0: Querying for the
service start time and
accumulative service
usage succeeded.
z 3: The transaction
control flag is
incorrect.
z 7: Internal error.
z 8: The parameter is
incorrect.
z 11: The operation
timed out.
z 12: You are
unauthorized to access
the data.
z 14: The database
operation failed.
z 1294: Sorry, only a
prepaid user can query
for the service usage.
z 1108: Sorry, the
service subscribed by
the subscriber does not
exist.
DESC Cause of the error. A string of 0 to 256
bytes.
z When RETN is 0, this
parameter is Querying
for the service start
time and
accumulative service
usage succeeded.
z When RETN is
another return code,
this parameter is the
matching message.
TOTAL Total number of lines of queried results. A decimal integer.
FINISHED Whether the operation is complete. z 0: no
z 1: yes
START Start line number in the current batch. A decimal integer.
ROWNUM Number of records in the current batch. A decimal integer.

5-34 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 5 Interfaces for CDMA Service

Parameter Description Value Range


ATTR List of query attribute names that are separated The value must be the
by the & symbol. following string:
Including the following parameters: LASTDEDUCTTIME &
z LASTDEDUCTTIME: Last time the basic fee ACCUTIME &
is deducted (time a service is enabled for a ACCUFLOW
user. If 19700101000000 is returned, it
indicates that the service is not enabled.)
z ACCUTIME: accumulative duration, in
seconds. When the value is greater than 0, the
parameter is valid.
z ACCUFLOW: accumulative volume, in KB.
When the value is greater than 0, the parameter
is valid.
RESULT List of queried data.Every two lines are separated Result set returned by
by the & symbol, and every two parameters are the operation command
separated by the | symbol. according to the actual
situation.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for CDMA users to
query for the start time and accumulative service usage of a service.
z Command
ACK:QUERY C270 USAGE: RETN=0, DESC="Querying for the service start time and
accumulative service usage succeeded.", TOTAL=1, FINISHED=1, START=0, ROWNUM=1,
ATTR= LASTDEDUCTTIME & ACCUTIME & ACCUFLOW, RESULT="20071101000000|32600|0|",;

Issue 04 (2007-12-29) Huawei Technologies Proprietary 5-35


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

6 MML Interfaces for WCDMA Service

About This Chapter

The following table lists the contents of this chapter.

Section Describes

6.1 Introduction The functions of the MML interfaces in the WCDMA service.
6.2 MML Commands The commands MML relevant to the WCDMA service.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-1


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

6.1 Introduction
The MML interfaces of the infoX-AAA supports the WCDMA service. Through the MML
interfaces, you can add and delete a WCDMA user, and modify and query the user
information in the billing system.
In the MML commands of the WCDMA service, the value of Service name of all the MML
commands are C260.

The acknowledgement (ACK) command is used for the infoX-AAA to respond to the running of an
MML command. For example, the ACK command of adding a WCDMA user is the response of the
command for adding a WCDMA user to the infoX-AAA.

6.2 MML Commands


6.2.1 Command for Adding a WCDMA User
Command
ADD C260 ACCOUNT

Function
The command is used to add a WCDMA user.

Parameter Description
Table 6-1 lists the parameters of the command for adding a WCDMA user.

Table 6-1 Parameters of the command for adding a WCDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNA Login name of the Yes No A string of 1 to 20 bytes,


ME WCDMA user. consisting of letters,
numerals, periods, minus
signs, and underscores.
DOMAIN Domain that a Yes No A string of 1 to 40 bytes,
WCDMA user consisting of letters,
belongs to. numerals, periods, and
minus signs.
USERGRO ID of the group No No A decimal integer that is
UPID that the WCDMA greater than 0.
user belongs to.

6-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

PAIDTYPE Payment type that No No z 1: postpaid


the WCDMA user z 2: prepaid
selects.
USERTYP User type. Yes No z 1: local network
E NOTE z 2: intelligent network
The parameter is
mandatory when
the payment type
is prepaid.

CHARGEA Amount to be Yes No The value 0 or a positive


MOUNT recharged. decimal integer that is up
NOTE to 49999.
The value can be
entered when the
user is a prepaid
user.

APNNAM APN name. Yes No A string of 1 to 64 bytes.


E The value of this
parameter can contain
non-reserved characters.
PSWD Login password. Yes No A string of 1 to 16 bytes.
MSID Mobile phone Yes No A numeric string of 1 to 20
number. bytes.
NOTE
The parameter is
mandatory when
the user is a
prepaid user.
IPADDRE Static IP address Yes No A decimal integer.
SS of a WCDMA
user.
The value must be
converted into a
decimal integer.
IPMASK Subnet mask of an Yes No A decimal integer.
IP address.
The value must be
converted into a
decimal integer.
IPPOOLID ID of the IP Yes No A decimal integer that is
address pool. equal to –1 or greater than
0.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-3


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

MAXUSE Maximum number Yes No A decimal integer.


RNUMBE of concurrent The value 0 indicates that
R users who can use the number of concurrent
one card at the users is not limited.
same time.
NOTE
The value can only
be 1 when the user
is prepaid.

TEMPLAT Template ID. Yes No A decimal integer that is


EID greater than 0.
The default value is –1.
IMSI IMSI number of a Yes No A string of 0 to 20 bytes.
mobile phone. The value of this
parameter can contain
non-reserved characters.
RESETINT Interval for Yes No A decimal integer.
ERVAL automatic
resetting after the
account of a
WCDMA user is
locked, in days.

Instance
The following is an instance of running the command for adding a WCDMA user.
z Scenario
− The LOGINNAME parameter is sun.
− The USERGROUPID parameter is 12.
− The PAIDTYPE parameter is 2. The USERTYPE parameter is 1.
− The CHARGEAMOUNT parameter is 5000.
− The PSWD parameter is 123456.
− The DOMAIN parameter is usr-psw-callnum.
− The TEMPLATEID parameter is 1.
− The IPADDRESS parameter is 16843009. The IP address is 1.1.1.1 in the dotted
format.
− The IPMASK parameter –256. The IP address is 255.255.255.0 in the dotted format.
− The MSID parameter is 13851771249.
− The RESETINTERVAL parameter is 1 day.
− The APNNAME parameter is test-apn.
− The IMSI parameter is 111111111.

6-4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

− The MAXUSERNUMBER parameter is 1.


z Command
ADD C260
ACCOUNT:DOMAIN=usr-psw-callnum,TEMPLATEID=1,IPMASK=-256,IPADDRESS=168430090,MSI
D=13851771249,IMSI=111111111,RESETINTERVAL=1,LOGINNAME="sun",MAXUSERNUMBER=1,AP
NNAME=test-apn,PSWD="123456"

1. When you add a WCDMA user who is a prepaid user, the value of MSID cannot be omitted.
2. The IP address and subnet mask exist in the command for adding a WCDMA user must be
integers.
3. Whether to enter the values of LOGINNAME, PSWD, and MSID is subject to the value of
Authtype of a domain.
z When Authtype of a domain is 0, LOGINNAME, PSWD, and MSID can be omitted.
z When Authtype of a domain is 1, MSID cannot be omitted.
z When Authtype of a domain is 5, LOGINNAME and MSID cannot be omitted.
z When Authtype of a domain is 6, LOGINNAME and PSWD cannot be omitted.
z When Authtype of a domain is 7, LOGINNAME, PSWD, and MSID cannot be omitted.
4. The IPADDRESS, IPMASK, and IPPOOLID parameters are connected in the following manner:
z The IPADDRESS and IPMASK parameters cannot exist at the same time or must coexist.
z When IPADDRESS, IPMASK, and IPPOOLID coexist, IPADDRESS or IPPOOLID must be –1.
When IPADDRESS is –1, IPMASK must also be –1.
z If only IPADDRESS and IPMASK exist, IPADDRESS cannot be –1.
z If only IPPOOLID exists, IPPOOLID cannot be –1.

6.2.2 ACK to the Command for Adding a WCDMA User


Command
ACK:ADD C260 ACCOUNT

Function
The command is used to respond to the command for adding a WCDMA user.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-5


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description
Table 6-2 lists the parameters of the ACK command.

Table 6-2 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of the A decimal integer.


ACK command. The return codes are as follows:
z 0: Succeeded in registering the WCDMA user.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1011: Sorry, the number of users has reached the
upper-limit specified in the License. Please apply
for it again.
z 1012: Sorry. The license you want to query does
not exist.
z 1000: Sorry, The APN does not exist.
z 1005: Sorry, the IMSI must be entered.
z 1006: Sorry, password is required.
z 1007: Sorry, both password and MSID are
required.
z 1002: Sorry. The WCDMA user already exists.
z 1013: Sorry, the IP address pool does not exist.
z 1009: Sorry, the mobile phone number already
exists.
z 1100: Sorry, the license is not enough.
z 1119: Sorry, the management of user can't choose
skipping domain.
z 1020: Sorry, the domain does not exist.
z 1020: Sorry, the static IP address already exists.
z 1051: Sorry, charge amount exceeds uplimit.
z 1052: Sorry, the user group does not exist.
z 1053: Sorry, the user group does not have any
service.
z 1054: Sorry, the upper limit of the charge amount
of B card does not exist.

6-6 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description Value Range

DESC Description of the A string of 0 to 256 bytes.


return codes. z When RETN is 0, this parameter is Succeeded in
registering the WCDMA user.
z When RETN is another return code, this
parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for adding a
WCDMA user.
z Command
ACK:ADD C260 ACCOUNT: RETN=0, DESC="Succeeded in registering the WCDMA user.";

6.2.3 Command for Deleting a WCDMA User


Command
DEL C260 ACCOUNT

Function
The command is used to delete a WCDMA user.

Parameter Description
Table 6-3 lists the parameters of the command for deleting a WCDMA user.

Table 6-3 Parameters of the command for deleting a WCDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNA Login name Yes No A string of 1 to 20 bytes,


ME of a consisting of characters.
WCDMA
user (If no
domain is
applicable to
the customer,
set
LOGINNA
ME to login
name@-1).

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-7


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that Yes No A string of 1 to 40 bytes,


a WCDMA consisting of letters, numerals,
user belongs periods, and minus signs.
to.
APNNAME APN name. Yes No A string of 1 to 64 bytes.
The value of this parameter
can contain non-reserved
characters.
MSID Mobile phone Yes No A numeric string of 1 to 20
number. bytes.
IMSI IMSI number Yes No A string of 1 to 20 bytes.
of a mobile The value of this parameter
phone. can contain non-reserved
characters.
REMOVEA Whether to No No z 0: reserve the user
LL delete all information
information z 1: delete all the user
of a user. information

Instance
The following is an instance of running the command for deleting a WCDMA user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-callnum.
− Do not delete all the user information. That is, the REMOVEALL parameter is 0.
z Command
DEL C260 ACCOUNT: DOMAIN=-1,REMOVEALL=0,LOGINNAME=sun

In the command for deleting the WCDMA user, you can enter the values of LOGINNAME and
DOMAIN; or enter the value of MSID.

6.2.4 ACK to the Command for Deleting a WCDMA User


Command
ACK:DEL C260 ACCOUNT

6-8 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Function
The command is used for the infoX-AAA system to respond to the command for deleting a
WCDMA user.

Parameter Description
Table 6-4 lists the parameters of the ACK command.

Table 6-4 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of the ACK A decimal integer.


command. The return codes are as follows:
z 0: Succeeded in deregistering the WCDMA
user.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1002: Sorry, the user does not exist.
z 1001: Sorry, the user does not exist.
z 1002: Sorry, the WCDMA subscriber has
already been deregistered.
DESC Description of the return A string of 0 to 256 bytes.
codes. z When RETN is 0, this parameter is
Succeeded in deregistering the WCDMA
user.
z When RETN is another return code, this
parameter is the matching message.
TOTAL Total number of lines of A decimal integer.
queried results.
FINISHED Whether the operation is z 0: no
complete. z 1: yes
START Start line number in the A decimal integer.
current batch.
ROWNUM Number of records in the A decimal integer.
current batch.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-9


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Value Range

ATTR List of queried attribute The value must be USERNAME.


names.
Including the following
parameter:
USERNAME: name of a
user.
RESULT List of queried data. Result set returned by the operation command
Every two parameter according to the actual situation.
values are separated by
the | symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for deleting a
WCDMA user.
z Command
ACK:DEL C260 ACCOUNT: RETN=0, DESC="Succeeded in deregistering the WCDMA
user.",TOTAL=1, FINISHED=1, START=0, ROWNUM=1, ATTR=USERNAME, RESULT="sun|0|"

6.2.5 Command for Querying for the Information About a


WCDMA User
Command
QUERY C260 ACCOUNT

Function
This command is used to query for the information of a WCDMA user.

6-10 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description
Table 6-5 lists the parameters of the command for querying for the information about a
WCDMA user.

Table 6-5 Parameters of the command for querying for the user information

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAM Login name of a Yes No A string of 1 to 20


E WCDMA user (If bytes, consisting of
no domain is characters, numerals,
applicable to the periods, minus signs,
customer, set and underscores.
LOGINNAME to
login name@-1).
DOMAIN Domain that a Yes No A string of 1 to 40
WCDMA user bytes, consisting of
belongs to. letters, numerals,
periods, and minus
signs.
MSID Mobile phone Yes No A numeric string of 1
number. to 20 bytes.
IMSI IMSI number of a Yes No A string of 1 to 20
mobile phone. bytes.
The value of this
parameter can contain
non-reserved
characters.
STATUS Status of a user. Yes No z 1: normal
z 2: frozen
z 3: deregistered

Instance
The following is an instance of running the command for querying the information about a
WCDMA user.
z Scenario
− The LOGINNAME parameter is 13800000000.
− The DOMAIN parameter is nanjing.
z Command
QUERY C260 ACCOUNT:DOMAIN=nanjing,LOGINNAME=13800000000

In the command for querying for the WCDMA user information, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-11


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

6.2.6 ACK to the Command for Querying for the Information


About a WCDMA User
Command
ACK:ADD C260 ACCOUNT

Function
The command is used to respond to the command for querying for the information about a
WCDMA user.

Parameter Description
Table 6-6 lists the parameters of the ACK command.

Table 6-6 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of the ACK command. A decimal integer.


The return codes are as follows:
z 0: Succeeded in querying the
WCDMA user.
z 3: The transaction control flag is
incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to
access the data.
z 14: The database operation
failed.
z 1001: Sorry. The WCDMA user
does not exist.
DESC Description of the return codes. A string of 0 to 256 bytes.
z When RETN is 0, this
parameter is Succeeded in
querying the WCDMA user.
z When RETN is another return
code, this parameter is the
matching message.
TOTAL Total number of lines of queried A decimal integer.
results.
FINISHED Whether the operation is complete. z 0: no
z 1: yes

6-12 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description Value Range

START Start line number in the current batch. A decimal integer.


ROWNUM Number of records in the current A decimal integer.
batch.
ATTR List of query attribute names that are The fixed value is the following
separated by the & symbol. string:
The attributes names are as follows: APNNAME & LOGINNAME &
z APNNAME: name of the APN DOMAIN & MSID & IMSI &
IPADDRESS & IPMASK &
z LOGINNAME: login name of the IPPOOLID & IPPOOLNAME &
WCDMA user IPPOOLTYPE &
z DOMAIN: domain of the WCDMA MAXUSERNUMBER &
user TEMPLATEID &
z MSID: mobile phone number TEMPLATENAME &
TEMPLATETYPE &
z IMSI: IMSI number of a mobile RESETINTERVAL & STATUS
phone & LOCKFLAG & PWATTEMPT
z IP: static IP address of a WCDMA & LOCKTIME & REGTIME &
user (The value is in the DEREGTIME & AUTHTYPE &
XXX.XXX.XXX.XXX format.) USERGROUPID &
z IPMASK: subnet mask of a static GROUPNAME & PAIDTYPE &
IP address USERTYPE & NEWGROUPID
& NEWGROUPNAME &
z IPPOOLID: ID of the IP address NEWGROUPEFFECTTIME &
pool ACCOUNTLEFT &
z IPPOOLTYPE: type of the IP RESERVETOTAL
address pool (If IPPOOLID is –1,
the value is null.)
z IPPOOLNAME: name of the IP
address pool (If IPPOOLID is –1,
the value is null.)
z IPPOOLTYPE: type of the IP
address pool (If IPPOOLID is –1,
the value is null.)
z MAXUSERNUMBER: maximum
number of concurrent users
z TEMPLATEID: template ID
z TEMPLATENAME: template
name (If TemplateID is –1, the
value is null.)
z TEMPLATETYPE: template type
(If TemplateID is –1, the value is
null.)
z RESETINTERVAL STATUS: user
status
z LOCKFLAG: lock flag of a user
z PWATTEMPT: password entry
attempts
z LOCKTIME: time when an account

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-13


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Value Range


is locked because of too much
retrying (The value is in the
YYYYMMDDHHMMSS format. The
parameter is not displayed when the
value is null.)
z REGTIME: time when the account
is registered. (The value is in the
YYYYMMDDHHMMSS format.)
z DEREGTIME: time when the
account is deregistered
z AUTHTYPE: authentication type
z GROUPNAME: name of the user
group
z PAIDTYPE: payment type of the
user
z USERTYPE: user type
z NEWGROUPID: ID of the new
user group
z NEWGROUPNAME: name of the
new user group
z NEWGROUPEFFECTTIME: time
when the new user group takes
effect
z ACCOUNTLEFT: total balance
z RESERVETOTAL: total amount
reserved for all the services
RESULT List of queried data. Every two Result set returned by the
parameters are separated with the & operation command according to
symbol, and every two parameter the actual situation.
values are separated with the |
symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying a
WCDMA user.
z Command
ACK:QUERY C260 ACCOUNT:RETN=0, DESC="Succeeded in querying the WCDMA user.", TOTAL=1,
FINISHED=1, START=0, ROW
NUM=1, ATTR=APNNAME & LOGINNAME & DOMAIN & MSID & IMSI & IPADDRESS & IPMASK & IPPOOLID
& IPPOOLNAME & IPPOOLTYPE & MAXUSERNUMBER & TEMPLATEID &
TEMPLATENAME & TEMPLATETYPE & RESETINTERVAL & STATUS & LOCKFLAG & PWATTEMPT

6-14 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

& LOCKTIME & REGTIME & DEREGTIME & AUTHTYPE & USERGROUPID & GROUPNAME & PAIDTYPE
& USERTYPE & NEWGROUPID & NEWGROUPNAME & NEWGROUPEFFECTTIME
& ACCOUNTLEFT & RESERVETOTAL,
RESULT="|13800000000|nanjing|4444|465777|-1|-1|-1|||0|-1|||1|0||||2007081311013
9||0|2|34|2|1|-1||20380101000000|500000|0|";

6.2.7 Command for Modifying the Information About a WCDMA


User
Command
MOD C260 ACCOUNT

Function
This command is used to modify information about a WCDMA user.

Parameter Description
Table 6-7 lists the parameters of the command for modifying the information about a
WCDMA user.

Table 6-7 Parameters of the command for modifying the user information
Parameter Description Whether Whether Value Range
Can Be Can Be
Omitted Null

LOGINNAM Login name of No No A string of 1 to 20 bytes,


E the WCDMA consisting of characters,
user. numerals, periods, minus
NOTE signs, and underscores.
In the command,
this parameter is
used to locate
the user record
and cannot be
modified.

DOMAIN Domain that the No No A string of 1 to 40 bytes,


WCDMA user consisting of letters,
belongs to. numerals, periods, and
NOTE minus signs.
In the command,
this parameter is
used to locate
the user record
and cannot be
modified.

APNNAME APN name. Yes Yes A string of 1 to 64 bytes,


consisting of non-reserved
characters.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-15


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

MSID Mobile phone Yes Yes A numeric string of 1 to


number. 20 bytes.
IMSI IMSI number of Yes Yes A string of 1 to 20 bytes.
a mobile phone. The value of this
parameter can contain
non-reserved characters.
IPADDRESS Static IP address Yes No A decimal integer.
of a WCDMA
user.
The value must
be converted
into a decimal
integer.
IPMask Subnet mask of Yes No A decimal integer.
an IP address.
IPPoolID ID of the IP Yes No A decimal integer that is
address pool. equal to or greater than
–1.
MaxUserNum Maximum Yes No A decimal integer.
ber number of
concurrent users
who can use one
card at the same
time.
NOTE
The value can
only be 1 when
the user is
prepaid.

TemplateID Template ID. Yes No A decimal integer that is


equal to –1 or greater than
0.
STATUS Status of a user. Yes No z 0: normal.
z 1: frozen.
z 2: deregistered.
RESETINTE Interval for Yes No A decimal integer.
RVAL automatic
resetting after
the account of a
WCDMA user
is locked, in
days.

6-16 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOCKFLAG Lock flag of a Yes No A string of 1 byte.


WCDMA user.
PSWD Password of a Yes No A string of 1 to 16 bytes.
user.
NEWGROUP Yes No The value –1 or a decimal
ID of the new
ID integer that is greater than
user group.
0.
NEWEFFECT Time when the Yes No Format:
TIME new user group YYYYMMDDhhmmss
takes effect.

Instance
The following is an instance of running the command for modifying the information about a
WCDMA user.
z Scenario
Modify the user information about the WCDMA user sun.
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-callnum.
− The TEMPLATEID parameter is 1.
− The user status is normal. That is, the STATUS parameter is 0.
− The IPMASK parameter is –1.
− The IPADDRESS parameter is –1.
− The IPPOOLID parameter is 2.
− The MSID parameter is 13851771249.
− The RESETINTERVAL parameter is 1.
− The APNNAME parameter is test-apn.
− The IMSI parameter is 111111111.
− The MAXUSERNUMBER parameter is 5.
− The NEWGROUPID parameter is 25.
− The NEWEFFECTTIME parameter is 20080808000000.
z Command
MOD C260 ACCOUNT: DOMAIN=usr-psw-callnum, TEMPLATEID=1, STATUS=0, IPMASK=-1,
IPPOOLID=2, IPADDRESS=-1, MSID="13851771249", IMSI="111111111", NEWEFFECTTIM
E=20080808000000,LOGINNAME="sun", RESETINTERVAL=1, MAXUSERNUMBER=5,
NEWGROUPID=25,APNNAME="test-apn";

In the command for modifying the WCDMA user information, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-17


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

6.2.8 ACK to the Command for Modifying the Information About


a WCDMA User
Command
ACK:MOD C260 ACCOUNT

Function
The command is used to respond to the command for modifying the information about a
WCDMA user.

6-18 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description
Table 6-8 lists the parameters of the ACK command.

Table 6-8 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of the A decimal integer.


ACK command. The return codes are as follows:
z 0: Succeeded in modifying the WCDMA user.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1000: Sorry, the proper APN does not exist.
z 1001: Sorry. The WCDMA user does not exist.
z 1004: Sorry, the mobile phone number already
exists.
z 1004: Sorry, no matching WCDMA user exists.
z 1005: Sorry, IMSI is required.
z 1013: Sorry, the IP address pool does not exist.
z 1020: Sorry, the WCDMA user isn't locked.
z 1020: Sorry, the domain does not exist.
z 1020: Sorry, the static IP address already exists.
z 1080: Parameter MAXUSERNUMBER incorrect.
z 1119: Sorry, the management of user can't choose
skipping domain.
z 1055: Sorry, the new group information has not
been updated, so you cannot modify user group
information.
z 1055: Sorry, the new user group could not be the
same as the original user group.
z 1056: Sorry, the new user group does not exist.
z 1057: Sorry, the service of new user group does
not exist.
DESC Description of the A string of 0 to 256 bytes.
return codes. z When RETN is 0, this parameter is Succeeded in
modifying the WCDMA user.
z When RETN is another return code, this
parameter is the matching message.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-19


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
modify the information about a WCDMA user.
z Command
ACK:MOD C260 ACCOUNT:RETN=0,DESC="Succeeded in modifying the WCDMA user.";

6.2.9 Command for Adding WCDMA Users in Batches


Command
ADD C260 BATCHACCOUNT

Function
This command is used to add WCDMA users in batches.

Parameter Description
Table 6-9 lists the parameters of the command for adding WCDMA users in batches.

Table 6-9 Parameters of the command for adding WCDMA users in batches

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that Yes No A string of 1 to 40


a WCDMA bytes.
user belongs
to.
APNNAME APN name. Yes No A string of 1 to 64
bytes, consisting of
non-reserved
characters.
STARTMSID Start mobile No No A string of 1 to 20
phone bytes.
number of a
batch.
ENDMSID End mobile No No A string of 1 to 20
phone bytes.
number of a
batch.

6-20 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERGROUPID ID of the No No A decimal integer that


group that is greater than 0.
the WCDMA
user belongs
to.
PAIDTYPE Payment type No No z 1: postpaid
that the z 2: prepaid
WCDMA
user selects.
USERTYPE Type of the Yes No z 1: local network
prepaid user. z 2: IN

Instance
The following is an instance of running the command for adding WCDMA users in batches.
z Scenario
− The USERGROUPID parameter is 5.
− The PAIDTYPE parameter is 2. The USERTYPE parameter is 1.
− The STARTMSID parameter is 13800000000.
− The ENDMSID parameter is 13800009999.
− The DOMAIN parameter is usr-psw-callnum.
− The APNNAME parameter is test-apn.
z Command
ADD C260 BATCHACCOUNT: STARTMSID="13800000000", DOMAIN="usr-psw-callnum",
PAIDTYPE=2, USERTYPE=1,USERGROUPID=5, ENDMSID="13800009999", APNNAME=test-apn

6.2.10 ACK to the Command for Adding WCDMA Users in


Batches
Command
ACK:ADD C260 BATCHACCOUNT

Function
This command is used to respond to the command for adding WCDMA users in batches.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-21


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description
Table 6-10 lists the parameters of the ACK command.

Table 6-10 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of A decimal integer.


the ACK The return codes are as follows:
command.
z 0: Adding batch account succeeded.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The SMP database operation failed.
z 1000: Sorry, the proper APN does not exist.
z 1010: Querying license's authorization and current
useable information failed.
z 1012: Sorry. The license you want to query does not
exist.
z 1100: Sorry, the license is not enough.
z 1052: Sorry, the user group does not exist.
z 1053: Sorry, the user group does not have any service.
DESC Description of A string of 0 to 256 bytes.
the error cause. z When RETN is 0, this parameter is Adding batch
account succeeded.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for adding
WCDMA users in batches.
z Command
ADD C260 BATCHACCOUNT:RETN=0, DESC="Adding batch account succeeded.";

6.2.11 Command for Deleting WCDMA Users in Batches


Command
DEL C260 BATCHACCOUNT

6-22 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Function
This command is used to delete WCDMA users in batches.

Parameter Description
Table 6-11 lists the parameters of the command for deleting WCDMA users in batches.

Table 6-11 Parameters of the command for deleting WCDMA users in batches

Parameter Description Whether Whether Can Value Range


Can Be Be Null
Omitted

STARTMSID Start mobile No No A string of 1 to 20


phone bytes.
number of a
batch.
ENDMSID End mobile No No A string of 1 to 20
phone bytes.
number of a
batch.

Instance
The following is an instance of running the command for deleting WCDMA users in batches.
z Scenario
− The start mobile phone number is 13800000000.
− The end mobile phone number is 13800009999.
z Command
DEL C260 BATCHACCOUNT:STARTMSID=13800000000,ENDMSID=13800009999;

6.2.12 ACK to the Command for Deleting WCDMA Users in


Batches
Command
ACK: DEL C260 BATCHACCOUNT

Function
This command is used to respond to the command for deleting WCDMA users in batches.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-23


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description
Table 6-12 lists the parameters of the ACK command.

Table 6-12 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of the ACK A decimal integer.


command. The return codes are as follows:
z 0: Deleting batch subscribers
succeeded.
z 3: The transaction control flag is
incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the
data.
z 14: The database operation failed.
z 1019: Sorry, the wcdma account you
want to delete does not exist.
DESC Description of the return codes. A string of 0 to 256 bytes.
z When RETN is 0, this parameter is
Deleting batch account succeeded.
z When RETN is another return code,
this parameter is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for deleting
WCDMA users in batches.
z Command
DEL C260 BATCHACCOUNT: RETN=0, DESC="Deleting batch account succeeded.";

6.2.13 Command for Resetting a WCDMA User


Command
RESET C260 USERCON

Function
This command is used to reset a WCDMA user.

6-24 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description
Table 6-13 lists the parameters of the command for resetting a WCDMA user.

Table 6-13 Parameters of the command for resetting a WCDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a Yes No A string of 1 to 20


WCDMA user. bytes, consisting of
characters, numerals,
periods, minus signs,
and underscores.
DOMAIN Domain that a Yes No A string of 1 to 40
WCDMA user bytes, consisting of
belongs to. letters, numerals,
periods, and
subtraction signs.
MSID Mobile phone Yes No A numeric string of 1
number. to 20 bytes.

Instance
The following is an instance of running the command for resetting a WCDMA user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-callnum.
− The MSID parameter is 13851771249.
z Command
RESET C260 USERCON: LOGINNAME=sun, DOMAIN=usr-psw-callnum, MSID=13851771249;

In the command for changing the password of the WCDMA user, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

6.2.14 ACK to the Command for Resetting a WCDMA User


Command
ACK: RESET C260 USERCON

Function
This command is used to respond to the command for resetting a WCDMA user.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-25


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description
Table 6-14 lists the parameters of the ACK command.

Table 6-14 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of the A decimal integer.


ACK command. The return codes are as follows:
z 0: Succeed in resetting the concurrent number of
account.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1001: Sorry. The WCDMA user does not exist.
DESC Description of the A string of 0 to 256 bytes.
return codes. z When RETN is 0, the parameter is Succeed in
resetting the concurrent number of account.
z When RETN is another return code, this parameter
is the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for resetting a
WCDMA user.
z Command
RESET C260 USERCON: RETN=0, DESC="Succeed in resetting the concurrent number of
account.";

6.2.15 Command for Changing the Password of a WCDMA User


Command
MOD C260 ACCOUNT

Function
This command is used to change the password of a WCDMA user.

6-26 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description
Table 6-15 lists the parameters of the command for changing the password of a WCDMA
user.

Table 6-15 Parameters of the command for changing the password of a WCDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that the Yes No A string of 1 to 40 bytes,


WCDMA user consisting of letters,
belongs to. numerals, periods, and
minus signs.
LOGINNAME Login name of Yes No A string of 1 to 20 bytes,
the WCDMA consisting of letters,
user. numerals, periods, minus
signs, and underscores.
MSID Mobile phone Yes No A numeric string of 1 to 20
number. bytes.
PSWD New password. Yes No A string of 1 to 16 bytes,
consisting of letters,
numerals, periods, minus
signs, and underscores.

Instance
The following is an instance of running the command for changing the password of a
WCDMA user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is test-usr-psw-msid.
− The PSWD parameter is 000000.
z Command
MOD C260 ACCOUNT: DOMAIN=test-usr-psw-msid, LOGINNAME=sun, PSWD=000000

In the command for changing the password of the WCDMA user, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

6.2.16 ACK to the Command for Changing the Password of a


WCDMA User
Command
ACK: MOD C260 ACCOUNT

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-27


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Function
The command is used to respond to the command for changing the password of a WCDMA
user.

Parameter Description
Table 6-16 lists the parameters of the ACK command.

Table 6-16 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of A decimal integer.


the ACK The return codes are as follows:
command.
z 0: Modifying password succeeded.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1001: Sorry, the WCDMA user does not exist.
z 1020: Sorry, the domain does not exist.
z 1004:Sorry, the subscriber cannot change the
password.
DESC Description of the A string of 0 to 256 bytes.
return codes. z When RETN is 0, this parameter is Modifying
password succeeded.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
change the password of a WCDMA user.
z Command
ACK: MOD C260 ACCOUNT:RETN=0,DESC="Modifying password succeeded.";

6.2.17 Command for Unlocking a WCDMA User


Command
MOD C260 ACCOUNT

6-28 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Function
The command is used to unlock a WCDMA user.

Parameter Description
Table 6-17 lists the parameters of the command for unlocking a WCDMA user.

Table 6-17 Parameters of the command for unlocking a WCDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that the Yes No A string of 1 to 40


WCDMA user bytes, consisting of
belongs to. letters, numerals,
periods, and minus
signs.
LOGINNAME Login name of Yes No A string of 1 to 20
the WCDMA bytes, consisting of
user. letters, numerals,
periods, minus signs,
and underscores.
MSID Mobile phone Yes No A numeric string of 1 to
number. 20 bytes.
LOCKFLAG Lock flag of the Yes No 0: available
user.

Instance
The following is an instance of running the command for unlocking the WCDMA user.
z Scenario
− The LOGINNAME parameter is sun.
− The LOCKFLAG parameter is 0.
− The DOMAIN parameter is test-usr-psw-msid.
z Command
MOD C260 ACCOUNT:LOCKFLAG=0,DOMAIN="test-usr-psw-msid ",LOGINNAME="sun"

In the command for unlocking the WCDMA user, you can enter the values of LOGINNAME and
DOMAIN; or enter the value of MSID.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-29


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

6.2.18 ACK to the Command for Unlocking a WCDMA User


Command
ACK: MOD C260 ACCOUNT

Function
The command is used to respond to the command for unlocking a WCDMA user.

Parameter Description
Table 6-18 lists the parameters of the ACK command.

Table 6-18 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of A decimal integer.


the ACK The return codes are as follows:
command.
z 0: Succeeded in unlocking the WCDMA user.
z 3: The transaction control flag is incorrect.
z 7: System internal error.
z 8: Invalid parameter.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1001: Sorry, the WCDMA user does not exist.
z 1020: Sorry, the WCDMA user is not locked.
DESC Description of the A string of 0 to 256 bytes.
return codes. z When the value of RETN is 0, the value of this
parameter is Succeeded in unlocking the WCDMA
user.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for unlocking the
WCDMA user.
z Command
ACK: MOD C260 ACCOUNT:RETN=0,DESC="Succeeded in unlocking the WCDMA user.";

6-30 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

6.2.19 Command for Recharging a Prepaid WCDMA Account


Command
CHARGE C260 ACCOUNT

Function
This command is used to recharge a prepaid WCDMA account.

Parameter Description
Table 6-19 lists the parameters of the command for recharging a prepaid WCDMA account.

Table 6-19 Parameters of the command for recharging a prepaid WCDMA account

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that Yes No A string of 1 to 40 bytes,


the WCDMA consisting of letters.
user belongs
to.
LOGINNAME Login name of Yes No A string of 1 to 20 bytes,
the WCDMA consisting of letters,
user. numerals, periods, minus
signs, and underscores.
MSID Mobile phone Yes No A numeric string of 1 to
number. 20 bytes.
CHGVAL Amount to be No No From one to the maximum
recharged. balance of a prepaid
account.

Instance
The following is an instance of running the command for recharging a prepaid WCDMA
account.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is test-usr-psw-msid.
− The CHGVAL parameter is 5000.
z Command
CHARGE C260 ACCOUNT: LOGINNAME="sun", DOMAIN="test-usr-psw-msid", CHGVAL=5000

In the command for recharging the prepaid WCDMA account, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-31


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

6.2.20 ACK to the Command for Recharging a Prepaid WCDMA


Account
Command
ACK: CHARGE C260 ACCOUNT

Function
This command is used to respond to the command for recharging a prepaid WCDMA account.

Parameter Description
Table 6-20 lists the parameters of the ACK command.

Table 6-20 Parameters of the ACK command


Parameter Description Value Range

RETN Return codes of A decimal integer.


the ACK The return codes are as follows:
command.
z 0: Cash recharge succeeded.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1001: Sorry, the WCDMA user does not exist.
z 1282: The user is to be deleted, and can't be
recharged.
z 1283: The user has been suspended, and can't be
recharged.
z 1284: The postpaid user can't be recharged.
z 1285: Sorry, the roam prepaid user cannot be
recharged.
z 1286: UppLimitB does not exist.
z 1287: The amount of the account overflow after the
account is recharged.
z 1288: The amount of the account exceeds the upper
limit after the account is recharged.
DESC Description of the A string of 0 to 256 bytes.
return codes. z When RETN is 0, this parameter is Cash
recharging succeeded.
z When RETN is another return code, this parameter is
the matching message.

6-32 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for recharging a
prepaid WCDMA account.
z Command
ACK: CHARGE C260 ACCOUNT:RETN=0, DESC="Cash recharge succeeded.";

6.2.21 Command for Ordering a Service for a WCDMA User


Command
ADD C260 ORDER

Function
The command is used to order a service for a WCDMA user.

Parameter Description
Table 6-21 lists the parameters of the command for ordering a service for a WCDMA user.

Table 6-21 Parameters of the command for ordering a service for a WCDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that Yes No A string of 1 to 40 bytes,


the WCDMA consisting of letters.
user belongs
to.
LOGINNAME Login name Yes No A string of 1 to 20 bytes,
of the consisting of letters.
WCDMA
user.
MSID Mobile phone Yes No A numeric string of 1 to 20
number. bytes.
SERVICEID Service ID. No No A decimal integer that is
greater than 0.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-33


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for ordering a service for the WCDMA
user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is nanjing.
− The SERVICEID parameter is 2.
z Command
ADD C260 ORDER:DOMAIN="nanjing",SERVICEID="2",LOGINNAME="sun"

In the command for ordering a service for the WCDMA user, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

6.2.22 ACK to the Command for Ordering a Service for a


WCDMA User
Command
ACK: ADD C260 ORDER

Function
The command is used to respond to the command for ordering a service for a WCDMA user.

6-34 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description
Table 6-22 lists the parameters of the ACK command.

Table 6-22 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of A decimal integer.


the ACK The return codes are as follows:
command.
z 0: Add order service success.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: The operation timed out.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1281: Sorry, the abnormal user can not charge order.
z 1282: Sorry, the user who is not prepaid can not
charge order.
z 1283: Sorry, the account does not exist.
z 1284: Sorry, the service is not the usergroup-service.
z 1285: Sorry, the service has been ordered.
DESC Description of the A string of 0 to 256 bytes.
return codes. z When RETN is 0, this parameter is Add order
service success.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
order a service for the WCDMA user.
z Command
ACK: ADD C260 ORDER:RETN=0,DESC="Add order service success.";

6.2.23 Command for Canceling the Order of a WCDMA User


Command
DEL C260 ORDER

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-35


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Function
The command is used to cancel the order of a WCDMA user.

Parameter Description
Table 6-23 lists the parameters of the command for canceling the order of a WCDMA user.

Table 6-23 Parameters of the command for canceling the order of a WCDMA user

Parameter Description Whether Whethe Value Range


Can Be r Can
Omitted Be Null

DOMAIN Domain that the Yes No A string of 1 to 40 bytes,


WCDMA user consisting of letters,
belongs to. numerals, periods, and
minus signs.
LOGINNAME Login name of Yes No A string of 1 to 20 bytes,
the WCDMA consisting of letters,
user. numerals, periods, minus
signs, and underscores.
MSID Mobile phone Yes No A numeric string of 1 to 20
number. bytes.
SERVICEID Service ID. No No A decimal integer that is
greater than 0.

Instance
The following is an instance of running the command for canceling the order of the WCDMA
user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is nanjing.
− The SERVICEID parameter is 2.
z Command
DEL C260 ORDER:DOMAIN="nanjing",SERVICEID=2,LOGINNAME="sun"

In the command for canceling the order of the WCDMA user, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

6.2.24 ACK to the Command for Canceling the Order of a


WCDMA User
Command
ACK: DEL C260 ORDER

6-36 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Function
The command is used to respond to the command for canceling the order of a WCDMA user.

Parameter Description
Table 6-24 lists the parameters of the ACK command.

Table 6-24 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes A decimal integer.


of the ACK The return codes are as follows:
command.
z 0: Canceling the order succeeded.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The SMP database operation failed.
z 1281: Sorry, the abnormal user can not charge order.
z 1282: Sorry, the user who is not prepaid can not charge
order.
z 1283: Sorry, the account does not exist.
z 1285: Sorry, the user have not order this service.
DESC Description of A string of 0 to 256 bytes.
the return z When RETN is 0, this parameter is Canceling the order
codes. succeeded.
z When RETN is another return code, this parameter is the
matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
cancel the order of the WCDMA user.
z Command
ACK: DEL C260 ORDER:RETN=0,DESC="Canceling the order succeeded";

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-37


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

6.2.25 Command for Querying for the Bills of a WCDMA User


Command
QUERY C260 BILL

Function
This command is used to query for the bills of a WCDMA user.

Parameter Description
Table 6-25 lists the parameters of the command for querying for the bills of a WCDMA user.

Table 6-25 Parameters of the command for querying for the bills of a WCDMA user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Domain that the Yes No A string of 1 to 40 bytes,


WCDMA user consisting of letters.
belongs to.
LOGINNAME Login name of Yes No A string of 1 to 20 bytes,
the WCDMA consisting of letters.
user.
Mobile phone A numeric string of 1 to
MSID Yes No
number. 20 bytes.
BILLTIME Time when the No No Format:
bill is generated. YYYYMMDDhhmmss

Instance
The following is an instance of running the command for querying for the bills of a WCDMA
user.
z Scenario
− The LOGINNAME parameter is 13800000000.
− The DOMAIN parameter is nanjing.
− The BILLTIME parameter is 20070801000000.
z Command
QUERY C260 BILL:BILLTIME="20070801000000", DOMAIN="nanjing",
LOGINNAME="13800000000"

In the command for querying for the bills of a WCDMA account, you can enter the values of
LOGINNAME and DOMAIN; or enter the value of MSID.

6-38 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

6.2.26 ACK to the Command for Querying for the Bills of a


WCDMA User
Command
ACK: QUERY C260 BILL

Function
This command is used to respond to the command for querying for the bills of a WCDMA
user.

Parameter Description
Table 6-26 lists the parameters of the ACK command.

Table 6-26 Parameters of the ACK command

Parameter Description Value Range

RETN Return codes of the ACK command. A decimal integer.


The return codes are as follows:
z 0: Querying the bill succeeded.
z 3: The transaction control flag
is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to
access the data.
z 14: The database operation
failed.
z 1001: Sorry, the WCDMA user
does not exist.
z 1290: The postpaid subscribe
cannot query bill.
z 1292: Sorry, the bill does not
exist.
DESC Description of the return codes. A string of 0 to 256 bytes.
z When RETN is 0, this
parameter is Querying the bill
succeeded.
z When RETN is another return
code, this parameter is the
matching message.
TOTAL Total number of lines of the query A decimal integer.
results.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-39


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Value Range

FINISHED Flag that shows whether the operation is z 0: incomplete


complete. z 1: complete
START Start line number of the current batch. A decimal integer.
ROWNUM Number of record s in the current batch. A decimal integer.

6-40 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Parameter Description Value Range

ATTR List of query attribute names that are The value must be the following
separated by the & symbol. string:
The attribute names are as follows: STREAMNUMBER &
z STREAMNUMBER: stream number ACCOUNTREASON &
USERNAME & DOMAIN &
z ACCOUNTREASON: reason for USERTYPE & APNNAME &
accounting USERIP & IMSI &
z USERNAME: login name CALLINGST
z DOMAIN: domain name ATIONID & SESSIONID &
z USERTYPE: user type CHARGEID & PDPTYPE &
SERVICESTARTTIME &
z APNNAME: APN that a user belongs STARTTIME & ENDTIME &
to TIMELENGTH &
z USERIP: user's IP address CHARGEVOLUMN & FEE &
z IMSI: IMSI number of the user's GROUPID & SERVICEID &
mobile phone SERVICENAME & SGSNIP &
GGSNIP & RATINGGROUP &
z CALLINGSTATIONID: calling TERMCAUSE
number
z SESSIONID: session ID
z CHARGEID: ID of the charge policy
z PDPTYPE: Packet Data Protocol
(PDP) type
z SERVICESTARTTIME: online
duration
z STARTTIME: time when the previous
accounting request is sent
z ENDTIME: current request time
z TIMELENGTH: Charging duration
z CHARGEVOLUMN: charging volume
z FEE: fee for the Internet access
z GROUPID: ID of the user group
z SERVICEID: service ID
z SERVICENAME: service name
z SGSNIP: IP address of the serving
GPRS support node (SGSN)
z GGSNIP: IP address of the gateway
GPRS support node (GGSN)
z RATINGGROUP: flag of the rating
group
z TERMCAUSE: reason why the session
terminates
z MSID: mobile phone number
z USERNAME: User's login name
z DOMAIN: home domain of the user
z USERIP: user's IP address
z CORRELATIONID: ID of the
accounting session
Issue 04 (2007-12-29) z ACCOUNTREASON:
Huawei Technologiesaccounting
Proprietary 6-41
reason
z SERVICENAME: service name
z STARTTIME: start time of the
infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Value Range


z SERVICESTARTTIME: online
duration
z ENDTIME: end time of the charging
z SESSIONTIME: session duration
z SESSIONVOLUME: session volume
z RATEPOLICYIDX: charge policy
z FEE: fee for Internet access this time
z USERGROUPID: ID of the user group
z SERVICEID: service ID
RESULT List of the queried data. Every two Result set returned by the
parameters are separated with the & operation command based on the
symbol, and every two parameter values actual situation.
are separated with the | symbol.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying for the
bills of the WCDMA user.
z Command
ACK: QUERY C260 BILL:RETN=0, DESC="Querying the bill succeeded.", TOTAL=3,
FINISHED=1, START=0, ROWNUM=3, ATTR=STREAMNUMBER & ACCOUNTREASON & USERNAME & DOMAIN
& USERTYPE & APNNAME & USERIP & IMSI & CALLINGSTATIONID & SESSIONID & CHARGEID &
PDPTYPE & SERVICESTARTTIME & STARTTIME & ENDTIME & TIMELENGTH & CHARGEVOLUMN & FEE
& GROUPID & SERVICEID & SERVICENAME & SGSNIP & GGSNIP & RATINGGROUP & TERMCAUSE,
RESULT="2|3|13800000000|nanjing|1||10.164.108.208|
imsi-test|13800000000|s59773:huawei|1|0|20070808093458|20070808093458|
20070813054829|418411|0|418411|2|1|FtpService|||1|-1|&3|3|13800000000|nanjing
|1||10.164.108.208|imsi-test|13800000000|s59773:huawei|1|0|20070808095603|
20070808095603|20070813060934|418411|0|418411|2|1|FtpService|||1|-1|&1|3|
13800000000|nanjing|1||10.164.108.208|imsi-test|13800000000|s59773:huawei|1|0|
20070808103244|20070808103244|20070809030857|59773|0|59773|2|1|FtpService|||1|-
1|";

6.2.27 Command for Querying for the Start Time and


Accumulative Usage of a Service
Command
QUERY C260 USAGE

6-42 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Function
The command is used for WCDMA users to query for the start time and accumulative service
usage of a service.

Parameter Description
Table 6-27 lists the parameters of the QUERY C260 USAGE command.

Table 6-27 Parameters of the QUERY C260 USAGE command


Parameter Description Whether Whet Value Range
Can Be her
Omitted Can
Be
Null
LOGINNAME Login name of a No No A string of 1 to 20 bytes.
CDMA user (If no The value can consist of
domain is letters, numerals,
applicable to the periods, minus signs,
customer, set underlines, or a
LOGINNAME to combination of the
login name@-1). preceding characters.
DOMAIN Domain that a No No A string of 1 to 40 bytes.
CDMA user The value can consist of
belongs to. letters, numerals,
periods, or minus signs,
or a combination of the
preceding characters. It
cannot start or end with a
period or minus sign.
SERVICEID ID of the service Yes No A positive integer from 1
that a CDMA user to 2147483647.
wants to query for.

Instance
The following is an instance of running the command to query for the start time and
accumulative service usage of a service.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is usr-psw-imsi.
z Command
QUERY C260 USAGE:LOGINNAME="sun",DOMAIN="usr-psw-imsi"

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-43


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

z If a user omits the service ID in the command, the user can query for the start periods and
accumulative service usage of the services in the user group that the user belongs to. Currently, one
user group can associate with only one service.
z If the user enters the ID of a service in the command, the user can query for the start time and
accumulative service usage of the service.

6.2.28 ACK to Command for Querying for the Start Time and
Accumulative Usage of a Service
Command
ACK: QUERY C260 USAGE

Function
The command is used to respond to the command for WCDMA users to query for the start
time and accumulative service usage of a service.

Parameter Description
Table 6-28 lists the parameters of the ACK command.

6-44 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service

Table 6-28 Parameters of the ACK command


Parameter Description Value Range
RETN Returned value of the ACK command. A decimal integer.
z 0: Querying for the
service start time and
accumulative service
usage succeeded.
z 3: The transaction
control flag is
incorrect.
z 7: Internal error.
z 8: The parameter is
incorrect.
z 11: The operation
timed out.
z 12: You are
unauthorized to access
the data.
z 14: The database
operation failed.
z 1294: Sorry, only a
prepaid user can query
for the service usage.
z 1295: Sorry, the
service subscribed by
the subscriber does not
exist.
DESC Cause of the error. A string of 0 to 256
bytes.
z When RETN is 0, this
parameter is Querying
for the service start
time and
accumulative service
usage succeeded.
z When RETN is
another return code,
this parameter is the
matching message.
TOTAL Total number of lines of queried results. A decimal integer.
FINISHED Whether the operation is complete. z 0: no
z 1: yes
START Start line number in the current batch. A decimal integer.
ROWNUM Number of records in the current batch. A decimal integer.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 6-45


infoX-AAA
6 MML Interfaces for WCDMA Service Interface Developer Guide - MML

Parameter Description Value Range


ATTR List of query attribute names that are separated The value must be the
by the & symbol. following string:
Including the following parameters: LASTDEDUCTTIME &
z LASTDEDUCTTIME: Last time the basic fee ACCUTIME &
is deducted (time a service is enabled for a ACCUFLOW
user. If 19700101000000 is returned, it
indicates that the service is not enabled.)
z ACCUTIME: accumulative duration, in
seconds. When the value is greater than 0, the
parameter is valid.
z ACCUFLOW: accumulative volume, in KB.
When the value is greater than 0, the parameter
is valid.
RESULT List of queried data.Every two lines are separated Result set returned by
by the & symbol, and every two parameters are the operation command
separated by the | symbol. according to the actual
situation.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for WCDMA users
to query for the start time and accumulative service usage of a service.
z Command
ACK:QUERY C260 USAGE: RETN=0, DESC="Querying for the service start time and
accumulative service usage succeeded.", TOTAL=1, FINISHED=1, START=0, ROWNUM=1,
ATTR= LASTDEDUCTTIME & ACCUTIME & ACCUFLOW, RESULT="20071101000000|32600|0|",;

6-46 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

7 MML Interfaces for WiMAX Service

About This Chapter

The following table lists the contents of this chapter.

Section Describes

7.1 Introduction The functions of the MML interface in the WiMAX service.
7.2 MML Commands The MML commands relevant to the WiMAX service.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-1


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

7.1 Introduction
The MML interfaces of the infoX-AAA supports the WiMAX service. Through the MML
interfaces, you can add and delete a WiMAX user, and modify and query for the user
information in the billing system.
In the MML commands of the WiMAX service, the services of all the MML commands are
named C330.

The acknowledgement (ACK) command is used for the infoX-AAA to respond to the running of an
MML command. For example, the ACK command for adding a WiMAX user is the response of the
command for adding a WiMAX user to the infoX-AAA.

7.2 MML Commands


7.2.1 Command for Adding a WiMAX User
Command
ADD C330 USER

Function
This command is used to add a WiMAX user.

Parameter Description
Table 7-1 lists the parameters of the command for adding a WiMAX user.

Table 7-1 Parameters of the command for adding a WiMAX user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

USERGROUPID User group that a No No A decimal integer


WiMAX user that is greater than 0.
belongs to.
DOMAIN Home domain of No No A string of 1 to 40
a WiMAX user. bytes, consisting of
letters, numerals,
periods, or minus
signs. The string
cannot start or end
with a period or
minus sign.

7-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a Yes No A string of 1 to 20


WiMAX user. bytes, consisting of
letters, numerals,
periods, minus signs,
or underscores.
PAIDTYPE Payment type of No No z 1: postpaid
a WiMAX user. z 2: prepaid
CHARGEAMOU Amount Yes No A decimal integer
NT recharged when that is greater than 0.
a user is added.
NOTE
This parameter
must be omitted
for a postpaid
user.

PSWD Password of a Yes No A string of 1 to 16


WiMAX user. bytes, consisting of
letters, numerals,
periods, minus signs,
or underscores.
MSID ID of a mobile Yes No The value must be a
station. hexadecimal string of
12 bytes.
IPASSIGNWAY Mode of No No z 0: not assign
assigning the IP z 1: static IP address
address
z 2: dynamic IP
address
IPADDRESS IP address that is Yes No A decimal integer.
assigned
statically to the
WiMAX user.
IPMASK Subnet mask of Yes No A decimal integer.
the IP address.
IPPOOLID ID of an IP Yes No The numeral –1 or a
address pool. decimal integer that
is greater than 0.
TEMPLATEID Template ID of a Yes No The numeral –1 or a
WiMAX user. decimal integer that
is greater than 0.
BSID ID of the base Yes No The value must be a
station that a hexadecimal string of
user belongs to. 12 bytes.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-3


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for adding a WiMAX user.
z Scenario
− The DOMAIN parameter is test-usr-psw-msid.
− The TEMPLATEID parameter is 1.
− The mode of assigning the IP address is static. That is, the IPASSIGNWAY
parameter is 1.
− The IPADDRESS parameter is 168430090.
− The IPMASK parameter is –256.
− The BSID parameter is 111111111111
− The MSID parameter is 222222222222.
− The USERGROUPID parameter is 12.
− The LOGINNAME parameter is sun. The PSWD parameter is 123456.
− The payment type is prepaid. That is, the PAIDTYPE parameter is 2.
− The CHARGEAMOUNT parameter is 5000 cents.
z Command
ADD C330
USER:DOMAIN=test-usr-psw-msid,TEMPLATEID=1,IPASSIGNWAY=1,IPMASK=-256,BSID=11111
1111111,CHARGEAMOUNT=5000,IPADDRESS=168430090,MSID=222222222222,USERGROUPID=12,
LOGINNAME=sun,PAIDTYPE=2,PSWD=123456

1. The IP address and subnet mask in the command for adding a WiMAX user must be integers.
2. The values of LOGINNAME, PSWD, and MSID are subject to Authtype of a domain.
z When Authtype of a domain is 1, MSID cannot be omitted.
z When Authtype of a domain is 3, PSWD and MSID cannot be omitted.
z When Authtype of a domain is 5, LOGINNAME and MSID cannot be omitted.
z When Authtype of a domain is 6, LOGINNAME and PSWD cannot be omitted.
z When Authtype of a domain is 7, LOGINNAME, PSWD, and MSID cannot be omitted.
3. The parameters IPADDRESS, IPMASK, and IPPOOLID are connected in the following manner:
z When IPASSIGNWAY is 0, IPAddress, IPMASK, and IPPOOLID must be omitted.
z When IPASSIGNWAY is 1, IPADDRESS and IPMASK cannot be omitted, but IPPOOLID must
be omitted.
z When IPASSIGNWAY is 2, IPADDRESS and IPMASK must be omitted, but IPPOOLID cannot
be omitted.
4. Whether to enter the value of BSID is subject to the user group type. When the user group type is
fixed user, the value of BSID must be entered; otherwise, you need not enter the value of BSID.

7.2.2 ACK to the Command for Adding a WiMAX User


Command
ACK: ADD C330 USER

Function
The command is used to respond to the command for adding a WiMAX user.

7-4 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Parameter Description
Table 7-2 lists the parameters of the ACK command.

Table 7-2 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK command. z 0: Adding user succeeded.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1046: Sorry, the license is not enough.
z 1047: Sorry, the License which is queried does not
exist.
z 1067: Sorry, Need Skip Domain can not be used in
user management.
z 1057: Sorry, the domain does not exist.
z 1052: Sorry, the account has existed.
z 1071: Sorry, the uplimit of the charge amount of B
card does not exist.
z 1072: Sorry, charge amount exceeds uplimit.
z 1037: Sorry, the user group does not exist.
z 1069: Sorry, BSID should be input while user group
type is fixed.
z 1070: Sorry, BSID should not be input while user
group type is not fixed.
z 1066: Sorry, MSID has been used.
z 1058: Sorry, the template does not exist.
z 1055: Sorry, the IP address has been referenced.
z 1056: Sorry, the IP address pool does not exist.
DESC Description of the A string of 0 to 256 bytes.
error cause. z When RETN is 0, this parameter is Adding user
succeeded.
z When RETN is another return code, this parameter
is the matching message.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-5


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for adding a
WiMAX user.
z Command
ACK:ADD C330 USER: RETN=0, DESC="Adding user succeeded.";

7.2.3 Command for Deleting a WiMAX User


Command
DEL C330 USER

Function
This command is used to delete a WiMAX user.

Parameter Description
Table 7-3 lists the parameters of the command for deleting a WiMAX user.

Table 7-3 Parameters of the command for deleting a WiMAX user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a No No A string of 1 to 20 bytes,


WiMAX user. consisting of letters,
numerals, periods, minus
signs, or underscores.
DOMAIN Home domain No No A string of 1 to 40 bytes,
of a WiMAX consisting of letters,
user. numerals, periods, or minus
signs. The string cannot start
or end with a period or minus
sign.
REMOVEALL Whether to Yes No z 0: Reserve the user
delete all the information.
user z 1: Delete the user
information. information.

7-6 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Instance
The following is an instance of running the command for deleting a WiMAX user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is test-usr-psw-msid.
− Delete all the user information. That is, the REMOVEALL parameter is 1.
z Command
DEL C330 USER: LOGINNAME=sun, DOMAIN=test-usr-psw-msid, REMOVEALL=1;

If the command for deleting a WiMAX user does not contain REMOVEALL, REMOVEALL is 0.
That is, all the user information is reserved.

7.2.4 ACK to the Command for Deleting a WiMAX User


Command
ACK: DEL C330 USER

Function
This command is used to respond to the command for deleting a WiMAX user.

Parameter Description
Table 7-4 lists the parameters of the ACK command.

Table 7-4 Parameters of the ACK command


Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Deleting user succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1046: Sorry, the user does not exist.
z 1059: The user information has been deleted.
z 1060: Sorry, the user is being deducted, and can not
be deleted.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-7


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Parameter Description Value Range

DESC Description of the A string of 0 to 256 bytes.


error cause. z When RETN is 0, this parameter is Deleting user
succeeded.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
delete the information about a WiMAX user.
z Command
ACK:DEL C330 USER:RETN=0,DESC=" Deleting user succeeded.";

7.2.5 Command for Modifying the WiMAX User Information


Command
MOD C330 USER

Function
This command is used to modify the information about a WiMAX user.

Parameter Description
Table 7-5 lists the parameters of the command for modifying the information about a WiMAX
user.

Table 7-5 Parameters of the command for modifying the information about a WiMAX user.

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

DOMAIN Home domain No No A string of 1 to 40


of a WiMAX bytes, consisting of
user. Do not letters, numerals,
modify the periods, or minus signs.
value of this The string cannot start
parameter. or end with a period or
minus sign.

7-8 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name No No A string of 1 to 20


of a WiMAX bytes, consisting of
user. Do not letters, numerals,
modify the periods, minus signs, or
value of this underscores.
parameter.
USERGROUPID User group No No A decimal integer that is
that a greater than 0.
WiMAX user
belongs to.
Do not
modify the
value of this
parameter.
NEWUSERGRO New user Yes No The numeral –1 or a
UPID group that the decimal integer that is
user belongs greater than 0.
to.
NEWGRPEFFEC z Time when Yes No Format:
TTIME the new YYYYMMDDhhmmss
user group
takes effect.
z The value
of this
parameter
cannot be
earlier than
the current
system
time.
MSID ID of a Yes Yes The value must be a
mobile hexadecimal string of
station. 12 bytes.
IPASSIGNWAY Mode for No No z 0: not assign
assigning the z 1: static IP address
IP address.
z 2: dynamic IP address
IPADDRESS IP address Yes No A decimal integer.
that is
assigned
statically to a
WiMAX user.
IPMASK Subnet mask Yes No A decimal integer.
of the IP
address.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-9


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

IPPOOLID ID of the IP Yes No The numeral –1 or a


address pool. decimal integer that is
greater than 0.
TEMPLATEID Template ID Yes No The numeral –1 or a
of a WiMAX decimal integer that is
user. greater than 0.
BSID ID of the base Yes No The value must be a
station that a hexadecimal string of
WiMAX user 12 bytes.
belongs to.
STATUS User state. Yes No z 0: normal
z 1: suspended

Instance
The following is an instance of running the command for modifying the information about a
WiMAX user.
z Scenario
When you modify the information about a WiMAX user , the parameter values are as
follows:
− The LOGINAME parameter is sun.
− The LOGINNAME parameter is test-usr-psw-msid.
− The TEMPLATEID parameter is 1.
− The user status is normal. That is, the STATUS parameter is 0.
− The BSID parameter is 111111111111
− The MSID parameter is 222222222222.
− The USERGROUPID parameter is 12.
− The paid type is prepaid. That is, the PAIDTYPE parameter is 2.
− The IPPOOLID parameter is 1.
− The NEWUSERGROUPID parameter is 25.
− The NEWGRPEFFECTTIME parameter is 20070714000000.
z Command
MOD C330 USER:DOMAIN=test-usr-psw-msid, TEMPLATEID=1, IPASSIGNWAY=2, IPPOOLID=1,
STATUS=0, NEWUSERGROUPID=25, BSID=111111111111, NEWGRPEFFECTTIME=20070714000000,
MSID="222222222222", USERGROUPID=12, LOGINNAME=sun

7-10 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

1. The IP address and subnet mask in the command for adding a WiMAX user must be integers.
2. The values of LOGINNAME, PSWD, and MSID are subject to Authtype of a domain.
z When Authtype of a domain is 1, the MSID cannot be omitted.
z When Authtype of a domain is 3, the PSWD and MSID cannot be omitted.
z When Authtype of a domain is 5, the LOGINNAME and MSID cannot be omitted.
z When Authtype of a domain is 6, the LOGINNAME and PSWD cannot be omitted.
z When Authtype of the DOMAIN is 7, the LOGINNAME, PSWD, and MSID cannot be omitted.
3. The parameters IPADDRESS, IPMASK, and IPPOOLID are connected in the following manner:
z When IPASSIGNWAY is 0, IPAddress, IPMASK, and IPPOOLID must be omitted.
z When IPASSIGNWAY is 1, IPADDRESS and IPMASK cannot be omitted, but IPPOOLID must
be omitted.
z When IPASSIGNWAY is 2, IPADDRESS and IPMASK must be omitted, but IPPOOLID cannot
be omitted.
4. Whether to enter the value of BSID is subject to the user group type. When the user group type is
fixed user, the value of BSID must be entered; otherwise, you need not enter the value of BSID.

7.2.6 ACK to the Command for Modifying the WiMAX User


Information
Command
ACK: MOD C330 USER

Function
The command is used for the infoX-AAA system to respond to the command for modifying
the information about a WCDMA user.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-11


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Parameter Description
Table 7-6 lists the parameters of the ACK command.

Table 7-6 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Modifying user succeeded.
command.
z 0: Modifying the password succeeded.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1048: Sorry, MSID should be input.
z 1057: Sorry, the domain does not exist.
z 1046: Sorry, the user does not exist.
z 1061: Sorry, the group ID does not match original
group ID.
z 1062: Sorry, the new group information has not been
updated, so you can not modify user group
information.
z 1073: Sorry, the MSID cannot be modified when
authenticating MSID or authenticating password and
MSID.
z 1068: Sorry, new user group information does not
exist.
z 1066: Sorry, MSID has been used.
z 1058: Sorry, the template does not exist.
z 1055: Sorry, the IP address has been referenced.
z 1056: Sorry, the IP address pool does not exist.
DESC Description of the A string of 0 to 256 bytes.
error cause. z When RETN is 0, this parameter is Modifying user
succeeded.
z When RETN is another return code, this parameter is
the matching message.

7-12 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
modify the information about a WiMAX user.
z Command
ACK: MOD C330 USER: RETN=0, DESC="Modifying user succeeded.";

7.2.7 Command for Querying for the Information About a


WiMAX User
Command
QUERY C330 USER

Function
This command is used to query for the information about a WiMAX user.

Parameter Description
Table 7-7 lists the parameters of the command for querying for the information about a
WiMAX user.

Table 7-7 Parameters of the command for querying for the information about a WiMAX user
Parameter Description Whether Whether Value Range
Can Be Can Be
Omitted Null

LOGINNAME Login name of No No A string of 1 to 20


the WiMAX bytes, consisting of
user. letters, numerals,
periods, minus signs,
or underscores.
DOMAIN Home domain of No No A string of 1 to 40
the WiMAX bytes, consisting of
user. letters, numerals,
periods, or minus
signs. The string
cannot start or end
with a period or minus
sign.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-13


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for querying for the information about a
WiMAX user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is test-usr-psw-msid.
z Command
QUERY C330 USER: LOGINNAME=sun , DOMAIN= test-usr-psw-msid

7.2.8 ACK to the Command for Querying for the Information


About a WiMAX User
Command
ACK: QUERY C330 USER

Function
This command is used to respond to the command for querying for the information about a
WiMAX user.

Parameter Description
Table 7-8 lists the parameters of the ACK command.

Table 7-8 Parameters of the ACK command


Parameter Description Value Range

RETN Returned value of the ACK A decimal integer.


command. z 0: Querying user succeeded.
z 3: The transaction control flag is
incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access
the data.
z 14: The database operation failed.
z 1046: Sorry, the user does not
exist.

7-14 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Parameter Description Value Range

DESC Description of the error cause. A string of 0 to 256 bytes.


z When RETN is 0, this parameter
is Querying user succeeded.
z When RETN is another return
code, this parameter is the
matching message.
TOTAL Total number of lines of the queried A decimal integer.
results.
FINISHED Whether the operation ends. z 0: not end
z 1: end
START Start line number of the current A decimal integer.
batch.
ROWNUM Record numbers of the current batch. A decimal integer.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-15


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Parameter Description Value Range

ATTR List of query attribute names that are The value must be the following
separated by the & symbol. string:
The following parameters are LOGINNAME & DOMAIN &
included: USERGROUPID &
z LOGINNAME: login name USERGROUPNAME &
PAIDTYPE & MSID &
z DOMAIN: home domain IPASSIGNWAY & IPADDRESS &
z USERGROUPID: user group ID IPMASK & IPPOOLID &
z USERGROUPNAME: user group IPPOOLNAME & TEMPLATEID
name & TEMPLATENAME &
NEWUSERGROUPID &
z PAIDTYPE: paid type of the NEWUSERGROUPNAME &
WiMAX user NEWGRPEFFECTTIME & BSID &
z MSID: MSID of a WiMAX user STATUS
z IPASSIGNWAY: mode of
assigning the IP address
z IPADDRESS: IP address that is
assigned statically
z IPMASK: subnet mask of the IP
address
z IPPOOLID: ID of the IP address
pool
z IPPOOLNAME: name of the IP
address pool
z TEMPLATEID: template ID
z TEMPLATENAME: template
name
z NEWUSERGROUPID: new user
group ID
z NEWUSERGROUPNAME: new
user group name
z NEWGRPEFFEC TTIME: time
when the new user group takes
effect
z BSID: BSID that a user belongs to
z STATUS: status of a user

RESULT List of queried data. Every two lines Result set returned by the operation
are separated with the & symbol, and command based on the actual
every two parameters are separated situation.
with the | symbol.

7-16 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Instance
The following is an instance how to run the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
query for the information about a WiMAX user.
z Command
ACK: QUERY C330 USER: RETN=0, DESC="Modifying user succeeded.", TOTAL=1, FINISHED=1,
START=0, ROWNUM=1,ATTR =LOGINNAME & DOMAIN & USERGROUPID & USERGROUPNAME & PAIDTYPE
& MSID & IPASSIGNWAY & IPADDRESS & IPMASK & IPPOOLID & IPPOOLNAME & TEMPLATEID &
TEMPLATENAME & NEWUSERGROUPID & NEWUSERGROUPNAME & NEWGRPEFFECTTIME & BSID & STATUS,
RESULT=
"sun|-1|2|mhq_test1|1|222222222222|0|-1|-1|-1||-1||-1||20380101000000|111111111
111|0|",;

7.2.9 Command for Changing the Password of a WiMAX User


Command
MOD C330 PASSWD

Function
This command is used to change the password of a WiMAX user.

Parameter Description
Table 7-9 lists the parameters of the command for changing the password of a WiMAX user.

Table 7-9 Parameters of the command for changing the password of a WiMAX user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of No No A string of 1 to 20 bytes,


the WiMAX user. consisting of letters,
numerals, periods, minus
signs, or underscores.
DOMAIN Home domain of No No A string of 1 to 40 bytes,
the WiMAX user. consisting of letters,
numerals, periods, or
minus signs. The string
cannot start or end with a
period or minus sign.
PSWD New password. No No A string of 1 to 16 bytes,
consisting of letters,
numerals, periods, minus
signs, or underscores.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-17


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for changing the password of a WiMAX
user.
z Scenario
− The LOGINNAME parameter is sun.
− The LOGINNAME parameter is test-usr-psw-msid.
− The PSWD parameter is 000000.
z Command
MOD C330 PASSWD: DOMAIN=test-usr-psw-msid, LOGINNAME=sun, PSWD=000000

7.2.10 ACK to the Command for Changing the Password of a


WiMAX User
Command
ACK: MOD C330 PASSWD

Function
The command is used to respond to the command for changing the password of a WiMAX
user.

Parameter Description
Table 7-10 lists the parameters of the ACK command.

Table 7-10 Parameters of the ACK command


Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Modifying password succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1046: Sorry, the user does not exist.
DESC Description of the A string of 0 to 256 bytes.
error cause. z When RETN is 0, this parameter is Modifying
password succeeded.
z When RETN is another return code, this parameter is
the matching message.

7-18 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Instance
The following is an instance of running the ACK command for changing the password of a
WiMAX user.
z Scenario
The infoX-AAA responds to the successful running of the command for the operator to
change the password of a WiMAX user.
z Command
ACK:MOD C330 PASSWD:RETN=0,DESC="Modifying password succeeded.";

7.2.11 Command for Recharging a Prepaid WiMAX User


Command
CHARGE C330 ACCOUNT

Function
This command is used to recharge a prepaid WiMAX user.

Parameter Description
Table 7-11 lists the parameters of the command for recharging a prepaid WiMAX user.

Table 7-11 Parameters of the command for recharging a prepaid WiMAX user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a No No A string of 1 to 20 bytes,


WiMAX user. consisting of letters,
numerals, periods, minus
signs, or underscores.
DOMAIN Home domain of No No A string of 1 to 40 bytes,
a WiMAX user. consisting of letters,
numerals, periods, or
minus signs. The string
cannot start or end with a
period or minus sign.
CHGVAL Recharge No No From zero to the
amount, in cents. maximum balance of a
prepaid account.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-19


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Instance
The following is an instance of running the command for recharging a prepaid WiMAX user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is test-usr-psw-msid.
− The CHGVAL parameter is 5000 cents.
z Command
CHARGE C330 ACCOUNT: LOGINNAME="sun", DOMAIN="test-usr-psw-msid", CHGVAL=5000

7.2.12 ACK to the Command for Recharging a Prepaid WiMAX


User
Command
ACK: CHARGE C330 ACCOUNT

Function
This command is used to respond to the command for recharging a prepaid WiMAX user.

7-20 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Parameter Description
Table 7-12 lists the parameters of the ACK command.

Table 7-12 Parameters of the ACK command

Parameter Description Value Range

RETN Returned value of A decimal integer.


the ACK z 0: Cash recharge succeeded.
command.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the data.
z 14: The database operation failed.
z 1083: The user is to be deleted, and can't be
recharged.
z 1084: The user has been suspended, and can't be
recharged.
z 1081: The postpaid user can't be recharged.
z 1085: Sorry, the account does not exist.
z 1086: UppLimitB does not exist.
z 1087: Account left overflow after charge.
z 1088: Account left exceeds the upper limit after
charge.
DESC Description of the A string of 0 to 256 bytes.
error cause. z When RETN is 0, this parameter is Cash recharge
succeeded.
z When RETN is another return code, this parameter is
the matching message.

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for recharging a
prepaid WiMAX user.
z Command
ACK:CHARGE C330 ACCOUNT:RETN=0, DESC="Cash recharge succeeded.";

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-21


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

7.2.13 Command for Querying for the Bills of a WiMAX User


Command
QUERY C330 BILL

Function
This command is used to query for the bill of a WiMAX user.

Parameter Description
Table 7-13 lists the parameters of the command for querying for the bill of a WiMAX user.

Table 7-13 Parameters of the command for querying for the bill of a WiMAX user

Parameter Description Whether Whether Value Range


Can Be Can Be
Omitted Null

LOGINNAME Login name of a No No A string of 1 to 20 bytes,


WiMAX user. consisting of letters,
numerals, periods, minus
signs, or underscores.
DOMAIN Home domain of No No A string of 1 to 40 bytes,
a WiMAX user. consisting of letters,
numerals, periods, or
minus signs. The string
cannot start or end with a
period or minus sign.
BILLTIME Time when a bill No No Format:
is generated. YYYYMMDDhhmmss

Instance
The following is an instance of running the command for querying for the bill of a WiMAX
user.
z Scenario
− The LOGINNAME parameter is sun.
− The DOMAIN parameter is test-usr-psw-msid.
− The BILLTIME parameter is 20070601000000.
z Command
QUERY C330 BILL: BILLTIME="20070601000000", DOMAIN="test-usr-psw-msid",
LOGINNAME="sun"

7-22 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

7.2.14 ACK to the Command for Querying for the Bills of a


WiMAX User
Command
ACK: QUERY C330 BILL

Function
This command is used to respond to the command for querying for the bill of a WiMAX user.

Parameter Description
Table 7-14 lists the parameters of the ACK command.

Table 7-14 Parameters of the ACK command


Parameter Description Value Range

RETN Returned value of the ACK A decimal integer.


command. z 0: Querying the bill succeeded.
z 3: The transaction control flag is incorrect.
z 7: Internal system error.
z 8: The parameter is incorrect.
z 11: Operation timeout.
z 12: You are unauthorized to access the
data.
z 14: The database operation failed.
z 1085: Sorry, the account does not exist.
z 1082: The postpaid user cannot query bill.
z 1089: Sorry, the bill does not exist.
DESC Description of the error A string of 0 to 256 bytes.
cause. z When RETN is 0, this parameter is
Querying the bill succeeded.
z When RETN is another return code, this
parameter is the matching message.
TOTAL Total number of lines of the A decimal integer.
queried results.
FINISHED Whether the operation ends. z 0: not end
z 1: end
START Start line number of the A decimal integer.
current batch.
ROWNUM Number of the records in the A decimal integer.
current batch.

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-23


infoX-AAA
7 MML Interfaces for WiMAX Service Interface Developer Guide - MML

Parameter Description Value Range

ATTR List of query attribute names The value must be the following string:
that are separated by the & MSID & USERNAME & DOMAIN &
symbols. USERIP & CORRELATIONID &
The included parameters are ACCOUNTREASON & SERVICENAME &
as follows: SERVICESTARTTIME & STARTTIME &
z MSID: ID of the mobile ENDTIME & SESSIONTIME &
station SESSIONVOLUME & RATEPOLICYIDX
& FEE & USERGROUPID & SERVICEID
z USERNAME: user login
name
z DOMAIN: home domain
of the user
z USERIP: user IP address
z CORRELATIONID:
RADIUS session ID
z ACCOUNTREASON:
accounting reason
z SERVICENAME: service
name
z SERVICESTARTTIME:
access time
z STARTTIME: last request
time
z ENDTIME: current
request time
z SESSIONTIME: session
duration
z SESSIONVOLUME:
session volume
z RATEPOLICYIDX:
charge policy
z FEE: fee for Internet
access in this time
z USERGROUPID: user
group ID
z SERVICEID: service ID
RESULT List of queried data. Every Result set returned by the operation
two lines are separated by command based on the actual situation.
the & symbol, and every
two parameters are separated
with the | symbol.

7-24 Huawei Technologies Proprietary Issue 04 (2007-12-29)


infoX-AAA
Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service

Instance
The following is an instance of running the ACK command.
z Scenario
The infoX-AAA responds to the successful running of the command for querying for the
bill of a WiMAX user.
z Command
ACK: QUERY C330 BILL:RETN=0, DESC="Querying the bill succeeded.", TOTAL=2,
FINISHED=1, START=0, ROWNUM=2, ATTR= MSID & USERNAME & DOMAIN & USERIP & COR
RELATIONID & ACCOUNTREASON & SERVICENAME & SERVICESTARTTIME & STARTTIME & ENDTIME
& SESSIONTIME & SESSIONVOLUME & RATEPOLICYIDX & FEE & USERGROUPID & SERVICEID,
RESULT="
222222222222|sun|test-usr-psw-msid|10.10.10.1|00000021|2|month5000|200706092340
00|20070609234000|20070610001320|2000|2048000|4|2000|12|4|&222222222222|sun|tes
t-usr-psw-msid|||5|month5000|20070609234000|20070609234000|20070701000000|0|0|4
|5000|12|4|";

Issue 04 (2007-12-29) Huawei Technologies Proprietary 7-25


infoX-AAA
Interface Developer Guide - MML A Checksum’s code

A Checksum’s code

Implement ChSecksum’s code, Reference code:


/*************************************************
Function: GetChkSum
Description: A 32-bit bitwise Exclusive-OR negation value of "message header
+ session header + transaction header + operation information".
Calls:
Called By:
Input: len indicates the total length of "message header + session header
+ transaction header + operation information".
Buf indicates the string consisting of message header, session header,
transaction header, and operation information.
Output: res indicates the result of the 32-bit bitwise Exclusive-OR negation
value
Return:
Others:
*************************************************/
void GetChkSum(Int len, PSTR buf, PSTR res)
{
memset(res, 0, MSG_CHKSUM_LEN);
for(int i=0; i<len; i+=4)
{
res[0]^=(buf+i)[0];
res[1]^=(buf+i)[1];
res[2]^=(buf+i)[2];
res[3]^=(buf+i)[3];
};
res[0]=~res[0];
res[1]=~res[1];
res[2]=~res[2];
res[3]=~res[3];
};

Issue 04 (2007-12-29) Huawei Technologies Proprietary A-1


infoX-AAA
Interface Developer Guide - MML B Acronyms and Abbreviations

B Acronyms and Abbreviations

A
AAA Authentication, Authorization and Accounting
ACD Automatic Call Distributor
ADP Voice Mailbox Interface Card
API Application Program Interface
ASCII American Standard Code for Information Interchange
ASN Access Service Network
ASN-GW ASN Gateway

B
BCD Binary Coded Decimal
BOD Bandwidth On Demand
BS Base Station

C
CAD Computer Aided Design
CCP Common Communication Proxy
CCS Call Center Server
CDMA Code Division Multiple Access
CDR Call Detail Record
CHAP Challenge Handshake Authentication Protocol
CID Call Instance Data
COA Care-of-Address
COM Component Object Model

Issue 04 (2007-12-29) Huawei Technologies Proprietary B-1


infoX-AAA
Contents Interface Developer Guide - MML

COUNT Call History Parameter


CTI Server Computer & Telephony Integration Server

D
DB Database
DCOM Distributed Component Object Model
DHCP Dynamic Host Configuration Protocol
DLL Data Link Layer
DRV Dual Tone Number Receiving & Drive Board

E
EAP Extensible Authentication Protocol

FAX Facsimile
FP Fax Peripheral

G
GGSN Gateway GPRS Support Node
GSL Global Service Logic
GUI Graphic User Interface

H
HA Home Agent
HLR Home Location Register

I
ICD Intelligent Call Distribution
ID Identity
IKE Internet Key Exchange
INT Integration
INtess Intelligent Service System
IMSI International Mobile Station Identity
IP Intelligent Peripherals

B-2 Huawei Technologies Proprietary Issue 04(2007-12-29)


infoX-AAA
Interface Developer Guide - MML B Acronyms and Abbreviations

IPsec IP Security
IRC Call Routing Control
ISCC Integrated Service Control Center
ISDN Integrated Services Digital Network
ISP Internet Service Provider
IVR Interactive Voice Response

L
LAC Link Access Control

M
MAC Medium Access Control
MIP Mobile Internet Protocol
MML Man Machine Language
MS Mobile Station
MSID Mobile Station ID
MSK Master Session Key

N
NAI Network Access Identifier
NT Network Terminal

O
ODBC Open Database Connectivity
OPS Operator Service

P
PAP Password Authentication Protocol
PC Personal Computer
PCF Packet Control Function
PDSN Packet Data Serving Node
PHB Per Hop Behavior
PPP Point-to-Point Protocol

Issue 04 (2007-12-29) Huawei Technologies Proprietary B-3


infoX-AAA
Contents Interface Developer Guide - MML

Q
QoS Quality of Service

R
RADIUS Remote Authentication Dial In User Service

S
SCE Service Creation Environment
SIB Service Independent Block
SIG Signal Tone Board
SIP Simple Internet Protocol
SM Switching Module
SMP Service Management Point
SMS Service Management System
SMSC Short Message Service Center
SMTP Simple Mail Transfer Protocol
SOAP Simple Object Access Protocol
SP Service Provider
SPT Special Tone Board
SQL Structured Query Language
SSD Service Support Data
SSP Service Switching Point

T
TCP Transmission Control Protocol
TTS Text To Speech

U
UDHI User Data Head Indicator
UDP User Datagram Protocol
UL Uplink

B-4 Huawei Technologies Proprietary Issue 04(2007-12-29)


infoX-AAA
Interface Developer Guide - MML B Acronyms and Abbreviations

V
VP Voice Peripheral

W
WCDMA Wide Code Division Multiple Access
WIN Wireless Intelligent Network
WCDMA Wide Code Division Multiple Access

Issue 04 (2007-12-29) Huawei Technologies Proprietary B-5


infoX-AAA
Interface Developer Guide - MML Index

Index

broadband
B response to the command for modifying a
broadband password, 5-33
registering a broadband User, 5-4 broadband
broadband port restriction, 5-34
response to the command for registering a broadband
broadband user, 5-7 response to the command for port restriction, 5-35
broadband broadband
modifying a broadband user, 5-10 cash recharge, 5-36
broadband broadband
response to the command for modifying a response to the command for cash recharge, 5-37
broadband user, 5-13 broadband
broadband rolling back cash recharge, 5-39
deregistering a broadband user, 5-15 broadband
broadband response to the command for rolling back cash
response to the command for deregistering a recharge, 5-39
broadband User, 5-16 broadband
broadband querying recharge records, 5-40
querying a broadband user, 5-17 broadband
broadband response to the command for querying recharge
response to the command for querying broadband records, 5-42
user information, 5-18 broadband
broadband querying bills, 5-45
querying an account, 5-21 broadband
broadband response to the command for querying bills, 5-46
response to the command for querying an account, broadband
5-22 command for subscribing to broadband services,
broadband 5-49
activating an account, 5-26 broadband
broadband response to the command for subscribing to a
response to the command for activating an account, broadband service, 5-51
5-27 broadband
broadband unsubscribing a broadband service, 5-54
deactivating an account, 5-28 broadband
broadband response to the command for unsubscribing a
response to the command for deactivating an broadband service, 5-55
account, 5-29 broadband
broadband querying subscribed broadband services, 5-57
resetting an account, 5-30 broadband
broadband response to the command for querying subscribed
response to the command for resetting an account, services, 5-58
5-31
broadband
modifying a password, 5-32

Issue 04 (2007-12-29) Huawei Technologies Proprietary i-1


infoX-AAA
Index Interface Developer Guide - MML

C format of an ordinary message, 1-2


precautions about messages, 1-7
cdma
deregistering a cdma user, 6-8
O
modify the user password, 6-19
modifying a cdma subscriber, 6-14 operator
querying a cdma user, 6-11 changing password, 4-6
registering a cdma user, 6-3 login, 4-2
response to the command for deregistering a cdma logout, 4-5
user, 6-10 response to the command for changing password,
response to the command for modify the user 4-7
password on the self-service system, 6-20 response to the command for login, 4-3
response to the command for modifying response to the command for logout, 4-5
information of a cdma user, 6-16
response to the command for querying information P
of a cdma user, 6-12
response to thecommand for registering a cdma preparation before debugging, 3-2
user, 6-6
W
D wcdma
developer to the billing client deregistering a wcdma user, 7-7
development flow, 2-2 deregistering wcdma users in batches, 7-20
developer to the billing client modifying a wcdma subscriber, 7-14
overview, 2-2 querying a wcdma user, 7-10
developer to the billing client registering a wcdma user, 7-3
Instance, 2-3 registering wcdma users in batches, 7-18
response to command for modifying information
of a wcdma user, 7-16
I response to the command for deregistering a
interconnection debugging wcdma user, 7-8
debug method, 3-2 response to the command for deregistering wcdma
introduction to the mml interface, 1-2 users in batches, 7-21
introduction to the mml structure, 1-2 response to the command for querying information
of a wcdma user, 7-11
M response to the command for registering a wcdma
user, 7-5
mml interface response to the command for registering wcdma
brief introduction, 1-2 users in batches, 7-19
format of a heartbeat message, 1-6

i.

i-2 Huawei Technologies Proprietary Issue 04 (2007-12-29)