Configuring and Managing Parlay X Web Services

Author

Reads 11K

Explore the luxurious interior of a modern car featuring a sleek dashboard and leather seats.
Credit: pexels.com, Explore the luxurious interior of a modern car featuring a sleek dashboard and leather seats.

Configuring and managing Parlay X web services involves several key steps.

First, you need to create a Parlay X account, which can be done by registering on the official Parlay X website.

Next, you'll need to generate an API key, which is a unique identifier used to authenticate and authorize access to your Parlay X web services.

This API key is used to access various Parlay X features, including messaging and presence services.

To manage your Parlay X web services, you can use the Parlay X management console, which provides a user-friendly interface for configuring and monitoring your services.

Configuring Web Services

Configuring Web Services is a crucial step in setting up Parlay X. You can configure various attributes to fine-tune your Web service.

The SIPOutboundProxy attribute is used to specify the SipURI of the outbound proxy for SIP messages. For example, you can set it to sip:127.0.0.1:5060; lr;transport=tcp.

The PublicXCAPRootUrl attribute is used to update the presence rules stored on the XDMS. This is the URI where the Presence Server is deployed, such as http://127.0.0.1:8001/services/.

Aerial View of Sports Stadium during Daytime
Credit: pexels.com, Aerial View of Sports Stadium during Daytime

You can also configure the Expires attribute to set the time in seconds after which the PUBLISH by a presentity expires. The default value is 3600 seconds, which is equivalent to 1 hour.

Here's a summary of the configurable attributes:

The SessionTimeout attribute is used to set the time in seconds after which HTTP sessions times out. Data for all timed out sessions is discarded.

Web Services Interface Descriptions

Parlay X offers a robust presence management system through its Web services interface. The presence Web services consist of three main interfaces: PresenceConsumer, PresenceNotification, and PresenceSupplier.

The PresenceConsumer interface is used by watchers to obtain presence data. It provides methods such as subscribePresence, getUserPresence, startPresenceNotification, and endPresenceNotification.

The PresenceNotification interface is used by the presence consumer to send notifications. It includes methods like statusChanged, statusEnd, notifySubscription, and subscriptionEnded.

The PresenceSupplier interface is used by the presentity to publish presence data and manage access to the data by its watchers. It includes methods like publish, getOpenSubscriptions, updateSubscriptionAuthorization, getMyWatchers, getSubscribedAttributes, and blockSubscription.

Broaden your view: Google Cloud Platform Data

People playing a lively card game at a casino table with chips and a dealer.
Credit: pexels.com, People playing a lively card game at a casino table with chips and a dealer.

Here's a breakdown of the PresenceConsumer interface methods:

Subscription Management

Subscription management is a crucial aspect of Parlay X. The PresenceSupplier interface, specifically, is responsible for managing subscriptions.

To begin with a subscription, the presentity must use the publish operation to map directly to a SIP PUBLISH. This operation allows the presentity to publish its presence data.

The presentity can then use the getOpenSubscriptions operation to check if any watchers want to subscribe to its presence data. This operation returns pending subscriptions currently in the Web service server.

Here's a quick look at the PresenceSupplier interface operations related to subscription management:

The presentity can also use the updateSubscriptionAuthorization operation to answer any open pending subscriptions, and the blockSubscription operation to end a watcher subscription.

8.5.1 Subscribe

The first step in subscription management is to subscribe to presence data. This is done by calling the subscribePresence operation in the PresenceConsumer interface.

This operation serves two purposes: it allows the Web services to associate the current HTTP session with a user, and it provides a context for all the other operations in this interface by subscribing to at least one presentity.

ESIM Text on Smartphone Screen
Credit: pexels.com, ESIM Text on Smartphone Screen

To subscribe to presence data, the Web service sends a SUBSCRIBE to the presence server. This is the first operation the application must call before using another operation in this interface.

Here are the key points to remember about subscribing to presence data:

  • Subscribing to presence data is done by calling the subscribePresence operation.
  • Subscribing to presence data allows the Web services to associate the current HTTP session with a user.
  • Subscribing to presence data provides a context for all the other operations in this interface.
  • The Web service sends a SUBSCRIBE to the presence server to subscribe to presence data.

