InfoX-AAA Interface Developer Guide - MML

Huawei Technologies Proprietary

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: [email protected]

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.

http://www.huawei.com/

mailto:[email protected]

infoX-AAA Interface Developer Guide - MML Contents

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

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

Contents infoX-AAA

Interface Developer Guide - MML

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

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

infoX-AAA Interface Developer Guide - MML Contents

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

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

Contents infoX-AAA


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

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

infoX-AAA Interface Developer Guide - MML Figures

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

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

infoX-AAA Interface Developer Guide - MML Tables

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

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-5 Parameters of the command for changing the operator password.....................................................3-7


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


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-7 Parameters of the command for querying the user information......................................................4-18


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-13 Parameters of the command for deactivating an account..............................................................4-29


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


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


Tables infoX-AAA


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

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-23 Parameters of the command for rolling back the cash recharge....................................................4-41


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


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


Table 4-29 Parameters for ordering a broadband service................................................................................4-51


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


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


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


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


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


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


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


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


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


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


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

infoX-AAA Interface Developer Guide - MML Tables

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


Table 5-17 Parameters of the QUERY C270 USAGE command....................................................................5-32


Table 6-1 Parameters of the command for adding a WCDMA user..................................................................6-2


Table 6-3 Parameters of the command for deleting a WCDMA user................................................................6-7


Table 6-5 Parameters of the command for querying for the user information ................................................6-11


Table 6-7 Parameters of the command for modifying the user information ...................................................6-15


Table 6-9 Parameters of the command for adding WCDMA users in batches................................................6-20


Table 6-11 Parameters of the command for deleting WCDMA users in batches ............................................6-23


Table 6-13 Parameters of the command for resetting a WCDMA user...........................................................6-25


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


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


Table 6-19 Parameters of the command for recharging a prepaid WCDMA account.....................................6-31


Table 6-21 Parameters of the command for ordering a service for a WCDMA user ......................................6-33


Table 6-23 Parameters of the command for canceling the order of a WCDMA user......................................6-36


Table 6-25 Parameters of the command for querying for the bills of a WCDMA user...................................6-38


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


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


Tables infoX-AAA


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

Table 7-3 Parameters of the command for deleting a WiMAX user .................................................................7-6


Table 7-5 Parameters of the command for modifying the information about a WiMAX user. .........................7-8


Table 7-7 Parameters of the command for querying for the information about a WiMAX user.....................7-13


Table 7-9 Parameters of the command for changing the password of a WiMAX user ...................................7-17


Table 7-11 Parameters of the command for recharging a prepaid WiMAX user ............................................7-19


Table 7-13 Parameters of the command for querying for the bill of a WiMAX user......................................7-22


infoX-AAA Interface Developer Guide - MML About This Document

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

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 Management

This chapter describes the interfaces for the operator management.

3 MML Interfaces for Broadband Service

This chapter describes the MML interfaces for the broadband service.

About This Document infoX-AAA


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

Chapter Description

4 MML Interfaces for CDMA Service

This chapter describes the MML interfaces for the CDMA service.

5 MML Interfaces for WCDMA Service

This chapter describes the MML interfaces for the WCDMA service.


This chapter describes the MML interfaces for the WiMAX 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.

infoX-AAA Interface Developer Guide - MML About This Document

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


Courier New Terminal display is in Courier New.

Command Conventions


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


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.

About This Document infoX-AAA


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

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.

infoX-AAA Interface Developer Guide - MML 1 Overview

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

1 Overview

About This Chapter

The following table lists the contents of this chapter.

Section Describes

1.1 Position of the Billing System in the Network

The position of the billing system in the network.

1.2 Format of the Message That Supports the MML Server Interface

The format of the MML Server message.

1 Overview infoX-AAA


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

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

IP Core

User

OperatorinfoX-AAA

AccessNetwork

Bill ing

ISPNetwork

Internet

Intranet

MML/Socket/TCP/IP

MML Server

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:

System management Service management User management Charging management 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.



Relation Between Billing System and MML Server The relation between the billing system and the MML Server involves the following concepts:

Connection The billing system and MML Server creates the connection and exchanges the information through TCP/IP.

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.

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.

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:

Ordinary message




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

Message header = Version number + Terminal ID + Service name Session header = Session ID + Session control word + Reserved session word Transaction header = Transaction ID + Transaction control word + Reserved transaction

word

Table 1-1 lists the fields in an ordinary message.



Table 1-1 Fields in an ordinary message

Field Description Value Range

Start flag Indicates the fixed value is \x1C\x1D\x1E\x1F.

A string of four bytes.

Size Indicates the total length of a message from the message header to the operation information.

A four-byte hexadecimal integer. Value range: 0–6500

Version number

Has a fixed value 1.00. A string of four bytes.

Terminal ID Has a fixed value internal. A string of eight bytes.

Service name

Indicates the name of a service. It is the medium part of an MML command. For example, if an MML command is ADD C280 Account, the service name is C280.

A string of eight bytes.

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

An eight-byte hexadecimal integer. Value range: An integer that is 1 or greater than 1.

Session control word

Includes the DLGLGN, 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.

A string of six bytes.

Reserved session word

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





Transaction ID

Generated by the client. If there is no concurrent operation, all transaction IDs can be 1.

If concurrent operations are required, the client must ensure that all transaction IDs of the concurrent operations are different with each other.

An eight-byte hexadecimal integer.

Transaction control word

Includes the TXBEG, TXCON, 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.

A string of six bytes.

Reserved transaction word

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

Operation information

Format: command code[:command parameter]

An MML command. 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 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.



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


Start flag Has a fixed value \x1C\x1D\x1E\x1F.


Size Indicates the total length of a message from the message header to the operation information. NOTE

The value is fixed in the heartbeat message.

A four-byte hexadecimal integer. Value range: 0–65000

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

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


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


2 Developer Guide to the Billing System

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

2 Developer Guide to the Billing System infoX-AAA



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

......

......

login

login ACK

operation1

MML ServerBill ing

operation1 ACK

operationN

operationN ACK

logout

logout ACK

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.



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.

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.

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);

}




}

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);



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;




}

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.


//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;

}

}



//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;


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)




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;


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.



The billing system sends a message to the MML Server and receives the returned result from the MML Server.


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




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:

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.

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:



The analysis of the captured packets is as follows:

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.

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.

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.

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 The command codes are incorrectly entered. The MML command does not exist in the

specified service process. The MML command is incorrect in grammar. Check the MML command.

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


3 MML Interfaces for Operator Management

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



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 Omitted

Whether Can Be Null

Value Range

USER User name for login.

No No A string of 1 to 16 bytes. The string can include characters, numerals, periods, minus signs, underscores, but the initial must be a character.

3 MML Interfaces for Operator Management infoX-AAA




Whether Can Be Null

Value Range

PSWD Password for login.

No No A string of 6 to 16 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.

Scenario − The USER parameter is billopr. − The PSWD parameter is TELLIN.

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.



Table 3-2 Parameters of the ACK command

Parameter Description Value Range

RETN Value returned by the ACK command.

Decimal integers: 0: Success. 2: The session control flag is incorrect. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 9: The command does not match. 10: Incorrect number of operations. 11: The operation timed out. 31: Reached the maximum number of users specified in the License.

1001: The operator does not exist. 1002: Incorrect password. 1003: Login ID expired. 1004: password expired. 1005: Incorrect operator state. 1006: The operator does not allow to access this time.

1007: Term not found. 1008: Term access does not allow this time. 1009: Reached the maximum number of operator logins.

1010: Authentication failed. 1102: Login Failed. The operator session count exceeds the max session number.

DESC Description of failure cause. A string of 0 to 256 bytes. When RETN is 0, this parameter is Success.

When RETN is another return code, this parameter is the matching message.





ATTR Names of attributes returned that are separated by the & symbol. The attributes are as follows:

ROLEID: role ID ROLENAME: role name CREATOR: creator of the operator

AGENTID: agent ID AGENTNAME: agent name

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.

USER: operator name LVLID: level ID SCPID: SCP ID of the matching resource manager

The character string is as follows: ROLEID & ROLENAME & CREATOR & AGENTID & AGENTNAME & SERVKEY & USER & LVLID

RESULT Queries the data list. Lines are separated by the & symbol and parameters are separated by the | symbol.

Result returned based on the actual situation.

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

Scenario

The infoX-AAA responds to the successful running of the command for logging in to the infoX-AAA.

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


Whether Can Be Null

Value Range

USER User name for login. This parameter is used when a senior operator deletes a junior operator. If this parameter is omitted, the current user is used.

Yes Yes A string of 1 to 16 bytes. The string can include characters, numerals, periods, minus signs, underscores, but the initial must be a character.


Scenario

An operator of the billing system logs out.

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.








Decimal integers: 0: Success. 2: The session control flag is incorrect. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 9: The command does not match. 10: Incorrect number of operations. 11: The operation timed out. 1001: The current operator is not authorized to quit this operator.

1002: The operator not login. 1003: The operator not found.

DESC Description of failure cause.

A string of 0 to 256 bytes. When RETN is 0, this parameter is Success. When RETN is another return code, this parameter is the matching message.


Scenario The infoX-AAA responds to the successful running of the command for logout.

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.



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


Whether Can Be Null

Value Range

OLDPSWD Current password.

No Yes A string of 6 to 16 bytes. The string can include characters, numerals, periods, minus signs, or underscores.

NEWPSWD New password.


CFMPSWD Password for confirmation.


Instance The following is an instance of running the command for changing the operator password.

Scenario − The OLDPSWD parameter is TELLIN. − The NEWPSWD parameter is 123456. − The CFMPSWD parameter is 123456.

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.








Decimal integers: 0: Modifying password succeeded. 3: The transaction control flag is incorrect. 4: The message and command are incorrect. 7: System internal error. 8: The parameter is incorrect. 9: The command does not match. 10: Incorrect number of operations. 11: The operation timed out. 13: The authentication failed. 14: Connecting database failed. 1001: Failed to get the current operator ID. 1002: The old password is incorrect.

DESC Description of failure cause.

A string of 0 to 256 bytes. When RETN is 0, the parameter is Modifying password succeeded.



Scenario

The infoX-AAA responds to the successful running of the command for changing the operator password.

Command ACK:CHG OPRM OWNPSWD:RETN=0,DESC="Modifying password succeeded."

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


4 MML Interfaces for Broadband Service

About 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

4 MML Interfaces for Broadband Service infoX-AAA



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


Whether Can Be Null

Value Range

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 and domain (If no domain is applicable to the customer, set LOGINNAME to login name@-1).

Yes No Login name: A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: A string of 1 to 40 bytes, consisting of letters, numerals, periods 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 0: ordinary user 1: enterprise user 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.




Whether Can Be Null

Value Range

USERADDRESS

Address of a user

Yes Yes A string of 0 to 100 bytes, consisting of non-reserved characters.

CONTACTMAN

Name of the contact

Yes No A string of 0 to 20 bytes, 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 payment. The default value is 1.

No No 0: bank 1: cash 2: call number

BANK Bank name. It is mandatory when the value of PAYMODE is 0.


BANKACCOUNT

Bank account. It is mandatory when the value of PAYMODE is 0.

Yes Yes A string of 0 to 30 bytes, consisting of numerals or letters.

PAYPHONE Number for payment. It is mandatory when the value of PAYMODE is 2.

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.

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.





Whether Can Be Null

Value Range

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 number


AGENTNAME Name of the agent

Yes No A string of 1 to 40 bytes.

ADMPSWD Administrative password of the account

Yes No A string of 1 to 16 bytes, consisting of letters, numerals, periods, minus signs, or underscores.

SERVICELEVEL

Service type Yes Yes 1: Postpaid (type A) 2: Rechargeable prepaid (Type B)

3: Non-rechargeable prepaid (type C)

4: Postpaid in Hotel (type D)

5: Prepaid in Hotel (type E)

6: Virtual Private Network (VPN) user (type F)

7: Roaming card 8: Calling number (type H)

9: Fixed period (type I) a: Recharge card (type K)

NOTE At present, only the types A, B, C, and K are available.

CONSUMERIGHT

Consumption right

Yes Yes 0: access and content 1: only access 2: only content




Whether Can Be Null

Value Range

USERTEMPLATE

Numbering of a user template. The default value is -1.

Yes No A decimal integer

MAXUSERNUMBER

Maximum number of concurrent users

Yes No A decimal integer

IPADDRESS IP address Yes No A decimal integer

IPMASK Subnet mask Yes No A decimal integer

IPPOOLID ID of an IP address pool

Yes No A decimal integer larger than 0 or the numeral –1.

