USDP
SOAP Interface Reference
Contents
Contents
2 Interface Description .................................................................................................................2-7
2.1 The Interface Function Module ..................................................................................................................... 2-8
2.2 Interface Structure ......................................................................................................................................... 2-8
2.3 Generic Interface Parameter Objects ............................................................................................................. 2-9
2.3.1 Input Parameter Event Object ............................................................................................................ 2-10
2.3.2 Response ............................................................................................................................................ 2-14
2.3.3 Phone Number Formats ..................................................................................................................... 2-15
2.3.4 Handling Parameter Values ................................................................................................................ 2-15
2.4 Authority Authentication ............................................................................................................................. 2-16
2.5 Interface Capability ..................................................................................................................................... 2-16
Issue 01 (2015-06-05)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
i
USDP
SOAP Interface Reference
Figures
Figures
Figure 2-1 Structure of the input parameter event object ................................................................................. 2-10
Figure 2-2 Operation procedure of Response ................................................................................................... 2-14
Issue 01 (2015-06-05)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
iii
USDP
SOAP Interface Reference
Tables
Tables
Table 2-1 Attribute fields of BaseEvt ............................................................................................................... 2-10
Table 2-2 Attribute fields of BaseUpdateEvt .................................................................................................... 2-12
Table 2-3 Attribute fields of BaseQueryEvt ...................................................................................................... 2-14
Table 2-4 Attribute fields of Response ............................................................................................................. 2-15
Table 2-5 Attribute fields of BaseQueryResp ................................................................................................... 2-15
Table 2-6 Phone number formats ...................................................................................................................... 2-15
Issue 01 (2015-06-05)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
v
USDP
SOAP Interface Reference
2 Interface Description
2
Interface Description
About This Chapter
The following table lists the contents of this chapter.
Section
Describes
2.1 The Interface Function Module
The modules that are provided by the USDP.
2.2 Interface Structure
The interface structure, including input
parameters and return parameters.
2.3 Generic Interface Parameter Objects
The generic interface parameter objects.
2.4 Authority Authentication
The authority authentication when Portals
access the USDP.
2.5 Interface Capability
The precautions of the interface capability.
Issue 01 (2015-06-05)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
7
USDP
SOAP Interface Reference
2 Interface Description
2.1 The Interface Function Module
This version contains the following interface function modules:

UserManage

UserToneManage
2.2 Interface Structure
An interface consists of two types of parameters: input parameter and return parameter.
Input Parameter
Requirements for input parameters are as follows:

All the input parameters are encapsulated into the request event object of the input
parameter for transfer.

Do not need to configure input parameters that can be null.

For the request event object of the input parameter with two input parameters but only
one is required, configure only one of them and keep the other one as null.
Return Parameters
Requirements for return parameters are as follows:

All the results are returned by the response objects of all types of operation result, and
the returned content should contain the return result code of this operation at least.

Other information contained in the response object of the operation result varies with
interface functions.
The query interface does not provide the parameter verification function.
The results are returned based on the query type you select.

If you select the number of queried records as the query type
There are no records meeting the query condition, the return code 000000 indicating
success is returned, and a prompt indicating no records is returned.
For example, when you query the RBT settings of a non-RBT subscriber, the prompt
indicating no records rather than the error code 301001 is returned.

If you select the queried record set as the query type
There are no records meeting the query condition, the return code 000000 indicating
success is returned, and the output parameter returns a null record set.
For example, when you query the RBT settings of a non-RBT subscriber, the prompt
indicating a null record set rather than the error code 301001 is returned.

If you select the result set as the query type.
The recordSum variable of the return object is invalid. If you select the total number of
results as the query type, the recordSum variable of the return object is correct.
For example, if you select result set as the query type, and enter 1 for start, 3 for end,
the system displays the query results for records 1, 2 and 3; if you select the total number
8
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
Issue 01 (2015-06-05)
USDP
SOAP Interface Reference
2 Interface Description
of results as the query type, the system displays 10 for recordSum as the query result. In
this case, you do not need to enter 1 for start, and 3 for end. The query mode is used for
paging query. More exactly, the total number of results are queried, which is used to
divide the number of records displayed on each page, and then you can learn the total
number of pages. Then, by entering the start number of records on each page, you can
query the result set of each page.
2.3 Generic Interface Parameter Objects
General parameter objects include input parameter event object and return parameter object.
Issue 01 (2015-06-05)

If there is a default value in the setting of a field table, the developer can set the field to null.

