Oracle® Communications Services Gatekeeper Application Developer's Guide Release 5.1 E37542-01 |
|
|
PDF · Mobi · ePub |
This chapter describes the supported Parlay X 3.0 interfaces and contains information that is specific for Oracle Communications Services Gatekeeper, and not found in the specifications. For detailed descriptions of the interfaces, methods, and parameters, refer to the specifications.
See the ETSI OSA Parlay X 3.0 specifications at:
http://www.etsi.org/deliver/etsi_es/202300_202399/20239111/01.02.01_60/es_20239111v010201p.pdf
The Parlay X 3.0 Part 2: Third Party Call, Parlay X 3.0 Part 3: Call Notification, and Parlay X 3.0 Part 11: Audio call interfaces interact with Services Gatekeeper Parlay compliant plug-ins. Together you use the interface/plug-in combinations to implement applications that use a combination of the services exposed by the interfaces. These services include:
Call setup
Call redirection and transfer
Playing of announcements
Collection of input from participants in the call using Dual-tone Multi-frequency (DTMF)
A call can have several participants. The call as a whole is represented by a callSessionIdentifier
, and each participant is identified by their URI (the phone number, with scheme tel:) can be added to the call.
Note:
When the call is initiated from an application, thecallSessionIdentifier
is returned from Services Gatekeeper when the call session is established. When the call is initiated from the network, the callSessionIdentifier
is provided by Services Gatekeeper in the requests that report the event.You manage application-initiated call setup, tear-down, and transfer using the Parlay X 3.0 Part 2: Third Party Call interfaces.
You subscribe for notification on network-initiated calls, and take action, depending on the events, using the Parlay X 3.0 Part 3: Call Notification interfaces.
You play announcements and initiate collecting input from call participants using the Parlay X 3.0 Part 11: Audio call interfaces. Results from the collection of input are reported using Parlay X 3.0 Part 3: Call Notification.
Parlay X 3.0 Part 11: Audio Call interfaces must be used together with either Parlay X 3.0 Part 2: Third Party Call or Parlay X 3.0 Part 3: Call Notification since Audio Call does not have any operations to establish a call.
The Third Party Call communication service interfaces comply with ETSI ES 202 504-2 v0.0.5 (2007-06) Open Service Access (OSA); Parlay X Web Services; Part 2: Third Party Call (Parlay X 3).
The ThirdPartyCall interface endpoint is:
http://
host
:
port
/parlayx30/third_party_call/ThirdPartyCall
.
where values for host and port depend on your Services Gatekeeper implementation.
Sets up a call between two parties.
MediaInfo must be set to NULL.
ChangeMediaNotAllowed must be set to false.
Table 9-1 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
TPC-000001 |
Error reported from the telecom network. |
SVC0001 |
TPC-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000001 |
Error reported from the telecom network. |
SVC0001 |
OSA-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000003 |
Error reported from the telecom network. |
SVC0001 |
OSA-000004 |
Error reported from the telecom network. |
SVC0001 |
OSA-000006 |
Error reported from the telecom network. |
SVC0001 |
OSA-000007 |
Error reported from the telecom network. |
SVC0001 |
OSA-000008 |
Error reported from the telecom network. |
SVC0001 |
OS-A000009 |
Error reported from the telecom network. |
SVC0001 |
OS-A000010 |
Error reported from the telecom network. |
SVC0001 |
OS-A000011 |
Error reported from the telecom network. |
SVC0001 |
OSA-000012 |
Error reported from the telecom network. |
SVC0001 |
OS-A000013 |
Error reported from the telecom network. |
SVC0001 |
OSA-000014 |
Error reported from the telecom network. |
SVC0001 |
OSA-000015 |
Error reported from the telecom network. |
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
N/A |
Incorrect input parameter. |
POL0001 |
N/A |
Faults related to policies associated with the service, including service level agreements. |
POL0008 |
N/A |
Charging not supported. |
POL0011 |
N/A |
Media type not supported. |
Adds a participant to an existing call session. The call session may have been established using makeCallSession or any of the methods in "Interface: CallDirection" and "Interface: CallNotification".
mediaInfo
must be set to NULL
.
Table 9-2 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
TPC-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000001 |
Error reported from the telecom network. |
SVC0001 |
OSA-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000003 |
Error reported from the telecom network. |
SVC0001 |
OSA-000004 |
Error reported from the telecom network. |
SVC0001 |
OSA-000006 |
Error reported from the telecom network. |
SVC0001 |
OSA-000007 |
Error reported from the telecom network. |
SVC0001 |
OSA-000008 |
Error reported from the telecom network. |
SVC0001 |
OSA-000009 |
Error reported from the telecom network. |
SVC0001 |
OSA-000010 |
Error reported from the telecom network. |
SVC0001 |
OSA-000011 |
Error reported from the telecom network. |
SVC0001 |
OSA-000012 |
Error reported from the telecom network. |
SVC0001 |
OSA-000014 |
Error reported from the telecom network. |
SVC0001 |
OSA-000015 |
Error reported from the telecom network. |
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
N/A |
Call session identifier is null; or error reported from the telecom network. |
SVC0261 |
N/A |
The call is already terminated. |
POL0001 |
N/A |
The application is not the owner of the call; or error reported form the network. |
POL0011 |
N/A |
Media type not supported. |
POL0240 |
N/A |
Too many participants. |
Transfers a participant from one call session to another call session.
Table 9-3 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
TPC-000002 |
No call leg identifier reported from network; or error reported from the telecom network. |
SVC0001 |
TPC-000003 |
The destination call session reference; or call leg reference is null; or an internal error has occurred. |
SVC0001 |
TPC-000007 |
The participant does not belong to this call. |
SVC0001 |
OSA-000001 |
Error reported from the telecom network. |
SVC0001 |
OSA-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000003 |
Error reported from the telecom network. |
SVC0001 |
OSA-000004 |
Error reported from the telecom network. |
SVC0001 |
OSA-000006 |
Error reported from the telecom network. |
SVC0001 |
OSA-000007 |
Error reported from the telecom network. |
SVC0001 |
OSA-000008 |
Error reported from the telecom network. |
SVC0001 |
OSA-000009 |
Error reported from the telecom network. |
SVC0001 |
OSA-000010 |
Error reported from the telecom network. |
SVC0001 |
OSA-000011 |
Error reported from the telecom network. |
SVC0001 |
OSA-000012 |
Error reported from the telecom network. |
SVC0001 |
OSA-000014 |
Error reported from the telecom network. |
SVC0001 |
OSA-000015 |
Error reported from the telecom network. |
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
N/A |
Error reported from the telecom network; or source call session identifier is incorrect; or destination call session identifier is incorrect; or participant part is incorrect. |
SVC0261 |
N/A |
The call is already terminated. |
POL0001 |
N/A |
TPC100001 |
POL0240 |
N/A |
Too many participants. |
Gets information about a certain participant in a call session.
Table 9-4 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
TPC-000007 |
The participant does not belong to this call. |
SVC0001 |
OSA-000001 |
Error reported from the telecom network. |
SVC0001 |
OSA-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000003 |
Error reported from the telecom network. |
SVC0001 |
OSA-000004 |
Error reported from the telecom network. |
SVC0001 |
OSA-000006 |
Error reported from the telecom network. |
SVC0001 |
OSA-000007 |
Error reported from the telecom network. |
SVC0001 |
OSA-000008 |
Error reported from the telecom network. |
SVC0001 |
OSA-000009 |
Error reported from the telecom network. |
SVC0001 |
OSA-000010 |
Error reported from the telecom network. |
SVC0001 |
OSA-000011 |
Error reported from the telecom network. |
SVC0001 |
OSA-000012 |
Error reported from the telecom network. |
SVC0001 |
OSA-000014 |
Error reported from the telecom network. |
SVC0001 |
OSA-000015 |
Error reported from the telecom network. |
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
N/A |
Call session identifier is incorrect. |
SVC0261 |
N/A |
The call is already terminated. |
POL0001 |
TPC-100001 |
The application is not the owner of the call session. |
Displays information about a call session.
Table 9-5 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
TPC-000007 |
The participant does not belong to this call. |
SVC0001 |
OSA-000001 |
Error reported from the telecom network. |
SVC0001 |
OSA-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000003 |
Error reported from the telecom network. |
SVC0001 |
OSA-000004 |
Error reported from the telecom network. |
SVC0001 |
OSA-000006 |
Error reported from the telecom network. |
SVC0001 |
OSA-000007 |
Error reported from the telecom network. |
SVC0001 |
OSA-000008 |
Error reported from the telecom network. |
SVC0001 |
OSA-000009 |
Error reported from the telecom network. |
SVC0001 |
OSA-000010 |
Error reported from the telecom network. |
SVC0001 |
OSA-000011 |
Error reported from the telecom network. |
SVC0001 |
OSA-000012 |
Error reported from the telecom network. |
SVC0001 |
OSA-000014 |
Error reported from the telecom network. |
SVC0001 |
OSA-000015 |
Error reported from the telecom network. |
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
N/A |
Network error; or call session identifier is incorrect. |
SVC0261 |
N/A |
The call is already terminated. |
POL0001 |
TPC-100001 |
The application is not the owner of the call session. |
Deletes a participant from a call session.
Table 9-6 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
TPC-000006 |
There are no participants in this call. |
SVC0001 |
OSA-000001 |
Error reported from the telecom network. |
SVC0001 |
OSA-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000003 |
Error reported from the telecom network. |
SVC0001 |
OSA-000004 |
Error reported from the telecom network. |
SVC0001 |
OSA-000006 |
Error reported from the telecom network. |
SVC0001 |
OSA-000007 |
Error reported from the telecom network. |
SVC0001 |
OSA-000008 |
Error reported from the telecom network. |
SVC0001 |
OSA-000009 |
Error reported from the telecom network. |
SVC0001 |
OSA-000010 |
Error reported from the telecom network. |
SVC0001 |
OSA-000011 |
Error reported from the telecom network. |
SVC0001 |
OSA-000012 |
Error reported from the telecom network. |
SVC0001 |
OSA-000014 |
Error reported from the telecom network. |
SVC0001 |
OSA-000015 |
Error reported from the telecom network. |
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
N/A |
Network error; or call session identifier is incorrect; or call participant identifier is incorrect. |
SVC0261 |
N/A |
The call is already terminated. |
POL0001 |
TPC-100001 |
The application is not the owner of the call session. |
Ends a call session.
Table 9-7 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
TPC-000005 |
The call reference in Services Gatekeeper storage is incorrect. |
SVC0001 |
TPC-000006 |
There are no participants in the call session. |
SVC0001 |
OSA-000001 |
Error reported from the telecom network. |
SVC0001 |
OSA-000002 |
Error reported from the telecom network. |
SVC0001 |
OSA-000003 |
Error reported from the telecom network. |
SVC0001 |
OSA-000004 |
Error reported from the telecom network. |
SVC0001 |
OSA-000006 |
Error reported from the telecom network. |
SVC0001 |
OSA-000007 |
Error reported from the telecom network. |
SVC0001 |
OSA-000008 |
Error reported from the telecom network. |
SVC0001 |
OSA-000009 |
Error reported from the telecom network. |
SVC0001 |
OSA-000010 |
Error reported from the telecom network. |
SVC0001 |
OSA-000011 |
Error reported from the telecom network. |
SVC0001 |
OSA-000012 |
Error reported from the telecom network. |
SVC0001 |
OSA-000014 |
Error reported from the telecom network. |
SVC0001 |
OSA-000015 |
Error reported from the telecom network. |
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
N/A |
Error reported from the telecom network; or call session identifier is incorrect; or call participant identifier is incorrect. |
SVC0261 |
N/A |
The call is already terminated. |
POL0001 |
TPC-100001 |
The application is not the owner of the call session. |
The Call Notification communication service interfaces comply with ETSI ES 202 504-3 v0.0.3 (2007-06) Open Service Access (OSA); Parlay X Web Services; Part 3: Call Notification (Parlay X 3).
This interface is implemented by an application, and the consumer of this interface is Services Gatekeeper. The Web Services Description Language (WSDL) file that defines the interface can be downloaded from:
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_call_direction_service_3_2.wsdl
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_call_direction_interface_3_2.wsdl
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_common_types_3_1.xsd
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_common_faults_3_0.wsdl
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_call_notification_types_3_1.xsd
where values for host and port depend on the Services Gatekeeper deployment.
Services Gatekeeper calls this method, which is implemented by an application, when the called party is busy.
Services Gatekeeper calls this method, which is implemented by an application, when the called party is not reachable.
Services Gatekeeper calls this method, which is implemented by an application, when the called party does not answer.
Services Gatekeeper calls this method, which is implemented by an application, prior to call setup.
This interface is implemented by an application, and the consumer of this interface is Services Gatekeeper. The WSDL that defines the interface can be downloaded from:
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_call_notification_interface_3_2.wsdl
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_call_notification_service_3_2.wsdl
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_common_types_3_1.xsd
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_common_faults_3_0.wsdl
http://
host
:
port
/parlayx30/call_notification/wsdls/parlayx_call_notification_types_3_1.xsd
where values for host and port depend on the Services Gatekeeper deployment.
Services Gatekeeper calls this method, which is implemented by an application, when the called party is busy.
Services Gatekeeper calls this method, which is implemented by an application, when the called party is not reachable.
Services Gatekeeper calls this method, which is implemented by an application, when the called party does not answer.
Services Gatekeeper calls this method, which is implemented by an application, prior to call setup.
Services Gatekeeper calls this method, which is implemented by an application, when the called party answered.
Services Gatekeeper calls this method, which is implemented by an application, to provide the result of a media interaction of type play and collect information.
The CallNotificationManager interface endpoint is:
http://
host
:
port
/parlayx30/call_notification/CallNotificationManager
where values for host and port depend on your Services Gatekeeper implementation.
Starts a subscription for call notifications.
Table 9-8 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
OSA-000002 |
Check the interface name |
SVC0001 |
OSA-000003 |
Check the event type. |
SVC0001 |
OSA-000006 |
Check OSA Gateway status. |
SVC0001 |
OSA-000007 |
Check OSA Gateway status. |
SVC0001 |
OSA-000008 |
Check invocation parameters of |
SVC0001 |
OSA-000009 |
Check OSA Gateway. |
SVC0001 |
OSA-000010 |
Check OSA Gateway. |
SVC0001 |
OSA-000011 |
Check OSA Gateway. |
SVC0001 |
OSA-000015 |
Check the criteria. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
reference |
Parameter reference is null. |
SVC0002 |
correlator |
Parameter correlator is null. |
SVC0002 |
endPoint |
Parameter endPoint is null or empty string. |
SVC0002 |
addresses |
Parameter reference is null. |
SVC0005 |
correlator, reference |
Correlator |
POL0001 |
Service contract not found. |
No Service Level Agreement found for the service provider or application associated with the request. |
Starts a subscription for notifications on media interactions of type play
and collect
.
Table 9-9 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
CN-000001 |
Parlay call session does not exist. |
SVC0001 |
CN-000002 |
Parlay call session has terminated. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
reference |
Parameter reference is null. |
SVC0002 |
correlator |
Parameter correlator is null. |
SVC0002 |
endPoint |
Parameter endPoint is null or empty string. |
SVC0002 |
callSessionIdentifier |
Parameter |
SVC0005 |
correlator, reference |
Correlator |
SVC0005 |
callSessionId:value |
|
POL0001 |
Service contract not found. |
No Service Level Agreement found for the service provider or application associated with the request. |
Stops a subscription for call notifications.
Table 9-10 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
CN-000003 |
The requester did not start the |
SVC0001 |
CN-000004 |
The parameter correlator does not exist. |
SVC0001 |
OSA-000006 |
Check OSA Gateway status. |
SVC0001 |
OSA-000007 |
Check OSA Gateway status. |
SVC0001 |
OSA-000008 |
Check OSA Gateway status. |
SVC0001 |
OSA-000009 |
Check invocation parameters of |
SVC0001 |
OSA-000010 |
Check OSA Gateway. |
SVC0001 |
OSA-000011 |
Check OSA Gateway. |
SVC0001 |
correlator |
The parameter correlator does not exist. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
POL0001 |
N/A |
No Service Level Agreement found for the service provider or application associated with the request. |
Stops a subscription for notification
s on media interactions.
Table 9-11 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
CN-000004 |
The parameter correlator does not exist. |
SVC0001 |
CN-000003 |
The requester did not start the |
SVC0001 |
correlator |
The parameter correlator does not exist. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
POL0001 |
Service contract not found. |
No Service Level Agreement found for the service provider or application associated with the request. |
The CallDirectionManager interface endpoint is:
http://
host
:
port
/parlayx30/call_notification/CallDirectionManager
where values for host and port depend on your Services Gatekeeper implementation.
Starts a subscription for call direction notification
s.
Table 9-12 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
OSA-000002 |
Check the interface name. |
SVC0001 |
OSA-000003 |
Check the event type. |
SVC0001 |
OSA-000015 |
Check the criteria. |
SVC0001 |
OSA-000006 |
TpCommonExceptions thrown by OSA GW. Exception type is |
SVC0001 |
OSA-000007 |
TpCommonExceptions thrown by OSA Gateway. Exception type is |
SVC0001 |
OSA-000008 |
TpCommonExceptions thrown by OSA Gateway. Exception type is |
SVC0001 |
OSA-000009 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check invocation parameters of |
SVC0001 |
OSA-000010 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check OSA Gateway. |
SVC0001 |
OSA-000011 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check OSA Gateway. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
reference |
Parameter reference is null. |
SVC0002 |
correlator |
Parameter correlator is null. |
SVC0002 |
endPoint |
Parameter endPoint is null or empty string. |
SVC0002 |
addresses |
Parameter reference is null. |
SVC0005 |
correlator value, reference |
Correlator |
POL0001 |
Service contract not found. |
No Service Level Agreement found for the service provider or application associated with the request. |
Stops a subscription for call direction notification
s.
Table 9-13 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
CN-000003 |
The requester did not start the |
SVC0001 |
CN-000004 |
The parameter correlator does not exist. |
SVC0001 |
OSA-000006 |
TpCommonExceptions thrown by OSA GW. Exception type is Check OSA Gateway status. |
SVC0001 |
OSA-000007 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check OSA Gateway status. |
SVC0001 |
OSA-000008 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check OSA Gateway status. |
SVC0001 |
OSA-000009 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check invocation parameters of |
SVC0001 |
OSA-000010 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check OSA Gateway. |
SVC0001 |
OSA-000011 |
TpCommonExceptions thrown by OSA Gateway. Exception type is Check OSA Gateway. |
SVC0001 |
correlator |
The parameter correlator does not exist. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
POL0001 |
N/A |
No Service Level Agreement found for the service provider or application associated with the request. |
The Payment communication service interfaces comply with Draft ETSI ES 202 504-6 v0.0.4 (2007-06), Open Service Access (OSA); Parlay X Web Services; Part 6: Payment (Parlay X 3)
The AmountCharging interface endpoint is: http://
host
:
port
/parlayx30/payment/AmountCharging
where values for host and port depend on your Services Gatekeeper implementation.
Charges the account indicated by the end user identifier.
Table 9-14 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
PAYMENT000002 |
A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable. Check the log files for more information. |
SVC0001 |
PAYMENT000003 |
A transient error. This error is returned from the Diameter server, for example, in an authentication failure. Make sure the server is reachable and has adequate storage space. Check the log files for more information. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0001 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server, for example, when there is incorrect data in the AVP. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the DIAMETERDiameter_error_code Diameter-Error-Message="Diameter_error_string" Where DIAMETER5001 Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED" For details on the error codes and strings see Diameter RFC3588 Section 7.1 ( |
Refunds the account indicated by the end user identifier.
Table 9-15 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
PAYMENT000002 |
A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable. Check the log files for more information. |
SVC0001 |
PAYMENT000003 |
A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space. Check the log files for more information. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0001 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the DIAMETERDiameter_error_code Diameter-Error-Message="Diameter_error_string" Where DIAMETER5001 Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED" For details on the error codes and strings see Diameter RFC3588 Section 7.1 ( |
Charges multiple end user accounts concurrently.
Table 9-16 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
PAYMENT000002 |
A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable. Check the log files for more information. |
SVC0001 |
PAYMENT000003 |
A transient error. This error is returned from the Diameter server, for example, in an authentication failure. Make sure the server is reachable and has adequate storage space. Check the log files for more information. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0001 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server, for example, such as incorrect data in the AVP. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the DIAMETERDiameter_error_code Diameter-Error-Message="Diameter_error_string" Where DIAMETER5001 Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED" For details on the error codes and strings see Diameter RFC3588 Section 7.1 ( |
The VolumeCharging interface endpoint is: http://
host
:
port
/parlayx30/payment/VolumeCharging
where values for host and port depend on your Services Gatekeeper implementation.
Charges a volume amount to multiple end user accounts based on percentages defined in a policy.
Table 9-19 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0002 |
parameter |
Invalid parameter value. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
The charge failed. Check the log files for more information. |
SVC0271 |
Invalid sum of percentage allocations. The sum of percentage allocations must be 100. |
|
POL0250 |
The number of endUserIdentifiers exceeds policy-defined maximum. |
|
POL0251 |
Split charging is not supported by the defined policy. |
The ReserveAmountCharging interface endpoint is: http://
host
:
port
/parlayx30/payment/ReserveAmountCharging
where values for host and port depend on your Services Gatekeeper implementation.
Reserves a charge for an account indicated by the end user identifier.
Table 9-22 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
PAYMENT000002 |
A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable. Check the log files for more information. |
SVC0001 |
PAYMENT000003 |
A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space. Check the log files for more information. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0001 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the DIAMETERDiameter_error_code Diameter-Error-Message="Diameter_error_string" Where DIAMETER5001 Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED" For details on the error codes and strings see Diameter RFC3588 Section 7.1 ( |
Adds to or subtracts from a charge to or from an existing reservation.
Table 9-23 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
PAYMENT000002 |
A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable. Check the log files for more information. |
SVC0001 |
PAYMENT000003 |
A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space. Check the log files for more information. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0001 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the DIAMETERDiameter_error_code Diameter-Error-Message="Diameter_error_string" Where DIAMETER5001 Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED" For details on the error codes and strings see Diameter RFC3588 Section 7.1 ( |
Charges to a reservation indicated by the reservation ID.
Table 9-24 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
PAYMENT000002 |
A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable. Check the log files for more information. |
SVC0001 |
PAYMENT000003 |
A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space. Check the log files for more information. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0001 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the DIAMETERDiameter_error_code Diameter-Error-Message="Diameter_error_string" Where DIAMETER5001 Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED" For details on the error codes and strings see Diameter RFC3588 Section 7.1 ( |
Returns funds left in a reservation to the account from which this reservation was made.
Table 9-25 Exceptions and Error Codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
PAYMENT000002 |
A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable. Check the log files for more information. |
SVC0001 |
PAYMENT000003 |
A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space. Check the log files for more information. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0001 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP. Check the log files for more information. |
SVC0270 |
PAYMENT000004 |
A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the DIAMETERDiameter_error_code Diameter-Error-Message="Diameter_error_string" Where DIAMETER5001 Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED" For details on the error codes and strings see Diameter RFC3588 Section 7.1 ( |
The ReserveVolumeCharging interface endpoint is: http://
host
:
port
/parlayx30/payment/ReserveVolumeCharging
where values for host and port depend on your Services Gatekeeper implementation.
The Audio Call communication service interfaces comply with ETSI ES 202 504-11 v0.0.3 (2007-06), Open Service Access (OSA); Parlay X Web Services; Part 11: Audio Call (Parlay X 3).
The PlayMedia interface endpoint is:
http://
host
:
port
/parlayx30/audio_call/AudioCallPlayMedia
where values for host and port depend on your Services Gatekeeper implementation.
Plays a message to the given destination address. The message is given as a URL to an audio file. The file must be reachable by the underlying telecom network node and the audio format must be supported by the telecom network.
Table 9-28 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
AC-100001 |
Call session has expired. |
SVC0001 |
AC-100003 |
Call state is incorrect. |
SVC0001 |
AC-100004 |
Call participant is not connected. |
SVC0001 |
AC-100005 |
Not all call participants are available. The participant may already be in |
SVC0001 |
AC-100006 |
Could not find call. Call session may be empty. |
SVC0001 |
OSA-000001 |
|
SVC0001 |
OSA-000011 |
|
SVC0001 |
OSA-000012 |
|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
callSessionIdentifier |
Invalid input value for message part |
SVC0002 |
callParticipants |
Invalid input value for message part |
SVC0002 |
N/A |
|
SVC0261 |
N/A |
Call has already been terminated. |
POL0001 |
Service contract not found. |
No Service Level Agreement found. |
POL0001 |
AC-100002 |
Application is not the owner of the call. |
POL0008 |
N/A |
Charging not supported. |
Gets the status of a message; that is, if the message is currently being played, if it is has finished playing.
Table 9-29 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
correlator |
Invalid input value for message part |
POL0001 |
Service contract not found. |
No Service Level Agreement found. |
POL0001 |
AC-100002 |
Application is not the owner of the call. |
Cancels or stops the playing of the message.
Table 9-30 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to fetch information from Services Gatekeeper. Contact support. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
correlator |
Invalid input value for message part |
POL0001 |
Service contract not found. |
No Service Level Agreement found. |
POL0001 |
AC-100002 |
Application is not the owner of the call. |
The CaptureMedia interface endpoint is:
http://
host
:
port
/parlayx30/audio_call/AudioCallCaptureMedia
where values for host and port depend on the Services Gatekeeper deployment.
Starts a media interaction with one or all participants in a call session. Plays a media file and collects digits from one or all call participants. The results of the interaction is notified using notifyPlayAndCollectEvent in the Parlay X 3.0 Part 3: Call Notification set of interfaces.
Table 9-31 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
N/A |
AC-100001 |
Call session has expired. |
N/A |
AC-100003 |
Call state is incorrect. |
N/A |
AC-100004 |
Participant is not connected. |
N/A |
AC-100005 |
Not all participants are available. Possibly in already in playing or collecting mode. |
SVC0001 |
AC-100006 |
Could not find call. Call session may be empty. |
SVC0001 |
OSA-000001 |
|
SVC0001 |
OSA-000011 |
|
SVC0001 |
OSA-000012 |
|
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
callSessionIdentifier |
Invalid input value for message part |
SVC0002 |
callParticipants |
Invalid input value for message part |
SVC0002 |
playFileLocation |
Invalid input value for message part |
SVC0002 |
N/A |
|
SVC0261 |
N/A |
Call has already been terminated. |
POL0001 |
Service contract not found. |
No Service Level Agreement found. |
POL0001 |
AC-100002 |
Application is not the owner of the call. |
POL0001 |
AC-100007 |
The value of |
POL0001 |
AC-100008 |
The value of |
Explicitly stops an ongoing media interaction session.
Table 9-32 exceptions and error codes
Exception | Error Code | Explanation |
---|---|---|
SVC0001 |
OSA-000001 |
|
SVC0001 |
OSA-000011 |
|
SVC0001 |
OSA-000012 |
|
SVC0001 |
WNG-000002 |
Failed to store information in Services Gatekeeper. Contact support. |
SVC0001 |
PLG-000004 |
General plug-in routing error. |
SVC0002 |
mediaIdentifier |
Invalid input value for message part |
SVC0002 |
N/A |
|
POL0001 |
Service contract not found. |
No Service Level Agreement found. |
POL0001 |
AC-100002 |
Application is not the owner of the call. |
The Address List Management communication service interfaces comply with 3GPP TS 29.199-13 V7.0.2 (2007-06), Open Service Access (OSA); Parlay X Web Services; Part 13: Address List Management (Parlay X 3).
This section describes the GroupManagement interface.
The GroupManagement interface endpoint is:
http://
host
:
port
/parlayx30/address_list/GroupManagement
where values for host and port depend on your Services Gatekeeper implementation.
Queries an Address List Management group to return details about a particular group attribute, which is specified by attributeName.
This section describes the Group interface.
The Group interface endpoint is:
http://
host
:
port
/parlayx30/address_list/Group
where values for host and port depend on your Services Gatekeeper implementation.
Queries an Address List Management group for the value associated with the passed attribute name. The attribute's value and status are returned.
This section describes the Member interface.
The Member interface endpoint is:
http://
host
:
port
/parlayx30/address_list/Member
where values for host and port depend on your Services Gatekeeper implementation.
The Device Capabilities and Configuration communication service interfaces comply with ETSI ES 202 504-18 v0.0.1(2007-06), Open Service Access (OSA); Parlay X Web Services; Part 18: Device Capabilities and Configuration (Parlay X 3).
This section describes the DeviceCapabilities interface.
The Device Capabilities interface endpoint is:
http://
host
:
port
/parlayx30/rest/device_capabilities
where values for host and port depend on your Services Gatekeeper implementation.
This section describes the DeviceCapabilitiesNotificationManager
interface.
This section describes the DeviceCapabilitiesNotification interface.
This section describes the exception handling for the Parlay X 3.0 interfaces.
The following exception types are defined:
Service Exceptions
Policy Exceptions
Service exceptions are related to the operation of the service itself. The following exceptions are general:
SVC0001: Service error.
SVC0002: Invalid input value
SVC0003: Invalid input value with list of valid values
SVC0004: No valid addresses
SVC0005: Duplicate correlator
SVC0006: Invalid group
SVC0007: Invalid charging information
SVC0008: Overlapping Criteria
Policy exceptions are thrown when a policy has been violated, including violations of a service level agreements. The following general policy exceptions are defined:
POL0001: Policy error
POL0002: Privacy error
POL0003: Too many addresses specified
POL0004: Unlimited notification
s are not supported
POL0005: Too many notification
s requested
POL0006: Groups not allowed
POL0007: Nested groups not allowed
POL0008: Charging not supported
POL0009: Invalid frequency requested
Within the exception, an error code is defined. The error code details why the exception was thrown.