By subscribing to presence data, you can start receiving notifications about changes to the presence status of the presentity. This is an important step in setting up subscription management in your application.

8.5.2 Get User

To get a user's presence, you can call the getUserPresence operation. This operation retrieves a subscribed presentity presence.

If the person is offline, it returns ActivityNone and the hardstate note is written to PresenceAttribute.note. If it returns Activity_Other, the description of the activity is returned in the OtherValue field.

The OtherValue field can contain a combination of the service note and the device note, especially when the presentity is logged into multiple clients, where there can be more than one "ServiceAndDeviceNote".

8.5.3 Status Changed

A Group of People Sitting at the Table at a Business Meeting
Credit: pexels.com, A Group of People Sitting at the Table at a Business Meeting

The status changed notification is a crucial aspect of subscription management. It's triggered by a change in an attribute for which notifications were requested, as specified in the Web Service.

This asynchronous operation is called by the Web Service, which means it happens automatically without needing direct user input.

The status changed notification is a result of the PresenceNotification interface's statusChanged operation, which is defined in the Web Service's documentation.

8.5.6 Subscription Ended

When a subscription ends, the Web Service calls the PresenceNotification interface with the subscriptionEnded operation. This operation is asynchronous, meaning it doesn't require an immediate response from the watcher.

The subscriptionEnded operation notifies the watcher that the subscription has terminated. This is an important message, as it indicates that the watcher will no longer receive notifications for the subscription.

The Web Service calls this operation to inform the watcher of the subscription's status. This helps the watcher stay up-to-date with the subscription's changes.

In some cases, the statusEnd method may not be called, such as when an error occurs or the explicit call to endPresenceNotification is made. This means the watcher won't receive a notification when the duration for notifications is over.

Subscription Blocking

A casino table featuring stacked gaming chips and a roulette layout, suggesting gameplay.
Credit: pexels.com, A casino table featuring stacked gaming chips and a roulette layout, suggesting gameplay.

Subscription blocking is a crucial feature in Parlay X.

The Interface: PresenceSupplier, Operation: blockSubscription places a watcher into the block list. This operation is used to block unwanted subscriptions.

To block a subscription, you can use the blockSubscription operation. This is a straightforward way to manage your subscriptions and prevent unnecessary notifications.

The blockSubscription operation is a specific feature of the PresenceSupplier interface. It's designed to handle blocking subscriptions with ease.

Take a look at this: Block Level Storage

Notifications

Notifications are a key feature of Parlay X, allowing clients to set Signal Rules for Accounts. These Rules can be modified by authenticated users with proper Account settings.

Authenticated users can read and modify Signal Rules for other Accounts if they have Domain Administrator rights. This is crucial for managing multiple Accounts and ensuring seamless communication.

The stopCallNotification and stopCallDirectionNotification requests require specific parameters, including addresses and criteria parts, which must be included to direct the Rule deletion request to the proper Account.

NotifySubscription

Credit: youtube.com, How to Notify Your Subscribers and Keep ThemEngaged #youtubetips #tutorial ##NotifySubscribers#viral

NotifySubscription is an asynchronous method that notifies the watcher that the presentity handled the pending subscription. It's a crucial step in the notification process.

This method is triggered by the presentity, which is the entity being watched or monitored. The presentity is responsible for handling the pending subscription and notifying the watcher.

The notifySubscription method is part of the PresenceNotification interface, which is used for notifying watchers about changes in presence. This interface is defined in the OWLCS Parlay X specification.

The notifySubscription method is used to inform the watcher that the presentity has accepted or rejected the subscription request. The watcher is then updated accordingly.

The notifySubscription method is an asynchronous operation, meaning it doesn't block the execution of other code while it's being processed. This allows for more efficient and scalable notification handling.

Call Notification

Call Notification can be set up through the ParlayX Call Handling interface, which allows clients to set Signal Rules for an Account.

A man in a gray sweater and glasses gesturing at his laptop screen during a video call in an office setting.
Credit: pexels.com, A man in a gray sweater and glasses gesturing at his laptop screen during a video call in an office setting.