If the value of a field is set to null, the system invokes the default value of the field automatically.
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
9
USDP
SOAP Interface Reference
2 Interface Description
2.3.1 Input Parameter Event Object
The input parameter event object includes BaseEvt (Base input parameter event object),
BaseUpdateEvt (Update operation event object), BaseQueryEvt (Query operation event
object).
Figure 2-1 shows the operation structure of the input parameter event object.
Figure 2-1 Structure of the input parameter event object
BaseEvt
BaseUpdateEvt
BaseQueryEvt
AddAdminEvt
DelAdminEvt
QueryAdminEvt
EditAdminEvt
BaseEvt
The USDP checks the authentication of the account and password of the accessing party.
Different interfaces have the authority to control different accessing parties.
Table 2-1 lists the attribute fields of BaseEvt.
Table 2-1 Attribute fields of BaseEvt
Field
Description
Setting
portalAccount
Account used by an
external party for
accessing the USDP.
A string of 1 to 20 characters
Password used by an
external party for
accessing the USDP.
A string of 1 to 20 characters
Portal type.
A string of 1 to 2 digits.
portalPwd
portalType
It cannot be null.
It is assigned to the accessing party by the
carrier.
It cannot be null.
It is assigned to the accessing party by the
carrier.
It can be null. The default value is 99.
The value, -1 indicates that all portal types are
10
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
Issue 01 (2015-06-05)
USDP
SOAP Interface Reference
Field
2 Interface Description
Description
Setting
supported.
Refer the following codes for types:
Issue 01 (2015-06-05)

0: Portal used by the USDP system while
processing tasks and jobs.

1: Web Portal

2: IVR Portal

3: WAP Portal

4: SMS Portal

5: USSD Portal

6: SMP Portal

7: Customer Service (CS) Portal

8: SMAP Portal

9: BOSS Portal

10: OMD Portal

11: PUSH

12: Gateway

13: PLUS

14: OWA

15: NUM 12580

16: SPMC

17: ISMP

18: Reliance SMS

19: Reliance Web

20: Reliance R-world

21: Reliance OBD

22: Reliance VP

23: Huawei CS (Huawei CS will send request
to Reliance Sub App.)

24: Reserved 1 (for Reliance, can be used for
bulk subscription)

25: Reserved 2 (for Reliance)

26: Reserved 3 (for Reliance)

27: IVR outcall

28: WAD Advertisement Platform Portal

29: External WEB (Russia Megafon)

30: External WAP (Russia Megafon)

31: External IVR (Russia Megafon)

32: External SMS (Russia Megafon)

33: External USSD (Russia Megafon)

34: External DSTK (Russia Megafon)

35: Partners (Russia Megafon)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
11
USDP
SOAP Interface Reference
2 Interface Description
Field
Description
Setting

36: PortalEngine (PE for MDSP solution)

37: MDSP

38: Hang-up SMS

39: Group send SMS

44: Caller RBT WEB (Russia Megafon)

45: Caller RBT SMS (Russia Megafon)

46: Caller RBT IVR (Russia Megafon)

47: Caller RBT WAP (Russia Megafon)

48: Caller RBT USSD (Russia Megafon)

49: AD Platform

51: Social Networking

52: CS Batch Operation

53: Music Platform

55: Music Solution Platform

98: HMDP (RBT GW)

99: Internal portal of the USDP system
BaseUpdateEvt
The events for adding, updating and deleting are based on BaseUpdateEvt.
Table 2-2 lists the attribute fields of BaseUpdateEvt.
Table 2-2 Attribute fields of BaseUpdateEvt
Field
Description
Setting
moduleCode
Module code.
A string of 1 to 20 digits
This field is used to
distinguish the CP
device when the CP
counts fees.
It can be null. The default value is 000000.
For example, after a
subscriber downloads
an RBT through the
gateway, the system
judges the CP device
of the RBT through
this field.
12

Set moduleCode =1560000010302 and
PortalType=55 for Music APP humming
search.

Set moduleCode =1560000010602 and
PortalType=55 for Music IVR humming
search.
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
Issue 01 (2015-06-05)
USDP
SOAP Interface Reference
2 Interface Description
Field
Description
Setting
role
Operator type.
A string of 1 digit
It cannot be null. The default value is 1.
See the following codes for types:
roleCode
Operator code.

0: internal device of the system

1: end user

2: CP

3: system administrator

4: corp operator

5: CS personnel

6: Department operator of a corp

99: External account
A string of 1 to 128 alphanumeric characters
including ~ ! $ % ^ & * ( ) - _ = + [ ] { } ; : \ '
" , < > / ? . \ @.
It cannot be null.
Operator codes vary with types.

When role is set to 0, this parameter represents
a device account or a Portal number.

When role is set to 1, this parameter represents
the phone number of the end user.

When role is set to 2, this parameter represents
the CP code.

When role is set to 3, this parameter represents
the code of the system administrator.

When role is set to 4, this parameter represents
the code of corp operator.

When role is set to 5, this parameter represents
the code of the CS personnel.

When role is set to 6, this parameter represents
the code of the department operator of the corp.