PAYTYPE Type of the account

No No 1: postpaid 2: prepaid

LIMITFLAG Whether to restrict the port number

Yes No 0: no 1: yes

ACCOUNTNUMBER

Account of a 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.)

ACCESSPOLICYID

ID of the access policy

Yes No A positive integer or –1. The number –1 indicates the ID of the access policy is not required.

ACCESSPROFILEID

ID of the access profile. NOTE

This parameter is valid only when the broadband service is in NGN/IMS mode.

Yes No A positive integer or –1. The number –1 indicates the ID of the access profile is not required.




Instance The following is an instance of running the command for adding a broadband user.

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.

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.







RETN Returned value of the ACK command.

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






1002: The template does not exist. 1002: Sorry, the area ID does not exist. 1003: The login name already exists. 1008: LDAP failed to roll back. 1010: LDAP rollback succeeded. 1012: Invalid account. 1015: Adding LDAP data failed. 1052: Sorry, the authentication must be based on user name and password if the domain is for VPDN.

1054: The subscriber already exists in the external data.

1055: Sorry, the subscriber can be registered with local domain or VPDN domain only.

1112: Sorry, the login name cannot be the same as the calling access account.

1113: The login name is overlapped with the existing number segment.

1115: Sorry, the login name cannot be the same as the calling access number.

1125: The domain does not exist. 1125: Sorry, the accesspolicy does not exist. 1156: The IP address pool does not exist. 1157: Sorry, the static IP address already exists. 1160: The account cannot be used because it is out of the validity period.

1226: Sorry, the domain cannot be the skip domain. 7001: Entry already exists. 7002: Adding LDAP data failed. 7003: Deleting LDAP data failed. 7004: Modifying LDAP data failed. 7005: Connecting to the LDAP failed. 7006: Binding to the LDAP failed. 7007: Number of key fields is not consistent with that of field values.

DESC Error cause. A string of 0 to 256 bytes. When RETN is set to 0, this parameter is Adding user succeeded.





Scenario The infoX-AAA responds to the successful running of the command for adding a broadband user.

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


Whether Can Be Null

Value Range

LOGINNAME Login name and domain (If no domain is applicable to the customer, set LOGINNAME to login name@-1). NOTE

Type the LOGINNAME or ACCOUNTNUMBER.

Yes No Login name: A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores.

Domain: A string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. It cannot start with or end with a period or minus sign.

USERTYPE Type of a user. The current version only supports ordinary users.

Yes No 0: ordinary user 1: enterprise user 2: family user





Whether Can Be Null

Value Range

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.

USERADDRESS

Address of the contact.


CONTACTMAN

Name of the contact.

Yes No A string of 0 to 20 bytes, 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 user.

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 Payment mode. The default value is 1.

Yes No 0: bank 1: cash 2: phone

BANK Bank name. It is mandatory when the value of PAYMODE is 0.


BANKACCOUNT

Bank account. It is mandatory when the value of PAYMODE is 0.

Yes Yes A string of 0 to 30 bytes, consisting of numerals or letters.

PAYPHONE Number for payment. It is mandatory when the value of PAYMODE is 2.





Whether Can Be Null

Value Range

DESCRIPTION

Remark. Yes Yes A string of 0 to 100 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 number.


BP Beep pager number.


USERTEMPLATE

Number of a user template.

Yes Yes A decimal integer or the numeral –1. The default value is –1.

MAXUSERNUMBER

Maximum number of concurrent users.

Yes No A decimal integer.

IPADDRESS IP address. Yes No A decimal integer.

IPMASK Mask of the IP address.


IPPOOLID ID of the IP address pool.

Yes No A decimal integer larger than 1 or the number –1

DOMAIN Domain name. Yes No A string of 1 to 20 bytes.

ACCOUNTNUMBER

Account number of the user.

Yes No A string of 1 to 40 bytes, 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.)





Whether Can Be Null

Value Range

ACCESSPOLICYID

ID of the access policy

Yes No An integer or the numeral –1. The numeral –1 indicates the ID of the access policy is not required.

ACCESSPROFILEID

ID of the access profile. NOTE

This parameter is valid only when the broadband service is in NGN/IMS mode.

Yes No A positive integer or –1. The number –1 indicates the ID of the access profile is not required.

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

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.

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



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.








A decimal integer. 0: Modifying user information succeeded. 3:The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: The system is not allowed to access the data. 14: The database operation failed. 1000: Sorry, the access profile does not exist. 1002: The template does not exist. 1002: Sorry, the area ID does not exist. 1003: The login user name already exists. 1011: Modifying LDAP data failed. 1051: Sorry, you cannot modify the domain because the subscriber has purchased for the service.

1052: Sorry, the authentication must be based on user name and password if the domain is for VPDN.

1053: Sorry, you cannot modify the domain because the subscriber belongs to a parent account.

1053: Sorry, you cannot modify the domain because the subscriber belongs to a parent account.

1054: The subscriber already exists in the external data.

1101: The user group cannot be modified. 1102: The user is not activated. You cannot modify the user.

1125: The domain does not exist. 1125: Sorry, the accesspolicy does not exist. 1156: The IP address pool does not exist. 1157: Sorry, the static IP address already exists. 1160: Sorry, the maximum number of prepaid users must be 1.

1226: Sorry, the domain cannot be the skip domain. 1002: Sorry, the area ID does not exist. 1125: Sorry, the accesspolicy does not exist.

DESC Description of the error cause.

A string of 0 to 256 bytes. When RETN is 0, this parameter is Modifying user information succeeded.





Scenario The infoX-AAA responds to the successful running of the command for modifying the information about a broadband user.

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


Whether Can Be Null

Value Range

ACCOUNTNUMBER

Account Yes No A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores.


Yes No Login name: A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: A string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. This parameter cannot start with or end with a period or minus sign.





Whether Can Be Null

Value Range

REMOVEALL Whether to reserve user information during deletion.

No No 0: yes 1: no

SCPID ID of the session resource manager.

Yes No 100–999

Instance The following is an instance of running the command for deleting a broadband user.

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.

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.







A decimal integer. 0: Deleting the user information succeeded. 3:The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: The system is not allowed to access the data. 14: The database operation failed. 1001: The account does not exist. 1003: The SCP is not connected. 1004: Sorry, forcing the user to log off failed. 1120: Deleting LDAP data failed.

DESC Describes cause of the error.

A string of 0 to 256 bytes. When RETN is set to 0, this parameter is Deleting the user information succeeded.



Scenario The infoX-AAA responds to the successful running of the command for deleting a broadband user.

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.




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


Whether Can Be Null

Value Range

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


IDNUMBER ID card number.

Yes Yes A string of 0 to 18 bytes, consisting of numerals and letters.


Yes Yes Login name: A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: A string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. This parameter cannot start with or end with a period or minus sign.

ACCOUNTNUMBER

Account. Yes No A string of 1 to 20 bytes, 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.

Scenario



Query the information about a broadband user. − The LOGINNAME parameter is sun. − The DOMAIN parameter is domain-usr-psw.

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

When querying the information about a broadband user, you must enter the value of a parameter. The values of LOGINNAME and ACCOUNTNUMBER cannot coexist. 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.





A decimal integer. 0: Querying user succeeded. 3: The transaction control flag is incorrect.

7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 14: The database operation failed. 1001: The account does not exist.

DESC Describes causes of the error. A string of 0 to 256 bytes. When RETN is 0, this parameter is Querying user succeeded.

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.

0: no 1: yes

START Start line of the current batch. A decimal integer.

ROWNUM Number of records in the current batch.

A decimal integer.




ATTR List of queried attributes. Fields are separated by ampersands (&). Including the following parameters:

ACCOUNTNUMBER: account

Login name and domain in the form of login name@domain.

BROADNUMBER: broadband number. It can be ignored.

USERID: user ID. It can be ignored.

SERVICELEVEL: service type. 0: Agent card 1: Postpaid Card (Type A) 2: Rechargeable Prepaid Card (Type B) 3: Non-Rechargeable Prepaid Card (Type C)

CONSUMERIGHT: consumption right 0: access and content 1: only access 2: only content 3: commissioned sales point 4: only VOIP

BATCH: batch SEQUENCE: sequence number of a batch

PROVIDERID: Agent ID. It can be ignored.

STATUS: status of a card. 0: not activated 1: activated 2: To be deleted 3: Free

SUBSTATE: indicating whether a card is available. 0: No 1: Yes

USESTATE: indicating whether a card is being used 0: no 1: yes

RELATIVEDAYS: Relative validity period. The validity period starts from the first use.

COUNTTOTAL: Amount of a card.

ACCOUNTLEFT: Balance of a card

Must be the following strings: 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 List of queried data. Lines are separated by the & symbol and parameters are separated by the | symbol.

Result set returned when an operation command is run.


Scenario The infoX-AAA responds to the successful running of the command for modifying the information about a broadband user.

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


Whether Can Be Null

Value Range

ACCOUNTNUMBER





Whether Can Be Null

Value Range


Yes No Login name: a string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: a string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. It cannot 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.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is domain-usr-psw.

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







RETN Returned value of the ACK command. A decimal integer. 0: Querying account succeeded.

3: The transaction control flag is incorrect.

7: system internal error. 8: The parameter is incorrect.

11: The operation timed out. 14: Database operation failed.

1001: The account does not exist.

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. When RETN is set to 0, the value of the parameter is Querying account succeeded.



FINISHED Indicates whether the operation ends. 0: no 1: yes


ROWNUM Number of records in the current batch. A decimal integer.




ATTR List or queried attributes. Fields are separated by ampersands (&). Including the following parameters:

ACCOUNTNUMBER: account LOGINNAME : Login name and domain in the form of login name@domain.

USERID: User ID. It can be ignored. SERVICELEVEL: Service type 0: Agent card 1: Postpaid Card (Type A) 2: Rechargeable Prepaid Card (Type B) 3: Non-Rechargable Prepaid Card (Type C)

CONSUMERIGHT: reserved field 0: access and content 1: only access 2: only content 3: commissioned sales point 4: only VOIP

BATCH: batch. SEQUENCE: sequence number of a batch.

PROVIDERID: Agent ID. It can be ignored.

STATUS: status of a card. 0: not activated. 1: activated 2: to be deleted 3: Idle

SUBSTATE: whether the card is available. 0: no 1: yes

USESTATE: whether a card is being used. 0: No 1: Yes

RELATIVEDAYS: relative validity period. The validity period starts from the first use.

COUNTTOTAL: total amount in a card

ACCOUNTLEFT: balance of a card LIMITTYPE: reserved field

Must be the following strings:ACCOUNTNUMBER & LOGINNAME & SERID & SERVICELEVEL & CONSUMERIGHT & BATCH & SEQUENCE & PROVIDERID & STATUS & SUBSTATE & USESTATE & RELAT IVEDAYS & COUNTTOTAL & ACCOUNTLEFT & LIMITTYPE & LIMITACCDAY & LIMITACCLEFTDAY & AREAID & FIRSTUSEDATE & SERVICESTART & SERVICESTOP & LASTUSEBEGINTIME & LASTUSEENDTIME & LIMITACCMONTH & LIMITACCLEFTMONTH & LIMITFLAG & LIMITPORT & CREDITFLAG & CREDITUNION & CREDITACCLEFT & REALNAME & PHONE & ACCESSPOLICYID & REGISTERTIME & UNREGISTERTIME





LIMITACCDAY: reserved field. LIMITACCLEFTDAY: reserved field.

AREAID: zone code. FIRSTUSEDATE: date of the first use.

SERVICESTART: start date. SERVICESTOP: end date. LASTUSEBEGINTIME: start time for the latest use.

LASTUSEENDTIME: end time for the latest use.

LIMITACCMONTH: reserved field. LIMITACCLEFTMONTH: reserved field.

LIMITPORT: reserved field. CREDITFLAG: reserved field. CREDITUNION: reserved field. CREDITACCLEFT: reserved field. REALNAME: real name of the user. PHONE: phone number of the user. ACCESSPOLICYID: ID of the access policy.

REGISTERTIME: time when the user is registered.

UNREGISTERTIME: time when the user is deregistered.




Scenario The infoX-AAA responds to the successful running of the command for querying the account information about a broadband user.

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



& 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


Whether Can Be Null

Value Range

ACCOUNTNUMBER



Yes No Login name: a string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: a string of 1 to 40 bytes, consisting of 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.





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


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.





A decimal integer. 0: Enabling the account succeeded. 3: The transaction control flag is incorrect. 7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: The system is not allowed to access the data. 14: Database operation failed. 1001: The account does not exist. 1002: Sorry, the account is not in the disable state. 1003: The account is not activated. 1003: The account has already been activated. 1005: The account cannot be resumed because it has not been used.

