|
|
The RESTful Call Notification interfaces allow an application to set up and remove call notifications (in which the application is informed of a particular state - busy, unreachable, etc. - of the call) or to set up and remove call direction notifications (in which the application is queried for information on handling a call that is in a particular state).
In the listings below, bold indicates a required attribute, <> a descriptive comment.
| Note: | An HTML version of this information is at http://host:port/rest/call_notification/index.html where host and port depend on the Oracle Communications Services Gatekeeper installation. |
http://host:port/rest/call_notification/call-notification
"addresses": ["String"],<The addresses to be monitored>
"correlator":"String", <A correlator used to identify the notification>
"endpoint": "URI",<The endpoint address to which the notification should be delivered. This should be a channel name that begins: “/bayeux/${appInstanceId}”>.
"interfaceName": "String" <Descriptive only, a string to identify the notification>
"criteria": ["Busy|NotReachable|NoAnswer|CalledNumber"] <Call events for which notification is required. If this is not specified, all events trigger notification. See Table 9-1 for more information>
| Note: | For the actual body of the notification as it is delivered to the designated endpoint, see Notifications. |
key= “Location” value = “host:port/rest/call_notification/notifications”
Stops a previously set up notification
http://host:port/rest/call_notification/call-notification/${correlator}
${correlator}: The correlator passed in with the initial request
Sets up a call direction notification.
| Note: | Because Call Direction Notifications require a response from the application to Oracle Communications Services Gatekeeper, the descriptions of the notifications include a reply-to private channel on the pub-sub server and a description of the data that must be returned. The application publishes the appropriate information to the pub-sub server channel, to which Oracle Communications Services Gatekeeper is subscribed. |
http://host:port/rest/call_notification/call-direction
"addresses": ["String"],<The addresses to be monitored>
"correlator":"String", <A correlator used to identify the notification>
"endpoint": "URI",<The endpoint address to which the notification should be delivered. This should be a channel name that begins: “/bayeux/${appInstanceId}”>
"interfaceName": "String" <Descriptive only, a string to identify the notification>
"criteria": ["Busy|NotReachable|NoAnswer|CalledNumber"] <Call events for which notification is required. If this is not specified, all events trigger notification. See Table 9-2 for more information>
| Note: | For the actual body of the notification as it is delivered to the designated endpoint, see Notifications. |
key= “Location” value = “host:port/rest/call_notification/notifications”
Stops a previously set up call direction notification
http://host:port/rest/call_notification/call-direction/${correlator}
${correlator}: The correlator passed in with the initial request
The content of notifications delivered to the designated endpoint
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
{"reply-to:"${replyToChannel)",<The endpoint address to which the handle instructions from the application should be delivered. This is a private Bayeux channel set up by Oracle Communications Services Gatekeeper.>
"data":{"handleCalledNumber": {
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
Applications respond to the Handle Called Number notification by publishing this data to the reply-to: channel provided in the notification.
{"handleCalledNumberResponse": {"result": {
"actionToPerform": "Route|Continue|EndCall", <What Oracle Communications Services Gatekeeper should do with the call. See Table 9-3 for more information>
"charging": {<This entire attribute is optional>
"description": "String",<Text to be used for information and billing>
"amount": "BigDecimal",<The amount to be charged>
"code": "String",<A charging code, from an existing contractual description>
"currency": "String"<A currency identifier as defined in ISO 4217 [9]>
"routingAddress": "URI"<The address to which the call should be routed>
{"reply-to:"${replyToChannel)",<The endpoint address to which the handle instructions from the application should be delivered. This is a private Bayeux channel set up by Oracle Communications Services Gatekeeper.>
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
Applications respond to the Handle Busy notification by publishing this data to the reply-to: channel provided in the notification.
{"handleBusyResponse": {"result": {
"actionToPerform": "Route|Continue|EndCall", <What Oracle Communications Services Gatekeeper should do with the call. See Table 9-3 for more information>
"charging": {<This entire attribute is optional>
"description": "String",<Text to be used for information and billing>
"amount": "BigDecimal",<The amount to be charged>
"code": "String",<A charging code, from an existing contractual description>
"currency": "String"<A currency identifier as defined in ISO 4217 [9]>
"routingAddress": "URI"<The address to which the call should be routed>
{"reply-to:"${replyToChannel)",<The endpoint address to which the handle instructions from the application should be delivered. This is a private Bayeux channel set up by Oracle Communications Services Gatekeeper.>
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
Applications respond to the Handle No Answer notification by publishing this data to the reply-to: channel provided in the notification.
{"handleNoAnswerResponse": {"result": {
"actionToPerform": "Route|Continue|EndCall", <What Oracle Communications Services Gatekeeper should do with the call. See Table 9-3 for more information>
"charging": {<This entire attribute is optional>
"description": "String",<Text to be used for information and billing>
"amount": "BigDecimal",<The amount to be charged>
"code": "String",<A charging code, from an existing contractual description>
"currency": "String"<A currency identifier as defined in ISO 4217 [9]>
"routingAddress": "URI"<The address to which the call should be routed>
{"reply-to:"${replyToChannel)",<The endpoint address to which the handle instructions from the application should be delivered. This is a private Bayeux channel set up by Oracle Communications Services Gatekeeper.>
"data":{"handleNotReachable": {
"calledParty": "URI",<The address of the called party>
"callingParty": "URI",<The address of the calling party>
"correlator": "String",<The correlator passed in with the set up request>
"callingPartyName": "String" <The name of the calling party>
Applications respond to the Handle Not Reachable notification by publishing this data to the reply-to: channel provided in the notification.
{"handleNoAnswerResponse": {"result": {
"actionToPerform": "Route|Continue|EndCall", <What Oracle Communications Services Gatekeeper should do with the call. See Table 9-3 for more information>
"charging": {<This entire attribute is optional>
"description": "String",<Text to be used for information and billing>
"amount": "BigDecimal",<The amount to be charged>
"code": "String",<A charging code, from an existing contractual description>
"currency": "String"<A currency identifier as defined in ISO 4217 [9]>
"routingAddress": "URI"<The address to which the call should be routed>
The content of possible error messages.
"type":"org.csapi.schema.parlayx.common.v2_1.ServiceException"
"type":"org.csapi.schema.parlayx.common.v2_1.PolicyException"
|