When role is set to 99, this parameter
represents the account code of the external
BaseQueryEvt
All the query operation event objects are successive to BaseQueryEvt.
Table 2-3 lists the attribute fields of BaseQueryEvt.
Issue 01 (2015-06-05)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
13
USDP
SOAP Interface Reference
2 Interface Description
Table 2-3 Attribute fields of BaseQueryEvt
Field
Description
Setting
startRecordNum
Start record identifier (ID).
A string of 1 to 8 digits
In the query operation, if there
are multiple records in a result
set, the system displays the
records in paging. This field
indicates the number of the first
record displayed on a page.
It can be null.
End record identifier.
A string of 1 to 8 digits
In the query operation, if there
are multiple records in a result
set, the system displays the
records in paging. This field
indicates the number of the last
record displayed on a page.
It can be null.
Type of return results.
A string of 1 digit
endRecordNum
queryType
The default value is 1.
The default value is 50.
If the value of startRecordNum
exceeds the value of endRecordNum,
data cannot be queried.
It can be null. The default value is
2.
Type of return results
See the following codes for types:

1: total number of return query
results

2: set of returned query results
Note:
The limit count for the number of records to be queried is the difference between endRecordNum and
startRecordNum. This value is defined in the table, t_api_limit_config.
2.3.2 Response
Figure 2-2 shows the operation procedure of Response.
Figure 2-2 Operation procedure of Response
Respone
BaseQueryResp
AddOperatorResp
QueryCSResp
Response consists of the BaseQueryResp (query event object) events.
14
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
Issue 01 (2015-06-05)
USDP
SOAP Interface Reference
2 Interface Description
Table 2-4 lists the attribute fields of Response.
Table 2-4 Attribute fields of Response
Field
Description
Setting
returnCode
Return code.
A string of 6 digits
It cannot be null.
Table 2-5 lists the attribute fields of BaseQueryResp.
Table 2-5 Attribute fields of BaseQueryResp
Field
Description
Setting
recordSum
Number of return result sets.
A string of 1 to 20 digits
It can be null.
2.3.3 Phone Number Formats
Table 2-6 lists the different types of phone number formats supported by the USDP system.
Table 2-6 Phone number formats
Mode
Length
Values
Examples
Non-IMS

0-9

12345678901234567890

1234-5678901234567891

234-56789012345678912

34-345678912345678901

6-1234567891234567899

IMS
1 to 20 digits
1 to 21 digits including
a - (hyphen)
1 to 128 characters

0-9

12345678901234567891

a-z

huawei@huawei.com

A-Z

Special characters
such as @.-_
2.3.4 Handling Parameter Values
The number of elements in the array can be configured by changing the value in the file,
param_valid_conf_soap.xml based on actual requirements of a carrier.
Example1:
To change the value of phonenumber from 50 to 100 in the response parameter CsSubscribeEvt of
userManage module, change the value defined in maxlength from 50 to 100.
Issue 01 (2015-06-05)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
15
USDP
SOAP Interface Reference
2 Interface Description
To change the value of the parameter resourceServiceType, if this parameter is NOT null, then
the length of this array should be same as the phoneNumber field. If the value of the parameter,
phonenumber is changed to 100, then the value of the parameter, resourceServiceType should be
changed to 100 as well.
2.4 Authority Authentication
When deploying the simple object access protocol (SOAP) service, the USDP server allocates
the client-accessing Portals with different accounts and passwords based on different types of
client-accessing Portals. Different Portals can access different SOAP services. To access an
SOAP service, a client-accessing Portal must have corresponding authorities.
Therefore, correct account and password must be entered before the client sends SOAP
messages to the server, during which the account and password are transmitted in encrypted
text.
Example
The account and password for accessing client-accessing Portal provided by the server must
be correctly configured in invocation code before Portals use the external interfaces of the
SOAP service provided by Apache axis.
Program codes are as follows:
org.apache.axis.client.Call_call =(org.apache.axis.client.Call) super.service.createCall();
_call.setUsername (“webPortal001”);
_call.setPassword (“12345678”);
2.5 Interface Capability
In view of interface capability, the WSDL of the new version is needed for the RBT service.
16
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
Issue 01 (2015-06-05)
USDP
SOAP Interface Reference
2 Interface Description
The USDP will add new parameters to the SOAP interfaces which can return null in response.
If the customer does not use the new parameters, then only the USDP is upgraded and there
are no changes from the invoking party end. In this case, the invoking party such as the RBT
system, VXML, GW, and third party RBT systems must ensure that their systems can run
smoothly with the new USDP version.
The reason is as explained below:
If the invoking party uses Apache Axis1.X, SOAP client cannot parse the new parameters of
response normally and throws an exception even when the invoking party is not using these
parameters. In this case, the invoking party should resolve this defect by upgrading the Axis
or updating the SOAP client with the new WSDL.
Issue 01 (2015-06-05)
Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
17