1007: LDAP failed to enable the account. 1008: LDAP failed to roll back. 1009: Failed to update the account status in the database.

DESC Describes causes of the error.

String of 0 to 256 bytes. When RETN is 0, this parameter is Enabling the account succeeded.





Scenario The infoX-AAA responds to the successful running of the command for activating an account.

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


Whether Can Be Null

Value Range

ACCOUNTNUMBER





Yes No 100–999




Instance The following is an instance of running the command for deactivating an account.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is domain-usr-psw. − The SCPID parameter is 100.

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.







A decimal integer. 0: Disabling the account succeeded. 3: The transaction control flag is incorrect. 7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: The system is not allowed to access the data. 14: The database operation failed. 1001: The account does not exist. 1002: Sorry, the account is not in the enable state. 1003: The account is not activated. 1004: LDAP failed to suspend the account. 1004: Sorry, forcing the user to log off failed. 1006: The account cannot be suspended, because it has not been used.

1008: LDAP failed to roll back. 1009: Failed to update the power-up status of the database account.

DESC Error cause. String of 0 to 256 bytes. When RETN is 0, this parameter is Disabling the account succeeded.



Scenario The infoX-AAA responds to the successful running of the command for deactivating an account.

Command ACK:DEACT C280 ACCOUNT:RETN=0,DESC="Disabling the account succeeded.";

4.2.15 Command for Resetting an Account

Command RESET C280 ACCOUNT




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


Whether Can Be Null

Value Range

ACCOUNTNU MBER



Yes No Login name: a string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: a string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. It cannot start with or end with a periods or minus sign.

SESSIONINFO Session information.

Yes No Type of a string.


Yes No 100–999

Instance The following is an instance of running the command for resetting an account.


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




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.





A decimal integer. 0: Resetting the account succeeded. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are not authorized to access the data.

14: The database operation failed. 1001: The account does not exist. 1002: Sorry, the account is offline now. 1003: Sorry, the user is connecting now. Please try again later.

1003: The SCP is not connected. 1004: Forcing the user to log off failed.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Resetting account succeeded.



Scenario The infoX-AAA responds to the successful running of the command for resetting an account.




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


Whether Can Be Null

Value Range

ACCOUNTNUMBER




PASSWORD Password. No No A string of 6 to 16 bytes.

CHKPASSWORD Password for confirmation.

No No A string of 6 to 16 bytes.

Instance The following is an instance of running the command for changing the password.

Scenario − The login name is sun. − The home domain of the user is domain-usr-psw.



− The new password is 123456. − The password for confirming the new password is 123456.

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.





A decimal integer. 0: Modifying the password succeeded. 3: The transaction control flag is incorrect. 7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: The system is not allowed to access the data.

14: Database oepration failed. 1002: Sorry, the account is not in the enable state.

1003: The account is not activated. 1001: LDAP failed to modify the password. 1008: LDAP failed to roll back. 1009: Failed to update the power-up status of the database account.





DESC Error cause A string of 0 to 256 bytes. When RETN is 0, this parameter is Modifying the password succeeded.



Scenario The infoX-AAA responds to the successful running of the command for changing a password.

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


Whether Can Be Null

Value Range


No No Login name: a string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: a string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. It cannot start with or end with a period or minus sign.



LIMITPORT Port number restriction. If it is null, the port restriction can be canceled.

Yes Yes A string of 1 to 64 bytes, consisting of letters, numerals, periods, minus signs, and underscores.

LIMITFLAG Indicates whether to restrict the port

Yes No 0: no 1: yes

Instance The following is an instance of running the command for restricting a port.

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.

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.





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



A decimal integer. 0: Setting limitport succeeded. 3: The transaction control flag is incorrect. 7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 14: The database operation failed. 1001: The account does not exist. 1002: Sorry, the account is not in the enable state.

1003: The account is not activated. 1011: Modifying the LDAP data failed. 1008: LDAP failed to roll back. 1010: The LDAP succeeded in rolling back


A string of 0 to 256 bytes. When RETN is 0, this parameter is Setting limitport succeeded.



Scenario The infoX-AAA responds to the successful running of the command for restricting a port.

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.



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


Whether Can Be Null

Value Range

ACCOUNT NUMBER




CHGVAL Amount to recharge.

No No A decimal integer, in minutes.

Instance The following is an instance of running the command for recharging an account by cash.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is domain-usr-psw. − The CHGVAL parameter is 2000.

Command CHARGE C280 ACCOUNT:CHGVAL=2000,LOGINNAME="sun@domain-usr-psw";


4.2.22 ACK to the Command for Recharging an Account by Cash

Command ACK: CHARGE C280 ACCOUNT




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





A decimal integer. 0: Cash recharging succeeded. 3: The transaction control flag is incorrect. 7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 14: The database oepration failed. 1001: The account does not exist. 1005: Sorry, the user has not been defined. 1004: It is not a rechargeable prepaid account.

1035: Cannot recharge because the total amount of money exceed the limitation.

1036: Cannot recharge because the deferment factor equals zero.

1041: You cannot recharge because the account is out of the validity period.

1003: Invalid account. 1042: The upper-limit fee for class B card is not defined.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Cash recharging succeeded.



Scenario The infoX-AAA responds to the successful running of the command for recharging an account by cash.

Command



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


Whether Can Be Null

Value Range

SN Sequence number of an operation

No No A decimal integer.

Instance The following is an instance of running the command for rolling back the cash recharge.

Scenario The sequence number of an operation is 2.

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.








A decimal integer. 0: Rolling back the cash recharge succeeded. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 14: Database operaton failed. 1045: Rolling back recharge of other agents is not allowed.

1046: Rolling back recharge again is not allowed.

1047: The cash recharging record does not exist.

1048: Sorry, user is online. 1049: Sorry, not enough balance. 1050: The user does not exist in the basic table.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Rolling back the cash recharge succeeded.



Scenario The infoX-AAA responds to the successful running of the command for rolling back the cash recharge.

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.



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


Whether Can Be Null

Value Range

ACCOUNT NUMBER

Account Yes No A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores.



CHARGETYPE Type of recharge.

Yes No 0:advertisement recharge

1:cash recharge 2:card recharge 3: balance transfer

BEGINTIME Start time, in the form of YYYYMMDDHHMMSS.


ENDTIME End time, in the form of YYYYMMDDHHMMSS.


TOP Maximum number of queried records.


STATE Current status of cash recharge.

No No 1: Normal 2: Rollback

OPERATOR Operator. Yes No A string of 1 to 16 bytes.




Instance The following is an instance of running the command for querying a recharge record.

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.

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.







A decimal integer. 0: Querying recharging record succeeded.


7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are not authorized to access the data.

14: The database operation failed. 1043: No recharge is rolled back. 1044: No recharge record is available.

DESC Error cause. A string of 0 to 256 bytes. When RETN is 0, this parameter is Querying recharging record succeeded.



FINISHED Whether the operation ends. 0: no 1: yes


ROWNUM Number of records in the current batch

A decimal integer.





ATTR List or attributes names that are separated by the & symbol. The attributes are as follows:

SN: sequence number of an operation.


CHARGENUMBER: rechargable card number.

CHARGETYPE: type of recharge.

CHARGETIME: recharge time.

CHARGEACCOUNT: recharge amount.

BEFOREACCOUNT: balance before recharge.

AFTERACCOUNT: balance after recharge.

PROVIDERID: ID of the cash recharge agent.

OPERATOR: cash recharge operator.

STATE: status of cash recharge records .

1: Normal (default) 2: Rollback OPTIME: rollback duration in the form of YYYYMMDDHHMMSS.

WITHDRAWER: account of an operator who performs rollback.

CHARGESN: sequence number of a recharge log.

Ordinary recharge records that are queried must be the following strings:SN & LOGINNAME & CHARGENUMBER & CHARGETYPE & CHARGETIME & CHARGEACCOUNT & BEFOREACCOUNT & AFTERACCOUNT & PROVIDERID & OPERATOR & STATE

Recharge rollback records that are queried must be the following strings:SN & LOGINNAME & CHARGENUMBER & CHARGETYPE & CHARGETIME & CHARGEACCOUNT & BEFOREACCOUNT & AFTERACCOUNT & PROVIDERID & OPERATOR & STATE & OPTIME & WITHDRAWER & ChargeSN




Scenario



The infoX-AAA responds to the successful running of the command for querying a recharge record of a broadband user.

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


Whether Can Be Null

Value Range

ACCOUNTNUMBER


LOGINNAME

Login name and domain (If no domain is applicable to the customer, set LOGINNAME to login name@-1).

Yes No Login name: A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: A string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. This parameter cannot start with or end with periods or commas.

BILLTIME Time when a bill is generated





Instance The following is an instance of running the command for querying a bill.

Scenario − The DOMAIN parameter is domain-usr-psw. − The BILLTIME parameter is 20060501000000.

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.





A decimal integer. 0: Querying succeeded. 3:The transaction control flag is incorrect.

7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are not authorized to access the data.

14: The database operation failed. 1000: Sorry, the bill does not exist. 1001: The account does not exist. 1032: No bill is recorded in the specified period.

1034: System internal error.




DESC Error cause. A string of 0 to 256 bytes. When the value of RETN is 0, the value of this parameter is Querying succeeded.



FINISHED Whether the operation ends. 0: no 1: yes



A decimal integer.





ATTR List or queried attributes. Fields are separated by ampersands (&). Including the following attributes:

ACCOUNTNUMBER: Card number.


SERVICEKEY: service key. SERVICELEVEL: service type. PROVIDERID: ID of the agent LOGICPORTNO: logical port reported by the ISN

SERVICESTARTTIME: start time of the service.

BEGINTIME: start time of the charging.

BEGINTIME: end time of the charging.

CHARGEMODE: charging mode.

0: flow-based 1: duration-based 2: based on flow and duration 3: Piece-based CHARGECLASS: charging type. FEE: fee to be paid. SENDBYTES: Upstream bandwidth in Kilobytes.

RECEIVEBYTES: Downstream bandwidth in Kilobytes.

SENDPACKES: number of upstream packets.

RECEIVEPACKES: number of downstream packets

TIMELENGTH: online duration. CONTENTTITLE: name of a content.

BILLTYPE: type of a bill. ACCOUNTREASON: Charging reason, that is, cause for generating bills.

SN: Sequence number. SERVICEITEMID: ID of a service.

SERVICEITEMNAME: Name of a service.

USERIP: IP address of the user assigned by the device.

ISNIP: IP of the ISN, in the form of a string. LOGICALPORTNO L i l

Must be the following strings: 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 set returned when an operation command is carried out.


Scenario The infoX-AAA responds to the successful running of the command for querying a bill.

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


Whether Can Be Null

Value Range

ACCOUNTNUMBER






Whether Can Be Null

Value Range


Yes No Login name: a string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: a string of 1 to 40 bytes, consisting of 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 be canceled. An account can order only one access service.

No No A decimal integer that is greater than 1.

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.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is domain-usr-psw. − The SERVICEID parameter is 100.

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.







A decimal integer. 0: Subscribing the service for account succeeded. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are not authorized to access the data. 14: The database operation failed. 1000: Sorry, the service does not exist. 1000: System internal error. 1012: The account has subscribed to an access service and cannot subscribe to another one.

1009: Sorry, the account cannot subscribe the access service because it has subscribed one.

1010: Sorry, the account has subscribed the value-added service.

1003: Sorry, the batch number does not exist. 1030: The account is not activated. 1002: The account does not exist. 1003: The batch number does not exist. 1004: The login name or batch number is missing. 1005: The service does not exist. 1006: The proxy service cannot be subscribed. 1007: The charge policy does not exist. 1010: The account cannot subscribe this service. 1011: This account cannot subscribe the service because its validity period has expired.

1012: The account cannot subscribe the access service because it has subscribed one.

1013: The service has been subscribed for the account. 1014: The domain doesn't exist.






1015: The service is not contained in the visibility table of service domains.

1016: This account has already subscribed the VPDN service.

1017: The service cannot be subscribed by the account.

1021: The accounts of the batch cannot subscribe this service.

1022: The service has been subscribed for all the accounts of this batch.

1023: Access service has been subscribed for the accounts of this batch.

1024: This account has already subscribed the VPDN service.

1500: Sorry, the user does not belong to the current operator. (The prompt is valic when the system is in the area management mode.)


A string of 0 to 256 bytes. When RETN is 0, this parameter is Subscribing the service for account succeeded.



