Skip Headers
Oracle® Communications Services Gatekeeper Application Developer's Guide
Release 5.1
E37542-01
Home
Contact Us
Next
PDF
·
Mobi
·
ePub
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
1
Creating Applications for Oracle Communications Services Gatekeeper
Basic Concepts
Communication Services
Traffic Types
Application-initiated Traffic
Network-triggered Traffic
Management Structures
Functional Overview
Application Testing Workflow
2
Interacting with Oracle Communications Services Gatekeeper
Session Management for SOAP, REST, and OneAPI Interfaces
Changing the Session Mode
Requirements for Using the SOAP-based Facades
Authentication
SOAP Header Element for Authentication
Setting Callback Timeout Limits
Service Correlation
Parameter Tunneling
SOAP attachments
Managing SOAP headers and SOAP attachments programmatically
3
Session Manager Web Service
Endpoint
Interface: SessionManager
Operation: getSession
Input message: getSession
Output message: getSessionResponse
Referenced faults
Operation: changeApplicationPassword
Input message: changeApplicationPassword
Output message: changeApplicationPasswordResponse
Referenced faults
Operation: getSessionRemainingLifeTime
Input message: getSessionRemainingLifeTime
Output message: getSessionRemainingLifeTimeResponse
Referenced faults
Operation: refreshSession
Input message: refreshSession
Output message: refreshSessionResponse
Referenced faults
Operation: destroySession
Input message: destroySession
Output message: destroySessionResponse
Referenced faults
Examples
4
Extended Web Services Binary SMS
Namespaces
Endpoints
Sequence Diagram
Send SMS
Receive SMS
XML Schema data type definition
BinaryMessage structure
BinarySmsMessage structure
Interface: BinarySms
Operation: sendBinarySMS
Interface: BinarySmsNotificationManager
Operation: StartBinarySmsNotification
Operation: StopBinarySmsNotification
Interface: BinarySmsNotification
Operation: NotifyBinarySmsReception
WSDLs
Error Codes
Sample Send Binary SMS
5
Extended Web Services WAP Push
Namespaces
Endpoint
Sequence Diagram
XML Schema data type definition
PushResponse structure
ResponseResult structure
ReplaceMethod enumeration
MessageState enumeration
Web Service interface description
Interface: PushMessage
Operation: sendPushMessage
Interface: PushMessageNotification
Operation: resultNotificationMessage
WSDLs
Sample Send WAP Push Message
6
Extended Web Services Subscriber Profile
Namespaces
Endpoint
Address schemes
XML Schema data type definition
PropertyTuple structure
Web Service interface description
Interface: SubscriberProfile
Operation: get
Operation: getProfile
WSDLs
7
Extended Web Services Common
Namespace
XML Schema datatype definition
AdditionalProperty structure
ChargingInformation structure
SimpleReference structure
Fault definitions
ServiceException
PolicyException
8
Parlay X 2.1 Interfaces
Parlay X 2.1 Part 2: Third Party Call
Interface: ThirdPartyCall
MakeCall
GetCallInformation
EndCall
CancelCall
Error Codes
Parlay X 2.1 Part 3: Call Notification
Interface: CallDirection
HandleBusy
HandleNotReachable
HandleNoAnswer
HandleCalledNumber
Interface: CallNotification
NotifyBusy
NotifyNotReachable
NotifyNoAnswer
NotifyCalledNumber
Interface: CallNotificationManager
StartCallNotification
StopCallNotification
Interface: CallDirectionManager
StartCallDirectionNotification
StopCallDirectionNotification
Error Codes
Parlay X 2.1 Part 4: Short messaging
Interface: SendSms
SendSms
SendSmsLogo
SendSmsRingtone
GetSmsDeliveryStatus
Interface: SmsNotification
NotifySmsReception
NotifySmsDeliveryReceipt
Interface: ReceiveSms
GetReceivedSms
Interface: SmsNotificationManager
StartSmsNotification
StopSmsNotification
Sending Custom Message Content for Split and Submit Messaging Requests
Using DifferentContentForSingleAddressInBulk to Customize Split Messages
Error Codes
Parlay X 2.1 Part 5: Multimedia messaging
Interface: SendMessage
SendMessage
GetMessageDeliveryStatus
Interface: ReceiveMessage
GetReceivedMessages
GetMessageURIs
GetMessage
Interface: MessageNotification
NotifyMessageReception
NotifyMessageDeliveryReceipt
Interface: MessageNotificationManager
StartMessageNotification
StopMessageNotification
Error Codes
Parlay X 2.1 Part 8: Terminal Status
Interface: TerminalStatus
getStatus
getStatusForGroup
Interface: TerminalStatusNotificationManager
startNotification
endNotification
Interface: TerminalNotification
statusNotification
statusError
statusEnd
Error Codes
Parlay X 2.1 Part 9: Terminal Location
Interface: TerminalLocation
GetLocation
GetTerminalDistance
GetLocationForGroup
Interface: TerminalLocationNotificationManager
StartGeographicalNotification
StartPeriodicNotification
EndNotification
Interface: TerminalLocationNotification
LocationNotification
LocationError
LocationEnd
Error Codes
Parlay X 2.1 Part 11: Audio Call
Interface: PlayAudio
EndMessage
GetMessageStatus
PlayAudioMessage
PlayTextMessage
PlayVoiceXmlMessage
Error Codes
Parlay X 2.1 Part 14: Presence
Interface: PresenceConsumer
subscribePresence
getUserPresence
startPresenceNotification
endPresenceNotification
Interface: PresenceNotification
statusChanged
statusEnd
notifySubscription
subscriptionEnded
Interface: PresenceSupplier
publish
getOpenSubscriptions
updateSubscriptionAuthorization
getMyWatchers
getSubscribedAttributes
blockSubscription
Error Codes
About notifications
General Exceptions
General error codes
Code examples
Example: sendSMS
Example: startSmsNotification
Example: getReceivedSms
Example: sendMessage
Example: getReceivedMessages and getMessage
Example: getLocation
9
Parlay X 3.0 Interfaces
Interaction between Audio Call, Third Party Call, and Call Notification
Parlay X 3.0 Part 2: Third Party Call
Interface: ThirdPartyCall
makeCallSession
addCallParticipant
transferCallParticipant
getCallParticipantInformation
getCallSessionInformation
deleteCallParticipant
endCallSession
Parlay X 3.0 Part 3: Call Notification
Interface: CallDirection
HandleBusy
HandleNotReachable
HandleNoAnswer
HandleCalledNumber
Interface: CallNotification
notifyBusy
notifyNotReachable
notifyNoAnswer
notifyCalledNumber
notifyAnswer
notifyPlayAndCollectEvent
notifyPlayAndRecordEvent
Interface: CallNotificationManager
startCallNotification
startPlayAndCollectNotification
startPlayAndRecordNotification
stopCallNotification
stopMediaInteractionNotification
Interface: CallDirectionManager
StartCallDirectionNotification
StopCallDirectionNotification
Parlay X 3.0 Part 6: Payment
Interface: AmountCharging
chargeAmount
refundAmount
chargeSplitAmount
Interface: VolumeCharging
chargeVolume
refundVolume
chargeSplitVolume
getAmount
chargeReservation
releaseReservation
Interface: ReserveAmountCharging
reserveAmount
reserveAdditionalAmount
chargeReservation
releaseReservation
Interface: ReserveVolumeCharging
reserveVolume
reserveAdditionalVolume
getAmountReserveCharging
Parlay X 3.0 Part 11: Audio Call
Interface: PlayMedia
playTextMessage
playAudioMessage
playVoiceXmlMessage
playVideoMessage
getMessageStatus
endMessage
Interface: CaptureMedia
startPlayAndCollectInteraction
startPlayAndRecordInteraction
stopMediaInteraction
Interface: Multimedia
addMediaForParticipants
deleteMediaForParticipants
getMediaForParticipant
getMediaForCall
Parlay X 3.0 Part 13: Address List Management
Interface: GroupManagement
createGroup
queryGroups
deleteGroup
setAccess
queryAccess
General Exceptions
Interface: Group
addMember
addMembers
queryMembers
deleteMember
deleteMembers
addGroupAttribute
queryGroupAttribute
deleteGroupAttribute
addGroupMemberAttribute
queryGroupMemberAttributes
deleteGroupMemberAttribute
Interface: Member
addMemberAttribute
queryMemberAttributes
deleteMemberAttribute
Parlay X 3.0 Part 18: Device Capabilities and Configuration
Interface: DeviceCapabilities
getCapabilities
getDeviceId
General Exceptions
Interface: DeviceCapabilitiesNotificationManager
startNotification
endNotification
Interface: DeviceCapabilitiesNotification
deviceNotification
deviceError
deviceEnd
Interface: DeviceConfiguration
pushConfiguration
getConfigurationList
getConfigurationHistory
General Exceptions
10
Native Interfaces
MM7
MM7_submit
MM7_deliver
MM7_cancel
MM7_replace
MM7_delivery_report
MM7_read_reply_report
SMPP
Bind PDUs and Sessions
Error Handling
Supported Operations
bind_transmitter PDU
bind_transmitter_resp PDU
bind_receiver PDU
bind_receiver_resp PDU
bind_transceiver PDU
bind_transceiver_resp PDU
outbind PDU
unbind PDU
unbind_resp PDU
generic_nack PDU
submit_sm PDU
submit_sm_resp PDU
submit_multi PDU
submit_multi_resp PDU
deliver_sm PDU
deliver_sm_resp PDU
data_sm PDU
data_sm_resp PDU
query_sm PDU
query_sm_resp PDU
cancel_sm PDU
cancel_sm_resp PDU
replace_sm PDU
replace_sm_resp PDU
enquire_link PDU
enquire_link_resp PDU
alert_notification PDU
UCP
Error Handling
ERROR_CODE_OPERATION_NOT_ALLOWED
ERROR_CODE_AUTH_FAILURE
ERROR_CODE_OPERATION_NOT_SUPPORTED
ERROR_CODE_SYNTAX_ERROR
Native UCP Operations: North Interface
submitSM
openSession
ack
nack
deliverSM
deliveryNotification
Native UCP Operations: South Interface
ack
nack
Scripting on this page enhances content navigation, but does not change the content in any way.