These Rules include special Parlay Actions that implement the "CallDirection" and "CallNotification" Parlay Interfaces.

Authenticated users can modify their own Account Signal Rules if they have a proper Account setting value.

The stopCallNotification and stopCallDirectionNotification requests must contain the addresses and criteria parts, while the correlator part value is ignored.

This is required since Rules are set individually for each Account, and the correlator data does not allow the Server to direct the Rule deletion request to the proper Account.

Account Management

The Account Management interface is a powerful tool that allows you to access the CommuniGate Pro Billing Manager.

With ParlayX, you can access the CommuniGate Pro Billing Manager through the Account Management interface. This means you have full control over your account and billing information.

The Account Management interface provides a user-friendly way to manage your account settings. It's designed to be intuitive and easy to use, even for those who are new to account management.

By accessing the CommuniGate Pro Billing Manager, you can view and manage your account's billing information, including any outstanding charges or payments. This helps you stay on top of your account's financials and avoid any surprises.

Call Handling

Woman Working as a Call Center Agent
Credit: pexels.com, Woman Working as a Call Center Agent

The Call Handling interface in ParlayX is a powerful tool that allows client applications to manage call settings. It's a must-have feature for any business that relies on voice communications.

You can use the Call Handling interface to set Signal Rules for an Account. This is a crucial step in determining how calls are handled.

Signal Rules can be set to either accept or block certain calls. All acceptList Parlay X elements are converted into one Signal Rule, making it easy to manage a list of accepted numbers.

Conversely, all blockList Parlay X elements are converted into one Signal Rule, allowing you to block unwanted calls with ease.

The forward element and each forwardList Parlay X elements are converted into three Signal Rules. This means you have complete control over how forwarded calls are handled.

Web Services

Parlay X's web services are a crucial part of its architecture, allowing different systems to communicate and share data. They consist of three main interfaces: PresenceConsumer, PresenceNotification, and PresenceSupplier.

Credit: youtube.com, Creating New and Innovative Mobile and Web Applications with Network APIs

The PresenceConsumer interface is used by watchers to obtain presence data, and it has several methods for this purpose. These include subscribePresence, getUserPresence, startPresenceNotification, and endPresenceNotification.

One of the key features of the PresenceConsumer interface is the ability to enable and disable asynchronous notifications. This is done using the startPresenceNotification and endPresenceNotification methods, which allow the client to receive or stop receiving notifications about presence status changes.

The PresenceNotification interface is used by the presence consumer interface to send notifications to watchers. It has several methods, including statusChanged, statusEnd, notifySubscription, and subscriptionEnded. These methods allow the Web Service to notify watchers about changes in presence status or subscription termination.

The PresenceSupplier interface is used by presentity to publish presence data and manage access to it. It has several methods, including publish, getOpenSubscriptions, updateSubscriptionAuthorization, getMyWatchers, getSubscribedAttributes, and blockSubscription.

The PresenceSupplier interface also allows presentity to manage subscriptions and access control. For example, it can use the blockSubscription method to end a watcher subscription by modifying the XCAP document on the XDMS server.

Here's a summary of the PresenceSupplier interface methods:

  • publish: Maps directly to a SIP PUBLISH.
  • getOpenSubscriptions: Called by the presentity to check if any watcher wants to subscribe to its presence data.
  • updateSubscriptionAuthorization: The supplier uses this method to answer any open pending subscriptions.
  • getMyWatchers: Retrieves the local list of watchers from the Web service server.
  • getSubscribedAttributes: Retrieves the local list of subscribed attributes from the Web service server.
  • blockSubscription: Causes the Web service server to end a watcher subscription.

Ann Predovic

Lead Writer

Ann Predovic is a seasoned writer with a passion for crafting informative and engaging content. With a keen eye for detail and a knack for research, she has established herself as a go-to expert in various fields, including technology and software. Her writing career has taken her down a path of exploring complex topics, making them accessible to a broad audience.

Love What You Read? Stay Updated!

Join our community for insights, tips, and more.