Scenario The infoX-AAA responds to the successful running of the command for ordering a service.

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.



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


Whether Can Be Null

Value Range

ACCOUNTNUMBER




SERVICEID ID of a service to be subscribed to. An account can subscribe to only one access service.

No No A decimal integer of 0 to 1000. A decimal integer that is greater than 1.

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.

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.

Command DEL C280 ORDER:SERVICEID=100,LOGINNAME="sun@domain-usr-psw"

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




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.







A decimal integer. 0: Cancelling the service for account succeeded. 3: The transaction control flag is incorrect. 7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are not authorized to access the data. 14: The database operation failed. 1006: Sorry, the service is not subscribed for the account.

1003: Sorry, the batch number does not exist. 1130: The account is not activated. 1102: The account does not exist. 1103: The batch does not exist. 1104: The login name or batch number is missing. 1105: The service does not exist. 1106: Cannot delete the access service for this account.

1107: This account has not subscribed the service. 1108: Refunding basic fee failed. 1109: Cannot cancel the subscription because the subscriber is using the service.

1110: This batch is not authorized to subscribe the access service.

1111: The service is not subscribed for all the accounts of this batch.

1112: The domain doesn't exist. 1500: Sorry, the user does not belong to the current operator. (The prompt is valid when the system is in the area management mode.)


A string of 0 to 256 bytes. When RETN is set to 0, this parameter is Cancelling the service for account succeeded.



Scenario




The infoX-AAA responds to the successful running of the command for canceling an ordered service.

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


Whether Can Be Null

Value Range


Yes No Login name: a string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores. Domain: a string of 1 to 40 bytes, consisting of letters, numerals, periods or minus signs. It cannot start or end with a period or minus sign.

ACCOUNTNUMBER


Instance The following is an instance of running the command for querying an ordered service.




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


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.





A decimal integer. 0: Querying the service by account succeeded.

3: The transaction control flag is incorrect. 7: system internal error. 8: The parameter is incorrect. 11: The operation timed out. 14: The database operation failed. 1001: The account does not exist. 1000: The account does not subscribe to any service.

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. When RETN is 0, this parameter is Querying the service by account succeeded.


TOTAL Number of queried records.

A decimal integer.





FINISHED Indicates whether the operation ends.

0: no 1: yes

START Start line of the current batch.

A decimal integer.

ROWNUM Number of records of the current batch.

A decimal integer.

ATTR List or queried attributes. Fields are separated by ampersands (&). Including the following parameters:

LOGINNAME: Login name and domain

SERVICEID: ID of a servie

SERVICENAME: Name of a service

SERVICETYPE: Type of a service

ORDERTIME: Order time

STAUTS: Status of an order

Must be the following strings: LOGINNAME & SERVICEID & ORDERTIME & STATUS & SERVICENAME & SERVICETYPE




Scenario The infoX-AAA responds to the successful running of the command for the operator to query the information about an ordered service.

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


Whether Can Be Null

Value Range

USERNAME Login name of the user.

No No A string of 1 to 20 bytes, 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.


Yes No 100–199 Default value: 100

USERIPADDRESS

IP address of the user.

Yes No 1.1.1.1–223.255.255.255

SERVICEFALG

Type of the installation service.

No No A string of 1 to 10 bytes. The service types are as follows:

AAA: AAA service SSS: SSS service

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




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.

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.






RETN Returned value of the ACK Commands. A decimal integer. The integers are as follows:

0: Querying the session succeeded.


7: System internal error.

8: The parameter is incorrect.

11: The operation timed out.

12: You are not authorized to access the data.

14: The database operation failed.

1000: Sorry, no session for the user.

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

When RETN is 0, this parameter is Querying user succeeded.



FINISHED Indicates whether the operation ends. 0: no 1: yes







ATTR For the AAA service, the parameters are as follows:

USERNAME: login name. USERIP: IP address of the user. ISNIP: IP address of the ISN device. NASPORTID: port type. It is used to judge whether the user accesses the Wireless Local Area Network (WLAN).

SERSTARTTIME: time when the user goes online

ACCTSESSIONID: session ID. INPUTVOLUMN: downlink traffic flow. OUTPUTVOLUMN: uplink traffic flow.

For the SSS service, the parameters are as follows:

INTERFACEALIAS: alias INTERFACEDESC: description of the interface that the user accesses.

INTERFACENAME: name of the interface that the user accesses.

IPADDRESS: IP address of the user. USERNAME: login name of the user. LOGINTIME: the time when the user accesses the network.

SERVICECLASS: service type. USERSESSIONID: AcctSessionId of the basic access service of the user.

NASIDENTIFIER: identifier of the device. List of queried attributes. Fields are separated by the & symbol.

In the AAA service, the stings must be as follows:USERNAME & USERIP & ISNIP & NASPORTID & ACCUTIME & ACCTSESSIONID & INPUTVOLUMN & OUTPUTVOLUMN In the SSS service, the stings must be as follows:INTERFACEALIAS & INTERFACEDESC & INTERFACENAME & IPADDRESS & USERNAME & LOGINTIME & SERVICECLASS & USERSESSIONID & NASIDENTIFIER




Scenario The infoX-AAA responds to the successful running of the command for querying the session information about a user.

Command



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",;

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


5 Interfaces for CDMA Service

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

5 Interfaces for CDMA Service infoX-AAA



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


Whether Can Be Null

Value Range

LOGINNAME Login name of a CDMA user.

Yes No A string of 1 to 20 bytes. The value can consist of letters, numerals, periods, minus signs, underlines, or a combination of the preceding characters.




Whether Can Be Null

Value Range

DOMAIN Domain that a CDMA user belongs to.

Yes No A string of 1 to 40 bytes. 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 comma.

PAYMENTMODE

Payment mode of a CDMA user.

Yes No 1: postpaid user. 2: prepaid user.

GROUPID ID of the group that the user belongs to.

No No A decimal integer.

PSWD Password of a MN user.


ANPSWD Password of an AN user.


MSID ID of a mobile user.

Yes No A string of 1 to 20 bytes, consisting of only numerals.

MDN Mobile phone number of a CDMA user.


EXTTEMPLET Template number of a user. Set it to –1 when the parameter is not needed.

Yes No A string of one or more bytes. The number –1 or a decimal integer greater than 0.





Whether Can Be Null

Value Range

IPASSIGN Mode of assigning the IP address.

Yes No 0: not assign IP address

1: assign static IP address

2: assign dynamic IP address

IP IP address that is assigned statically to a CDMA user.


IPMASK Subnet mask of the IP address.


IPPOOLID ID of an IP address pool. When IPASSIGN is set to 2, the field cannot be omitted.

Yes No 1: device address pool 2: AAA address pool

RK Registry key of the BCMCS.


NEEDIRS Whether to support IP Reachability.

Yes No 0: no 1: yes

UZID Area where a subscriber roams.


ISAUTH Whether the user group is authenticated.

Yes No 0: no 1: yes

MSIDENTIFIER

Terminal type. Yes No 0: Not set when the user is added

1: ESN 2: MEID




Whether Can Be Null

Value Range

UIMID Sequence number. When the user is an AN user, this parameter need not be set.

Yes Yes When the MSIDENTIFIER value is ESN, the parameter is a hexadecimal string of 8 bytes.

When the MSIDENTIFIER value is MEID, the parameter is a hexadecimal string of 14 bytes.

AUTHFAILCNTTRH

Count of authentication failure.


CHGVAL Amount for registration.


MSTYPE Type of a terminal.

Yes No 0: single mode 1: dual mode

SSDSYNCNTTRH

SSD synchronous counter.


SERVICESTOP

Validity period of an account.

Yes No A string in the YYYYMMDDHHMMSS format.

NOTE AN = Access Network MN = Mobile Network

Instance The following is an instance of running the command for adding a CDMA user.

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.




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

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.

When Authtype of a domain is 0, LOGINNAME, PSWD, and MSID can be omitted. When Authtype of a domain is 1, MSID cannot be omitted. When Authtype of a domain is 4, LOGINNAME cannot be omitted. When Authtype of a domain is 5, LOGINNAME and MSID cannot be omitted. When Authtype of a domain is 6, LOGINNAME and PSWD cannot be omitted. 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. When IPASSIGN is 0, IP, IPMASK, and IPPOOLID must be omitted. When IPASSIGN is 1, IP and IPMASK cannot be omitted; IPPOOLID must be omitted. 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.







A decimal integer. 0: Succeeded in registering the WCDMA user. 3: The transaction control flag is incorrect. 7: Internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1001: Sorry, the user group does not exist. 1002: Sorry, the domain does not exist. 1004: Sorry, login name is required. 1005: Sorry, IMSI is required 1006: Sorry, the extended attribute does not exist. 1007: Sorry, both password and IMSI are required. 1008: Sorry. The license you want to query for does not exist.

1008: Sorry, the IP address pool does not exist. 1009: Sorry, password is required 1010: Sorry, the subscriber already exists. 1013: The LDAP failed to roll back the data. 1014: The LDAP succeeded in rolling back the data. 1020: Sorry, the static IP address already exists. 1085: User Zone doesn't exist. 1089: Sorry, the Paymode Type must input. 1203: Failed to register the user in CDMA service. 1205: The parameter UIMID no need. 7007: Number of key columns does not match number of key values.

7009: Require one parameter with value at least.





RETN Returned value of the ACK command

1015: Adding LDAP data failed. 1088: Sorry, the assign mode of IP address must be input.

1088: Sorry, the loginname and IMSI must be input. 1088: Sorry, password must be input if needing authentication.

1090: This user group has no AN right, so the User Zone cannot be entered.

1092: Sorry, the IMSI already exists. 1100: Sorry, the license is not enough. 1117: Local prepaid user cannot choose the domain of authentication-user-name type.

1119: Sorry, the management of user can't choose skipping domain.

1903: UppLimitB not found. 1904: Charge value exceed upper limit. 7001: Entry has already existed. 7002: Adding LDAP data failed. 7003: Deleting the LDAP data failed. 7004: Modifying the LDAP data failed. 7005: Connecting LDAP failed. 7006: Bind LDAP failed.

DESC Cause of the error.

A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in adding a CDMA subscriber.



Scenario The infoX-AAA responds to the successful running of the command for adding a CDMA user.

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



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


Whether Can Be Null

Value Range

LOGINNAME Login name of a CDMA user (If no domain is applicable to the customer, set LOGINNAME to login name@-1).



No No A string of 1 to 40 bytes. 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 comma.



REMOVEALL Whether to delete all information of users.

Yes No 0: no 1: yes

Instance The following is an instance of running the command for deleting a CDMA user.

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.

Command DEL C270 ACCOUNT: DOMAIN=usr-psw-imsi, REMOVEALL=0, LOGINNAME=sun;




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.





A decimal integer. 0: Succeeded in deleting the CDMA subscriber. 3: The transaction control flag is incorrect. 7: Internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1001: Sorry, the user group does not exist. 1011: Sorry, the account does not exist. 1009: Deleting the LDAP data failed. 2222: Sorry, the user cannot be deleted while system is deducting basic fee.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in deleting the CDMA subscriber.



Scenario The infoX-AAA responds to the successful running of the command for deleting a CDMA user.



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


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


Whether Can Be Null

Value Range







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




Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is usr-psw-imsi.

Command QUERY C270 ACCOUNT:DOMAIN=usr-psw-imsi,LOGINNAME=sun


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.




RETN Returned value of the ACK command. A decimal integer. 0: Succeeded in querying the CDMA subscriber.


7: Internal error. 8: The parameter is incorrect.


12: You are unauthorized to access the data.


1011: Sorry, the account does not exist.




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

When RETN is 0, this parameter is Succeeded in querying the CDMA subscriber.


TOTAL Total number of lines of queried results. A decimal integer.

FINISHED Whether the operation is complete. 0: no 1: yes

START Start line number in the current batch. A decimal integer.


ATTR List of query attribute names that are separated by the & symbols. The attribute names are as follows:

DOMAIN: home domain LOGINNAME: login name USERGROUPID: user group ID USERGROUPNAME: user group name GROUPSTATE: user state PAYMENTMODE: payment type MSID: MSID of a CDMA user IP: IP address that is assigned statically EXTTEMPLET: common template ID of a user

STATUS: user state REGTIME: time when an account is registered

MDN: mobile phone number IPASSIGN: mode of assigning the IP address IPMASK: subnet mask of the IP address RK: BCMCS registered secret key NEEDIRS: whether to support the IP reachability

AUTHTYPE: authentication mode of the home domain

LOCKFLAG: lock flag of a CDMA user LOCKTIME: time when the blacklist is

The value must be the following string: DOMAIN & LOGINNAME & US ERGROUPID & 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 &




Parameter Description Value Range updated.

PSWERRORCOUNT: times of putting into the blacklist

IPPOOLNAME: name of the IP address pool IPPOOLID: ID of the IP address pool ACCOUNTLEFT: balance of the local prepaid user

IPPOOLTYPE: type of the IP address pool MSTYPE: terminal type ISAUTH: whether the user group is authenticated

UIMID: electronic serial number NEWUSERGROUPID: ID of a new user group

NEWGRPEFFECTTIME: time when the new user group takes effect

USERTYPE: user type ANMSID: user identifier delivered when an AN user is authenticated and authorized

MSIDENTIFIER: terminal type

AUTHFAILCNTTRH & SSDSYNCNTTRH & SERVICESTOP & UZID & TEMPLATENAME

RESULT List of queried data. Every two lines are separated by the & symbol and every two parameters are separated by the | symbol.

Result set returned by the operation command according to the actual situation.


Scenario The infoX-AAA responds to the successful running of the command for querying for the information about a CDMA user.

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


Whether Can Be Null

Value Range

LOGINNAME Login name of a CDMA user (If on domain is applicable to the customer, set LOGINNAME to login name@-1).




PAYMENTMODE

Payment mode of a CDMA user.

Yes No 1: postpaid user

2: prepaid user





Whether Can Be Null

Value Range

STATUS Status of a CDMA user.

Yes No 0: normal 1: frozen 2: deregistered

GROUPID ID of the group that the user belongs to.


REPLACEGRPFLAG

Whether to replace the flag of the user group.

Yes No 0: not replace 1: replace

NEWUSERGROUPID

ID of the new user group.

Yes No The value –1 or a decimal integer that is greater than 0. When REPLACEGRPFLAG is set to 1, the parameter is mandatory.

NEWGRPEFFECTTIME

Time when the new user group takes effect.

Yes No Format: YYYYMMDDhhmmss

PSWD Password used by a CDMA user for login.


MSID ID of a mobile user. Yes Yes A string of 1 to 20 bytes, consisting of only numerals.

MDN Number of a mobile phone of a CDMA user.


LOCKFLAG Lock flag of a CDMA user.

Yes No 0: available 1: locked




Whether Can Be Null

Value Range

EXTTEMPLET Number of a common attribute template of a user.

Yes No The number –1 or a decimal integer greater than 0.

IPASSIGN Mode of assigning IP addresses.

Yes No 0: not assign 1: static IP address

2: dynamic IP address

IP Static IP address of a CDMA user.


IPMASK Subnet mask of an IP address. When IPASSIGN is set to 1, the field cannot be omitted.


IPPOOLID ID of an IP address pool. When IPASSIGN is set to 2, the field cannot be omitted.

Yes No The number –1 or a decimal integer greater than 0.

RK Registry key of the BCMCS.


NEEDIRS Whether to support the IP reachability.

Yes No 0: no 1: yes

UZID Area where a subscriber roams.


ISAUTH Whether the user group is authenticated.

Yes No 0: no 1: yes

MSIDENTIFIER

Terminal type. Yes No 0: Not set when the user is added

1: ESN 2: MEID





Whether Can Be Null

Value Range

UIMID Sequence number. Yes Yes When the MSIDENTIFIER value is ESN, the parameter is a hexadecimal string of 8 bytes.

When the MSIDENTIFIER value is MEID, the parameter is a hexadecimal string of 14 bytes.

AUTHFAILCNTTRH

Count of authentication failure.


MSTYPE Type of a terminal. Yes No 0: single mode 1: dual mode

SSDSYNCNTTRH

SSD synchronous counter.


SERVICESTOP

Validity period of an account.

Yes No A string in the YYYYMMDDHHMMSS format.

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

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.



− The UZID parameter is 12. − The IP reachability is supported. That is, the NEEDIRS parameter is 1. − The SERVICESTOP parameter is 20380101000000.

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.

When Authtype of a domain is 0, the parameters LOGINNAME, PSWD, and MSID can be omitted.

When Authtype of a domain is 1, the MSID cannot be omitted. When Authtype of a domain is 4, the LOGINNAME parameter cannot be omitted. When Authtype of a domain is 5, the LOGINNAME and MSID cannot be omitted. When Authtype of a domain is 6, the LOGINNAME and PSWD cannot be omitted. 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. When IPASSIGN is 0, IP, IPMASK, and IPPOOLID must be omitted. When IPASSIGN is 1, IP and IPMASK cannot be omitted. The IPPOOLID must be omitted. When IPASSIGN is 2, IP and IPMASK must be omitted.

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.

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




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.




A decimal integer. 0: Succeeded in modifying the CDMA subscriber. 0: Succeeded in changing the CDMA subscriber password.

0: Succeeded in unlocking the CDMA subscriber. 3: The transaction control flag is incorrect. 7: Internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1001: Sorry, the user group does not exist. 1002: Sorry, the domain doesn't exist. 1005: Sorry, IMSI is required. 1006: Sorry, the extended template does not exist. 1008: Sorry, the IP address pool does not exist. 1009: Sorry, IMSI cannot be modified for the subscriber that authenticates IMSI.

1011: Sorry, the account does not exist. 1011: Modifying the LDAP data failed. 1014: Sorry, no matching CDMA subscriber exists. 1018: Sorry, needing username. 1085: User Zone doesn't exist. 1088: Sorry, the loginname and IMSI must be input. 1090: This user group has no AN right, so the User Zone cannot be entered.

1020: Sorry, the static IP address already exists. 1093: The user does not support MN password. 1100: Sorry, the license is not enough. 1116: Sorry. The subscriber is not locked. 1117: Local prepaid user cannot choose the domain of authentication-user-name type.

1119: Sorry, the account has been deleted.



Parameter Description Value Range 1119: Sorry, the management of user can't choose skipping domain.

1202: Deducting fee… The user group cannot be modified now. Please try later.

1301: The user type of the new user group can not be changed.

1300: The parameter GroupID is not correct.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in modifying the CDMA subscriber.



Scenario The infoX-AAA responds to the successful running of the command for the operator to modify the information about a CDMA user.

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


Whether Can Be Null

Value Range

LOGINNAME Login name of a CDMA user.






Whether Can Be Null

Value Range

DOMAIN Home domain of a CDMA user.

Yes No A string of 1 to 40 bytes. 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.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is usr-psw-imsi. − The ANPSWD parameter is 000000.

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.







A decimal integer. 0: Changing AN password succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1011: Sorry, this account does not exist. 1001: Sorry, the user group does not exist. 1001: The user does not support AN password. 1002: LDAP operation failed when changing NAI. 1013: The LDAP failed to roll back the data. 1003: Failed to change AN password. 1119: Sorry, the account has been deleted.

DESC Cause of the error. A string of 0 to 256 bytes. When RETN is 0, this parameter is Changing AN password succeeded.



Scenario The infoX-AAA responds to the successful running of the command for changing the user password.

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





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


Whether Can Be Null

Value Range

LOGINNAME Login name of a CDMA user (If on domain is applicable to the customer, set LOGINNAME to login name@-1).

No No A string of 1 to 20 bytes. The value can consist of letters, numerals, periods, minus signs, underlines, or a combination of the preceding characters.



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.



Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is usr-psw-imsi. − The OLDPASSWD parameter is 123456. − The NEWPASSWD parameter is 654321.

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


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.





A decimal integer. 0: Succeeded in changing the CDMA subscriber password.

3: The transaction control flag is incorrect. 7: Internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1011: Sorry, the account does not exist. 1013: Sorry, the old password is incorrect.

DESC Description of error cause.

A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in changing the CDMA subscriber password.






Scenario The infoX-AAA responds to the successful running of the command for changing the user password in the self-service system.

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


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


Whether Can Be Null

Value Range






Yes No A string of 1 to 20 bytes, consisting of only numerals.




Whether Can Be Null

Value Range

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.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is usr-psw-imsi. − The CHGVAL parameter is 2000 cents.

Command CHARGE C270 ACCOUNT: LOGINNAME=sun, DOMAIN=usr-psw-imsi, CHGVAL=2000


5.2.14 ACK to the Command for Recharging a CDMA Local Prepaid Account


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




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




A decimal integer. 0: Cash recharging succeeded. 3: The transaction control flag is incorrect. 7: Internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1011: Sorry, the account does not exist. 1903: UppLimitB does not exist. 1904: Charge value exceed upper limit. 1905: Account left overflow after charge. 1910: Account not found. 1911: Parameter not match prepay user type. 1912: Postpaid user cannot be charged. 1913: The user will be deleted, cannot been charged.

DESC Cause of the error. A string of 0 to 256 bytes. When RETN is 0, this parameter is Cash recharging succeeded.



Scenario The infoX-AAA responds to the successful running of the command for recharging a local prepaid CDMA user.

Command ACK:CHARGE C270 ACCOUNT:RETN=0, DESC="Cash recharging succeeded.";

5.2.15 Command for Querying the Bill of a CDMA Account




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


Whether Can Be Null

Value Range




No No A string of 1 to 40 bytes. 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.

BILLTIME Time of the bill. No No Format: YYYYMMDDhhmmss

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.

Scenario − The LOGINAME parameter is sun. − The DOMAIN parameter is usr-psw-imsi. − The BILLTIME parameter is 20060901010101.

Command QUERY C270 BILL:LOGINNAME=sun, DOMAIN=usr-psw-imsi, BILLTIME=20060901010101




5.2.16 ACK to the Command for Querying for a Bill of a CDMA Local Prepaid Account


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





A decimal integer. 0: Querying the bill succeeded. 3: The transaction control flag is incorrect. 7: Internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1000: System internal error. 1011: Sorry, the account does not exist. 1012: Sorry, the bill does not exist. 1034: System internal error.

DESC Cause of the error. A string of 0 to 256 bytes. When RETN is 0, this parameter is Querying the bill succeeded.


TOTAL Total number of lines of queried results.

A decimal integer.

FINISHED Whether the operation is complete.

0: no 1: yes

START Start line number in the current batch.

A decimal integer.


A decimal integer.




ATTR List of query attribute names that are separated by the & symbol. Including the following parameters:

LOGINNAME: login name.

ACCOUNTREASON: bill type.

MDN: mobile phone number.

SERVICESTARTTIME: time of access.

STARTTIME: time of last request.

ENDTIME: time of current request.

SESSIONTIME: session duration.

SESSIONVOLUME: session volume.

FEE: online fee.

The value must be the following string: STREAMNUMBER & LOGINNAME & DOMAIN & USERIP & ACCOUNTREASON & MDN & SERVICESTARTTIME & STARTTIME & ENDTIME & SESSIONTIME & SESSIONVOLUME & FEE & RATEPOLICYIDX & GROUPID & SERVICEID

RESULT List of queried data. Every two lines are separated by the & symbol, and every two parameters are separated by the | symbol.



Scenario The infoX-AAA responds to the successful running of the command for querying for a bill.

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




|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


Whether Can Be Null

Value Range





SERVICEID ID of the service that a CDMA user wants to query for.

Yes No A positive integer from 1 to 2147483647.



Instance The following is an instance of running the command to query for the start time and accumulative service usage of a service.


Command QUERY C270 USAGE:LOGINNAME="sun",DOMAIN="usr-psw-imsi"

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.

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.







RETN Returned value of the ACK command. A decimal integer. 0: Querying for the service start time and accumulative service usage succeeded.






1294: Sorry, only a prepaid user can query for the service usage.

1108: Sorry, the service subscribed by the subscriber does not exist.


When RETN is 0, this parameter is Querying for the service start time and accumulative service usage succeeded.










LASTDEDUCTTIME: Last time the basic fee is deducted (time a service is enabled for a user. If 19700101000000 is returned, it indicates that the service is not enabled.)

ACCUTIME: accumulative duration, in seconds. When the value is greater than 0, the parameter is valid.

ACCUFLOW: accumulative volume, in KB. When the value is greater than 0, the parameter is valid.

The value must be the following string: LASTDEDUCTTIME & ACCUTIME & ACCUFLOW

RESULT List of queried data.Every two lines are separated by the & symbol, and every two parameters are separated by the | symbol.



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.

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|",;

infoX-AAA Interface Developer Guide - MML 6 MML Interfaces for WCDMA Service



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

6 MML Interfaces for WCDMA Service infoX-AAA



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


Whether Can Be Null

Value Range

LOGINNAME

Login name of the WCDMA user.


DOMAIN Domain that a WCDMA user belongs to.

Yes No A string of 1 to 40 bytes, consisting of letters, numerals, periods, and minus signs.

USERGROUPID

ID of the group that the WCDMA user belongs to.





Whether Can Be Null

Value Range

PAIDTYPE Payment type that the WCDMA user selects.


USERTYPE

User type. NOTE

The parameter is mandatory when the payment type is prepaid.

Yes No 1: local network 2: intelligent network

CHARGEAMOUNT

Amount to be recharged. NOTE

The value can be entered when the user is a prepaid user.

Yes No The value 0 or a positive decimal integer that is up to 49999.

APNNAME

APN name. Yes No A string of 1 to 64 bytes. 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 number. NOTE

The parameter is mandatory when the user is a prepaid user.

Yes No A numeric string of 1 to 20 bytes.

IPADDRESS

Static IP address of a WCDMA user. The value must be converted into a decimal integer.


IPMASK Subnet mask of an IP address. The value must be converted into a decimal integer.



Yes No A decimal integer that is equal to –1 or greater than 0.





Whether Can Be Null

Value Range

MAXUSERNUMBER

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

Yes No A decimal integer. The value 0 indicates that the number of concurrent users is not limited.

TEMPLATEID

Template ID. Yes No A decimal integer that is greater than 0. The default value is –1.

IMSI IMSI number of a mobile phone.

Yes No A string of 0 to 20 bytes. The value of this parameter can contain non-reserved characters.

RESETINTERVAL

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

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.



− The MAXUSERNUMBER parameter is 1. 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. When Authtype of a domain is 0, LOGINNAME, PSWD, and MSID can be omitted. When Authtype of a domain is 1, MSID cannot be omitted. When Authtype of a domain is 5, LOGINNAME and MSID cannot be omitted. When Authtype of a domain is 6, LOGINNAME and PSWD cannot be omitted. 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: The IPADDRESS and IPMASK parameters cannot exist at the same time or must coexist. When IPADDRESS, IPMASK, and IPPOOLID coexist, IPADDRESS or IPPOOLID must be –1.

When IPADDRESS is –1, IPMASK must also be –1. If only IPADDRESS and IPMASK exist, IPADDRESS cannot be –1. 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.







RETN Return codes of the ACK command.

A decimal integer. The return codes are as follows:

0: Succeeded in registering the WCDMA user. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1011: Sorry, the number of users has reached the upper-limit specified in the License. Please apply for it again.

1012: Sorry. The license you want to query does not exist.

1000: Sorry, The APN does not exist. 1005: Sorry, the IMSI must be entered. 1006: Sorry, password is required. 1007: Sorry, both password and MSID are required.

1002: Sorry. The WCDMA user already exists. 1013: Sorry, the IP address pool does not exist. 1009: Sorry, the mobile phone number already exists.

1100: Sorry, the license is not enough. 1119: Sorry, the management of user can't choose skipping domain.

1020: Sorry, the domain does not exist. 1020: Sorry, the static IP address already exists. 1051: Sorry, charge amount exceeds uplimit. 1052: Sorry, the user group does not exist. 1053: Sorry, the user group does not have any service.

1054: Sorry, the upper limit of the charge amount of B card does not exist.




DESC Description of the return codes.

A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in registering the WCDMA user.



Scenario The infoX-AAA responds to the successful running of the command for adding a WCDMA user.

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


Whether Can Be Null

Value Range

LOGINNAME

Login name of a WCDMA user (If no domain is applicable to the customer, set LOGINNAME to login name@-1).

Yes No A string of 1 to 20 bytes, consisting of characters.





Whether Can Be Null

Value Range



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




REMOVEALL

Whether to delete all information of a user.

No No 0: reserve the user information

1: delete all the user information

Instance The following is an instance of running the command for deleting a WCDMA user.

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.

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



Function The command is used for the infoX-AAA system to respond to the command for deleting a WCDMA user.






0: Succeeded in deregistering the WCDMA user.

3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1002: Sorry, the user does not exist. 1001: Sorry, the user does not exist. 1002: Sorry, the WCDMA subscriber has already been deregistered.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in deregistering the WCDMA user.



A decimal integer.

FINISHED Whether the operation is complete.

0: no 1: yes

START Start line number in the current batch.

A decimal integer.


A decimal integer.





ATTR List of queried attribute names. Including the following parameter: USERNAME: name of a user.

The value must be USERNAME.

RESULT List of queried data. Every two parameter values are separated by the | symbol.



Scenario The infoX-AAA responds to the successful running of the command for deleting a WCDMA user.

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


Function This command is used to query for the information of a WCDMA user.



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


Whether Can Be Null

Value Range

LOGINNAME

Login name of a WCDMA user (If no domain is applicable to the customer, set LOGINNAME to login name@-1).

Yes No A string of 1 to 20 bytes, consisting of characters, numerals, periods, minus signs, and underscores.







STATUS Status of a user. Yes No 1: normal 2: frozen 3: deregistered

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

Scenario − The LOGINNAME parameter is 13800000000. − The DOMAIN parameter is nanjing.

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.




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.




RETN Return codes of the ACK command. A decimal integer. The return codes are as follows:

0: Succeeded in querying the WCDMA user.


7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data.


1001: Sorry. The WCDMA user does not exist.

DESC Description of the return codes. A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in querying the WCDMA user.



A decimal integer.







A decimal integer.

ATTR List of query attribute names that are separated by the & symbol. The attributes names are as follows:

APNNAME: name of the APN LOGINNAME: login name of the WCDMA user

DOMAIN: domain of the WCDMA user

MSID: mobile phone number IMSI: IMSI number of a mobile phone

IP: static IP address of a WCDMA user (The value is in the XXX.XXX.XXX.XXX format.)

IPMASK: subnet mask of a static IP address

IPPOOLID: ID of the IP address pool

IPPOOLTYPE: type of the IP address pool (If IPPOOLID is –1, the value is null.)

IPPOOLNAME: name of the IP address pool (If IPPOOLID is –1, the value is null.)

IPPOOLTYPE: type of the IP address pool (If IPPOOLID is –1, the value is null.)

MAXUSERNUMBER: maximum number of concurrent users

TEMPLATEID: template ID TEMPLATENAME: template name (If TemplateID is –1, the value is null.)

TEMPLATETYPE: template type (If TemplateID is –1, the value is null.)

RESETINTERVAL STATUS: user status

LOCKFLAG: lock flag of a user PWATTEMPT: password entry attempts

LOCKTIME: time when an account

The fixed value is the following string: APNNAME & LOGINNAME & DOMAIN & MSID & IMSI & IPADDRESS & IPMASK & IPPOOLID & IPPOOLNAME & IPPOOLTYPE & MAXUSERNUMBER & TEMPLATEID & TEMPLATENAME & TEMPLATETYPE & RESETINTERVAL & STATUS & LOCKFLAG & PWATTEMPT & LOCKTIME & REGTIME & DEREGTIME & AUTHTYPE & USERGROUPID & GROUPNAME & PAIDTYPE & USERTYPE & NEWGROUPID & NEWGROUPNAME & NEWGROUPEFFECTTIME & ACCOUNTLEFT & RESERVETOTAL




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

REGTIME: time when the account is registered. (The value is in the YYYYMMDDHHMMSS format.)

DEREGTIME: time when the account is deregistered

AUTHTYPE: authentication type GROUPNAME: name of the user group

PAIDTYPE: payment type of the user

USERTYPE: user type NEWGROUPID: ID of the new user group

NEWGROUPNAME: name of the new user group

NEWGROUPEFFECTTIME: time when the new user group takes effect

ACCOUNTLEFT: total balance RESERVETOTAL: total amount reserved for all the services

RESULT List of queried data. Every two parameters are separated with the & symbol, and every two parameter values are separated with the | symbol.



Scenario The infoX-AAA responds to the successful running of the command for querying a WCDMA user.

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



& 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


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


Whether Can Be Null

Value Range

LOGINNAME

Login name of the WCDMA user. NOTE

In the command, this parameter is used to locate the user record and cannot be modified.

No No A string of 1 to 20 bytes, consisting of characters, numerals, periods, minus signs, and underscores.

DOMAIN Domain that the WCDMA user belongs to. NOTE

In the command, this parameter is used to locate the user record and cannot be modified.

No No A string of 1 to 40 bytes, consisting of letters, numerals, periods, and minus signs.

APNNAME APN name. Yes Yes A string of 1 to 64 bytes, consisting of non-reserved characters.





Whether Can Be Null

Value Range


Yes Yes A numeric string of 1 to 20 bytes.


Yes Yes A string of 1 to 20 bytes. The value of this parameter can contain non-reserved characters.

IPADDRESS Static IP address of a WCDMA user. The value must be converted into a decimal integer.


IPMask Subnet mask of an IP address.


IPPoolID ID of the IP address pool.

Yes No A decimal integer that is equal to or greater than –1.

MaxUserNumber

Maximum 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 0: normal. 1: frozen. 2: deregistered.

RESETINTERVAL

Interval for automatic resetting after the account of a WCDMA user is locked, in days.





Whether Can Be Null

Value Range

LOCKFLAG Lock flag of a WCDMA user.

Yes No A string of 1 byte.

PSWD Password of a user.


NEWGROUPID ID of the new

user group.

Yes No The value –1 or a decimal integer that is greater than 0.

NEWEFFECTTIME



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

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.

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.




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.








0: Succeeded in modifying the WCDMA user. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1000: Sorry, the proper APN does not exist. 1001: Sorry. The WCDMA user does not exist. 1004: Sorry, the mobile phone number already exists.

1004: Sorry, no matching WCDMA user exists. 1005: Sorry, IMSI is required. 1013: Sorry, the IP address pool does not exist. 1020: Sorry, the WCDMA user isn't locked. 1020: Sorry, the domain does not exist. 1020: Sorry, the static IP address already exists. 1080: Parameter MAXUSERNUMBER incorrect. 1119: Sorry, the management of user can't choose skipping domain.

1055: Sorry, the new group information has not been updated, so you cannot modify user group information.

1055: Sorry, the new user group could not be the same as the original user group.

1056: Sorry, the new user group does not exist. 1057: Sorry, the service of new user group does not exist.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Succeeded in modifying the WCDMA user.






Scenario The infoX-AAA responds to the successful running of the command for the operator to modify the information about a WCDMA user.

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


Whether Can Be Null

Value Range



APNNAME APN name. Yes No A string of 1 to 64 bytes, consisting of non-reserved characters.

STARTMSID Start mobile phone number of a batch.


ENDMSID End mobile phone number of a batch.





Whether Can Be Null

Value Range

USERGROUPID ID of the group that the WCDMA user belongs to.


PAIDTYPE Payment type that the WCDMA user selects.


USERTYPE Type of the prepaid user.

Yes No 1: local network 2: IN

Instance The following is an instance of running the command for adding WCDMA users in batches.

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.

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.









0: Adding batch account succeeded. 3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The SMP database operation failed. 1000: Sorry, the proper APN does not exist. 1010: Querying license's authorization and current useable information failed.

1012: Sorry. The license you want to query does not exist.

1100: Sorry, the license is not enough. 1052: Sorry, the user group does not exist. 1053: Sorry, the user group does not have any service.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Adding batch account succeeded.



Scenario The infoX-AAA responds to the successful running of the command for adding WCDMA users in batches.

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



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


Whether Can Be Null

Value Range

STARTMSID Start mobile phone number of a batch.


ENDMSID End mobile phone number of a batch.


Instance The following is an instance of running the command for deleting WCDMA users in batches.

Scenario − The start mobile phone number is 13800000000. − The end mobile phone number is 13800009999.

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.









0: Deleting batch subscribers succeeded.


7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data.

14: The database operation failed. 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. When RETN is 0, this parameter is Deleting batch account succeeded.



Scenario The infoX-AAA responds to the successful running of the command for deleting WCDMA users in batches.

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.



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


Whether Can Be Null

Value Range

LOGINNAME Login name of a WCDMA user.

Yes No A string of 1 to 20 bytes, consisting of characters, numerals, periods, minus signs, and underscores.


Yes No A string of 1 to 40 bytes, consisting of letters, numerals, periods, and subtraction signs.



Instance The following is an instance of running the command for resetting a WCDMA user.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is usr-psw-callnum. − The MSID parameter is 13851771249.

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.









0: Succeed in resetting the concurrent number of account.

3: The transaction control flag is incorrect. 7: System internal error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1001: Sorry. The WCDMA user does not exist.


A string of 0 to 256 bytes. When RETN is 0, the parameter is Succeed in resetting the concurrent number of account.



Scenario The infoX-AAA responds to the successful running of the command for resetting a WCDMA user.

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


Function This command is used to change the password of a WCDMA user.



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


Whether Can Be Null

Value Range

DOMAIN Domain that the WCDMA user belongs to.


LOGINNAME Login name of the WCDMA user.




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.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is test-usr-psw-msid. − The PSWD parameter is 000000.

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





Function The command is used to respond to the command for changing the password of a WCDMA user.






0: Modifying password succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1001: Sorry, the WCDMA user does not exist. 1020: Sorry, the domain does not exist. 1004:Sorry, the subscriber cannot change the password.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Modifying password succeeded.



Scenario The infoX-AAA responds to the successful running of the command for the operator to change the password of a WCDMA user.

Command ACK: MOD C260 ACCOUNT:RETN=0,DESC="Modifying password succeeded.";

6.2.17 Command for Unlocking a WCDMA User




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


Whether Can Be Null

Value Range







LOCKFLAG Lock flag of the user.

Yes No 0: available

Instance The following is an instance of running the command for unlocking the WCDMA user.

Scenario − The LOGINNAME parameter is sun. − The LOCKFLAG parameter is 0. − The DOMAIN parameter is test-usr-psw-msid.

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.




6.2.18 ACK to the Command for Unlocking a WCDMA User


Function The command is used to respond to the command for unlocking a WCDMA user.






0: Succeeded in unlocking the WCDMA user. 3: The transaction control flag is incorrect. 7: System internal error. 8: Invalid parameter. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1001: Sorry, the WCDMA user does not exist. 1020: Sorry, the WCDMA user is not locked.


A string of 0 to 256 bytes. When the value of RETN is 0, the value of this parameter is Succeeded in unlocking the WCDMA user.



Scenario The infoX-AAA responds to the successful running of the command for unlocking the WCDMA user.

Command ACK: MOD C260 ACCOUNT:RETN=0,DESC="Succeeded in unlocking the WCDMA user.";



6.2.19 Command for Recharging a Prepaid WCDMA 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


Whether Can Be Null

Value Range


Yes No A string of 1 to 40 bytes, consisting of letters.





CHGVAL Amount to be recharged.

No No From one to the maximum balance of a prepaid account.

Instance The following is an instance of running the command for recharging a prepaid WCDMA account.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is test-usr-psw-msid. − The CHGVAL parameter is 5000.

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.




6.2.20 ACK to the Command for Recharging a Prepaid WCDMA Account


Function This command is used to respond to the command for recharging a prepaid WCDMA account.






0: Cash recharge succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1001: Sorry, the WCDMA user does not exist. 1282: The user is to be deleted, and can't be recharged.

1283: The user has been suspended, and can't be recharged.

1284: The postpaid user can't be recharged. 1285: Sorry, the roam prepaid user cannot be recharged.

1286: UppLimitB does not exist. 1287: The amount of the account overflow after the account is recharged.

1288: The amount of the account exceeds the upper limit after the account is recharged.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Cash recharging succeeded.





Scenario The infoX-AAA responds to the successful running of the command for recharging a prepaid WCDMA account.

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


Whether Can Be Null

Value Range







SERVICEID Service ID. No No A decimal integer that is greater than 0.




Instance The following is an instance of running the command for ordering a service for the WCDMA user.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is nanjing. − The SERVICEID parameter is 2.

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.








0: Add order service success. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: The operation timed out. 12: You are unauthorized to access the data. 14: The database operation failed. 1281: Sorry, the abnormal user can not charge order. 1282: Sorry, the user who is not prepaid can not charge order.

1283: Sorry, the account does not exist. 1284: Sorry, the service is not the usergroup-service. 1285: Sorry, the service has been ordered.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Add order service success.



Scenario The infoX-AAA responds to the successful running of the command for the operator to order a service for the WCDMA user.

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




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


Whether Can Be Null

Value Range







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.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is nanjing. − The SERVICEID parameter is 2.

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



Function The command is used to respond to the command for canceling the order of a WCDMA user.






0: Canceling the order succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The SMP database operation failed. 1281: Sorry, the abnormal user can not charge order. 1282: Sorry, the user who is not prepaid can not charge order.

1283: Sorry, the account does not exist. 1285: Sorry, the user have not order this service.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Canceling the order succeeded.



Scenario The infoX-AAA responds to the successful running of the command for the operator to cancel the order of the WCDMA user.

Command ACK: DEL C260 ORDER:RETN=0,DESC="Canceling the order succeeded";




6.2.25 Command for Querying for the Bills of a WCDMA User


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


Whether Can Be Null

Value Range





MSID Mobile phone number. Yes No A numeric string of 1 to

20 bytes.

BILLTIME Time when the bill is generated.

No No Format: YYYYMMDDhhmmss

Instance The following is an instance of running the command for querying for the bills of a WCDMA user.

Scenario − The LOGINNAME parameter is 13800000000. − The DOMAIN parameter is nanjing. − The BILLTIME parameter is 20070801000000.

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.2.26 ACK to the Command for Querying for the Bills of a WCDMA User


Function This command is used to respond to the command for querying for the bills of a WCDMA user.




RETN Return codes of the ACK command. A decimal integer. The return codes are as follows:

0: Querying the bill succeeded. 3: The transaction control flag is incorrect.

7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data.


1001: Sorry, the WCDMA user does not exist.

1290: The postpaid subscribe cannot query bill.

1292: Sorry, the bill does not exist.

DESC Description of the return codes. A string of 0 to 256 bytes. When RETN is 0, this parameter is Querying the bill succeeded.


TOTAL Total number of lines of the query results.

A decimal integer.





FINISHED Flag that shows whether the operation is complete.

0: incomplete 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.




ATTR List of query attribute names that are separated by the & symbol. The attribute names are as follows:

STREAMNUMBER: stream number ACCOUNTREASON: reason for accounting

USERNAME: login name DOMAIN: domain name USERTYPE: user type APNNAME: APN that a user belongs to

USERIP: user's IP address IMSI: IMSI number of the user's mobile phone

CALLINGSTATIONID: calling number

SESSIONID: session ID CHARGEID: ID of the charge policy PDPTYPE: Packet Data Protocol (PDP) type

SERVICESTARTTIME: online duration

STARTTIME: time when the previous accounting request is sent

ENDTIME: current request time TIMELENGTH: Charging duration CHARGEVOLUMN: charging volume FEE: fee for the Internet access GROUPID: ID of the user group SERVICEID: service ID SERVICENAME: service name SGSNIP: IP address of the serving GPRS support node (SGSN)

GGSNIP: IP address of the gateway GPRS support node (GGSN)

RATINGGROUP: flag of the rating group

TERMCAUSE: reason why the session terminates

MSID: mobile phone number USERNAME: User's login name DOMAIN: home domain of the user USERIP: user's IP address CORRELATIONID: ID of the accounting session

ACCOUNTREASON: accounting reason

SERVICENAME: service name STARTTIME: start time of the

h i

The value must be the following string: STREAMNUMBER & ACCOUNTREASON & USERNAME & DOMAIN & USERTYPE & APNNAME & USERIP & IMSI & CALLINGST ATIONID & SESSIONID & CHARGEID & PDPTYPE & SERVICESTARTTIME & STARTTIME & ENDTIME & TIMELENGTH & CHARGEVOLUMN & FEE & GROUPID & SERVICEID & SERVICENAME & SGSNIP & GGSNIP & RATINGGROUP & TERMCAUSE





SERVICESTARTTIME: online duration

ENDTIME: end time of the charging SESSIONTIME: session duration SESSIONVOLUME: session volume RATEPOLICYIDX: charge policy FEE: fee for Internet access this time USERGROUPID: ID of the user group SERVICEID: service ID

RESULT List of the queried data. Every two parameters are separated with the & symbol, and every two parameter values are separated with the | symbol.

Result set returned by the operation command based on the actual situation.


Scenario The infoX-AAA responds to the successful running of the command for querying for the bills of the WCDMA user.


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



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


Whether Can Be Null

Value Range





SERVICEID ID of the service that a CDMA user wants to query for.

Yes No A positive integer from 1 to 2147483647.

Instance The following is an instance of running the command to query for the start time and accumulative service usage of a service.


Command QUERY C260 USAGE:LOGINNAME="sun",DOMAIN="usr-psw-imsi"




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.

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.






RETN Returned value of the ACK command. A decimal integer. 0: Querying for the service start time and accumulative service usage succeeded.






1294: Sorry, only a prepaid user can query for the service usage.

1295: Sorry, the service subscribed by the subscriber does not exist.


When RETN is 0, this parameter is Querying for the service start time and accumulative service usage succeeded.











LASTDEDUCTTIME: Last time the basic fee is deducted (time a service is enabled for a user. If 19700101000000 is returned, it indicates that the service is not enabled.)

ACCUTIME: accumulative duration, in seconds. When the value is greater than 0, the parameter is valid.

ACCUFLOW: accumulative volume, in KB. When the value is greater than 0, the parameter is valid.

The value must be the following string: LASTDEDUCTTIME & ACCUTIME & ACCUFLOW

RESULT List of queried data.Every two lines are separated by the & symbol, and every two parameters are separated by the | symbol.



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.

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|",;

infoX-AAA Interface Developer Guide - MML 7 MML Interfaces for WiMAX Service


7 MML Interfaces for WiMAX Service

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

7 MML Interfaces for WiMAX Service infoX-AAA



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


Whether Can Be Null

Value Range

USERGROUPID User group that a WiMAX user belongs to.


DOMAIN Home domain of a WiMAX user.

No No A string of 1 to 40 bytes, consisting of letters, numerals, periods, or minus signs. The string cannot start or end with a period or minus sign.




Whether Can Be Null

Value Range

LOGINNAME Login name of a WiMAX user.


PAIDTYPE Payment type of a WiMAX user.


CHARGEAMOUNT

Amount recharged when a user is added. NOTE

This parameter must be omitted for a postpaid user.

Yes No A decimal integer that is greater than 0.

PSWD Password of a WiMAX user.


MSID ID of a mobile station.

Yes No The value must be a hexadecimal string of 12 bytes.

IPASSIGNWAY Mode of assigning the IP address

No No 0: not assign 1: static IP address 2: dynamic IP address

IPADDRESS IP address that is assigned statically to the WiMAX user.




IPPOOLID ID of an IP address pool.

Yes No The numeral –1 or a decimal integer that is greater than 0.

TEMPLATEID Template ID of a WiMAX user.


BSID ID of the base station that a user belongs to.





Instance The following is an instance of running the command for adding a WiMAX user.

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.

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.

When Authtype of a domain is 1, MSID cannot be omitted. When Authtype of a domain is 3, PSWD and MSID cannot be omitted. When Authtype of a domain is 5, LOGINNAME and MSID cannot be omitted. When Authtype of a domain is 6, LOGINNAME and PSWD cannot be omitted. 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: When IPASSIGNWAY is 0, IPAddress, IPMASK, and IPPOOLID must be omitted. When IPASSIGNWAY is 1, IPADDRESS and IPMASK cannot be omitted, but IPPOOLID must

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







A decimal integer. 0: Adding user succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1046: Sorry, the license is not enough. 1047: Sorry, the License which is queried does not exist.

1067: Sorry, Need Skip Domain can not be used in user management.

1057: Sorry, the domain does not exist. 1052: Sorry, the account has existed. 1071: Sorry, the uplimit of the charge amount of B card does not exist.

1072: Sorry, charge amount exceeds uplimit. 1037: Sorry, the user group does not exist. 1069: Sorry, BSID should be input while user group type is fixed.

1070: Sorry, BSID should not be input while user group type is not fixed.

1066: Sorry, MSID has been used. 1058: Sorry, the template does not exist. 1055: Sorry, the IP address has been referenced. 1056: Sorry, the IP address pool does not exist.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Adding user succeeded.






Scenario The infoX-AAA responds to the successful running of the command for adding a WiMAX user.

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


Whether Can Be Null

Value Range


No No A string of 1 to 20 bytes, consisting of letters, numerals, periods, minus signs, or underscores.



REMOVEALL Whether to delete all the user information.

Yes No 0: Reserve the user information.

1: Delete the user information.



Instance The following is an instance of running the command for deleting a WiMAX user.

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.

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.





A decimal integer. 0: Deleting user succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1046: Sorry, the user does not exist. 1059: The user information has been deleted. 1060: Sorry, the user is being deducted, and can not be deleted.






A string of 0 to 256 bytes. When RETN is 0, this parameter is Deleting user succeeded.



Scenario The infoX-AAA responds to the successful running of the command for the operator to delete the information about a WiMAX user.

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.


Whether Can Be Null

Value Range

DOMAIN Home domain of a WiMAX user. Do not modify the value of this parameter.





Whether Can Be Null

Value Range

LOGINNAME Login name of a WiMAX user. Do not modify the value of this parameter.


USERGROUPID User group that a WiMAX user belongs to. Do not modify the value of this parameter.


NEWUSERGROUPID

New user group that the user belongs to.


NEWGRPEFFECTTIME


The value of this parameter cannot be earlier than the current system time.


MSID ID of a mobile station.

Yes Yes The value must be a hexadecimal string of 12 bytes.

IPASSIGNWAY Mode for assigning the IP address.

No No 0: not assign 1: static IP address 2: dynamic IP address

IPADDRESS IP address that is assigned statically to a WiMAX user.








Whether Can Be Null

Value Range



TEMPLATEID Template ID of a WiMAX user.


BSID ID of the base station that a WiMAX user belongs to.


STATUS User state. Yes No 0: normal 1: suspended

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

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.

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



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.

When Authtype of a domain is 1, the MSID cannot be omitted. When Authtype of a domain is 3, the PSWD and MSID cannot be omitted. When Authtype of a domain is 5, the LOGINNAME and MSID cannot be omitted. When Authtype of a domain is 6, the LOGINNAME and PSWD cannot be omitted. 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: When IPASSIGNWAY is 0, IPAddress, IPMASK, and IPPOOLID must be omitted. When IPASSIGNWAY is 1, IPADDRESS and IPMASK cannot be omitted, but IPPOOLID must

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








A decimal integer. 0: Modifying user succeeded. 0: Modifying the password succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1048: Sorry, MSID should be input. 1057: Sorry, the domain does not exist. 1046: Sorry, the user does not exist. 1061: Sorry, the group ID does not match original group ID.

1062: Sorry, the new group information has not been updated, so you can not modify user group information.

1073: Sorry, the MSID cannot be modified when authenticating MSID or authenticating password and MSID.

1068: Sorry, new user group information does not exist.

1066: Sorry, MSID has been used. 1058: Sorry, the template does not exist. 1055: Sorry, the IP address has been referenced. 1056: Sorry, the IP address pool does not exist.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Modifying user succeeded.





Scenario The infoX-AAA responds to the successful running of the command for the operator to modify the information about a WiMAX user.

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


Whether Can Be Null

Value Range

LOGINNAME Login name of the WiMAX user.


DOMAIN Home domain of the WiMAX user.





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

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is test-usr-psw-msid.

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.





A decimal integer. 0: Querying user succeeded. 3: The transaction control flag is incorrect.

7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data.

14: The database operation failed. 1046: Sorry, the user does not exist.




DESC Description of the error cause. A string of 0 to 256 bytes. When RETN is 0, this parameter is Querying user succeeded.


TOTAL Total number of lines of the queried results.

A decimal integer.

FINISHED Whether the operation ends. 0: not end 1: end

START Start line number of the current batch.

A decimal integer.

ROWNUM Record numbers of the current batch. A decimal integer.





ATTR List of query attribute names that are separated by the & symbol. The following parameters are included:

LOGINNAME: login name DOMAIN: home domain USERGROUPID: user group ID USERGROUPNAME: user group name

PAIDTYPE: paid type of the WiMAX user

MSID: MSID of a WiMAX user IPASSIGNWAY: mode of assigning the IP address

IPADDRESS: IP address that is assigned statically

IPMASK: subnet mask of the IP address

IPPOOLID: ID of the IP address pool

IPPOOLNAME: name of the IP address pool

TEMPLATEID: template ID TEMPLATENAME: template name

NEWUSERGROUPID: new user group ID

NEWUSERGROUPNAME: new user group name

NEWGRPEFFEC TTIME: time when the new user group takes effect

BSID: BSID that a user belongs to STATUS: status of a user

The value must be the following string: LOGINNAME & DOMAIN & USERGROUPID & USERGROUPNAME & PAIDTYPE & MSID & IPASSIGNWAY & IPADDRESS & IPMASK & IPPOOLID & IPPOOLNAME & TEMPLATEID & TEMPLATENAME & NEWUSERGROUPID & NEWUSERGROUPNAME & NEWGRPEFFECTTIME & BSID & STATUS

RESULT List of queried data. Every two lines are separated with the & symbol, and every two parameters are separated with the | symbol.




Instance The following is an instance how to run the ACK command.

Scenario The infoX-AAA responds to the successful running of the command for the operator to query for the information about a WiMAX user.

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


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


Whether Can Be Null

Value Range

LOGINNAME Login name of the WiMAX user.


DOMAIN Home domain of the WiMAX user.


PSWD New password. No No A string of 1 to 16 bytes, consisting of letters, numerals, periods, minus signs, or underscores.




Instance The following is an instance of running the command for changing the password of a WiMAX user.

Scenario − The LOGINNAME parameter is sun. − The LOGINNAME parameter is test-usr-psw-msid. − The PSWD parameter is 000000.

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


Function The command is used to respond to the command for changing the password of a WiMAX user.





A decimal integer. 0: Modifying password succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1046: Sorry, the user does not exist.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Modifying password succeeded.




Instance The following is an instance of running the ACK command for changing the password of a WiMAX user.

Scenario The infoX-AAA responds to the successful running of the command for the operator to change the password of a WiMAX user.

Command ACK:MOD C330 PASSWD:RETN=0,DESC="Modifying password succeeded.";

7.2.11 Command for Recharging a Prepaid WiMAX User


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


Whether Can Be Null

Value Range





CHGVAL Recharge amount, in cents.

No No From zero to the maximum balance of a prepaid account.




Instance The following is an instance of running the command for recharging a prepaid WiMAX user.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is test-usr-psw-msid. − The CHGVAL parameter is 5000 cents.

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


Function This command is used to respond to the command for recharging a prepaid WiMAX user.







A decimal integer. 0: Cash recharge succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data. 14: The database operation failed. 1083: The user is to be deleted, and can't be recharged.

1084: The user has been suspended, and can't be recharged.

1081: The postpaid user can't be recharged. 1085: Sorry, the account does not exist. 1086: UppLimitB does not exist. 1087: Account left overflow after charge. 1088: Account left exceeds the upper limit after charge.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Cash recharge succeeded.



Scenario The infoX-AAA responds to the successful running of the command for recharging a prepaid WiMAX user.

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




7.2.13 Command for Querying for the Bills of a WiMAX User


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


Whether Can Be Null

Value Range





BILLTIME Time when a bill is generated.

No No Format: YYYYMMDDhhmmss

Instance The following is an instance of running the command for querying for the bill of a WiMAX user.

Scenario − The LOGINNAME parameter is sun. − The DOMAIN parameter is test-usr-psw-msid. − The BILLTIME parameter is 20070601000000.

Command QUERY C330 BILL: BILLTIME="20070601000000", DOMAIN="test-usr-psw-msid",

LOGINNAME="sun"



7.2.14 ACK to the Command for Querying for the Bills of a WiMAX User


Function This command is used to respond to the command for querying for the bill of a WiMAX user.





A decimal integer. 0: Querying the bill succeeded. 3: The transaction control flag is incorrect. 7: Internal system error. 8: The parameter is incorrect. 11: Operation timeout. 12: You are unauthorized to access the data.

14: The database operation failed. 1085: Sorry, the account does not exist. 1082: The postpaid user cannot query bill. 1089: Sorry, the bill does not exist.


A string of 0 to 256 bytes. When RETN is 0, this parameter is Querying the bill succeeded.


TOTAL Total number of lines of the queried results.

A decimal integer.

FINISHED Whether the operation ends. 0: not end 1: end

START Start line number of the current batch.

A decimal integer.

ROWNUM Number of the records in the current batch.

A decimal integer.





ATTR List of query attribute names that are separated by the & symbols. The included parameters are as follows:

MSID: ID of the mobile station

USERNAME: user login name

DOMAIN: home domain of the user

USERIP: user IP address CORRELATIONID: RADIUS session ID

ACCOUNTREASON: accounting reason

SERVICENAME: service name

SERVICESTARTTIME: access time

STARTTIME: last request time

ENDTIME: current request time

SESSIONTIME: session duration

SESSIONVOLUME: session volume

RATEPOLICYIDX: charge policy

FEE: fee for Internet access in this time

USERGROUPID: user group ID

SERVICEID: service ID

The value must be the following string: MSID & USERNAME & DOMAIN & USERIP & CORRELATIONID & ACCOUNTREASON & SERVICENAME & SERVICESTARTTIME & STARTTIME & ENDTIME & SESSIONTIME & SESSIONVOLUME & RATEPOLICYIDX & FEE & USERGROUPID & SERVICEID

RESULT List of queried data. Every two lines are separated by the & symbol, and every two parameters are separated with the | symbol.





Scenario The infoX-AAA responds to the successful running of the command for querying for the bill of a WiMAX user.


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|";

infoX-AAA Interface Developer Guide - MML A Checksum’s code

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

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];

};

infoX-AAA Interface Developer Guide - MML B Acronyms and Abbreviations

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

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

Contents infoX-AAA


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

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



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

Contents infoX-AAA


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

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



V

VP Voice Peripheral

W

WCDMA Wide Code Division Multiple Access

WIN Wireless Intelligent Network

WCDMA Wide Code Division Multiple Access

infoX-AAA Interface Developer Guide - MML Index

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

Index

B broadband

registering a broadband User, 5-4 broadband

response to the command for registering a broadband user, 5-7

broadband modifying a broadband user, 5-10

broadband response to the command for modifying a broadband user, 5-13

broadband deregistering a broadband user, 5-15

broadband response to the command for deregistering a broadband User, 5-16

broadband querying a broadband user, 5-17

broadband response to the command for querying broadband user information, 5-18

broadband querying an account, 5-21

broadband response to the command for querying an account, 5-22

broadband activating an account, 5-26

broadband response to the command for activating an account, 5-27

broadband deactivating an account, 5-28

broadband response to the command for deactivating an account, 5-29

broadband resetting an account, 5-30

broadband response to the command for resetting an account, 5-31

broadband modifying a password, 5-32

broadband response to the command for modifying a password, 5-33

broadband port restriction, 5-34

broadband response to the command for port restriction, 5-35

broadband cash recharge, 5-36

broadband response to the command for cash recharge, 5-37

broadband rolling back cash recharge, 5-39

broadband response to the command for rolling back cash recharge, 5-39

broadband querying recharge records, 5-40

broadband response to the command for querying recharge records, 5-42

broadband querying bills, 5-45

broadband response to the command for querying bills, 5-46

broadband command for subscribing to broadband services, 5-49

broadband response to the command for subscribing to a broadband service, 5-51

broadband unsubscribing a broadband service, 5-54

broadband response to the command for unsubscribing a broadband service, 5-55

broadband querying subscribed broadband services, 5-57

broadband response to the command for querying subscribed services, 5-58

Index infoX-AAA


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

C cdma

deregistering a cdma user, 6-8 modify the user password, 6-19 modifying a cdma subscriber, 6-14 querying a cdma user, 6-11 registering a cdma user, 6-3 response to the command for deregistering a cdma user, 6-10 response to the command for modify the user password on the self-service system, 6-20 response to the command for modifying information of a cdma user, 6-16 response to the command for querying information of a cdma user, 6-12 response to thecommand for registering a cdma user, 6-6

D developer to the billing client

development flow, 2-2 developer to the billing client

overview, 2-2 developer to the billing client

Instance, 2-3

I interconnection debugging

debug method, 3-2 introduction to the mml interface, 1-2 introduction to the mml structure, 1-2

M mml interface

brief introduction, 1-2 format of a heartbeat message, 1-6

format of an ordinary message, 1-2 precautions about messages, 1-7

O operator

changing password, 4-6 login, 4-2 logout, 4-5 response to the command for changing password, 4-7 response to the command for login, 4-3 response to the command for logout, 4-5

P preparation before debugging, 3-2

W wcdma

deregistering a wcdma user, 7-7 deregistering wcdma users in batches, 7-20 modifying a wcdma subscriber, 7-14 querying a wcdma user, 7-10 registering a wcdma user, 7-3 registering wcdma users in batches, 7-18 response to command for modifying information of a wcdma user, 7-16 response to the command for deregistering a wcdma user, 7-8 response to the command for deregistering wcdma users in batches, 7-21 response to the command for querying information of a wcdma user, 7-11 response to the command for registering a wcdma user, 7-5 response to the command for registering wcdma users in batches, 7-19

i.

InfoX-AAA Interface Developer Guide - MML

Documents

Transcript of InfoX-AAA Interface Developer Guide - MML