Alerts

Alerts

Sapo Alerts service provides a mean for users to subscribe to events and be notified of their occurrence in the most suitable manner, such as email, sms or IM/XMPP.

Free subscription

Technical Overview

AlertsFramework Service

Sapo Alerts service provides a mean for users to subscribe to events and be notified of their occurrence in the most suitable manner, such as email, sms or IM/XMPP.

API Reference

Service Operation Description
AlertsFramework ActivateSubscription Sets the Active status of a subscription.
AddDestination Adds a new destination associated with an user
AddSubscription Adds a new subscription associated with an user
CreateUser Creates a new user
GetDeliveryChannelList Gets a list of all available delivery channels, such as SMTP, SMS, XMPP
GetDestinationList Gets an user destination list
GetDestinationListBySubscription Gets an user destination list by subscription
GetEventDetail Gets detailed event information, like the properties that can be filtered
GetEventList Gets a list of all available events
GetLastNotifications Gets user's last notifications from any event type.
GetSubscriptionList Gets an user subscription list
GetSubscriptionListByEvent Gets an user subscription list by event type
GetSubscriptionNotifications Gets the last notifications for a given subscription.
GetSubscriptionsWithNotification Gets all user subscriptions and the last notification for each.
RemoveAllSubscriptions Removes all subscriptions from an user
RemoveDestination Removes a user destination
RemoveSubscription Removes a subscription from an user
RemoveUser Removes an user and everything related with him
SendValidationCode Send the validation code for an unverified contact.
ValidateDestination Validates a user destination

Service

Operations

ActivateSubscription

Sets the Active status of a subscription.
Request Parameters
ActivateSubscriptionInfo : ActivateSubscriptionInfo (required)
Response Parameters
Status : string (optional)
Go to top

AddDestination

Adds a new destination associated with an user
Request Parameters
UserDestination : UserDestination (required)
Response Parameters
AddDestinationResult : string (required)
Go to top

AddSubscription

Adds a new subscription associated with an user
Request Parameters
Subscription : Subscription (required)
Response Parameters
AddSubscriptionResult : string (required)
Go to top

CreateUser

Creates a new user
Request Parameters
CreateUserInfo : CreateUserInfo (required)
Response Parameters
Status : string (optional)
Go to top

GetDeliveryChannelList

Gets a list of all available delivery channels, such as SMTP, SMS, XMPP
Request Parameters
AppId : string (required)
Response Parameters
GetDeliveryChannelListResult : DeliveryChannelList (optional)
Go to top

GetDestinationList

Gets an user destination list
Request Parameters
UserInfo : UserInfo (required)
Response Parameters
GetDestinationListResult : DestinationList (required)
Go to top

GetDestinationListBySubscription

Gets an user destination list by subscription
Request Parameters
GetDestinationListBySubscriptionInfo : GetDestinationListBySubscriptionInfo (required)
Response Parameters
GetDestinationListBySubscriptionResult : DestinationList (required)
Go to top

GetEventDetail

Gets detailed event information, like the properties that can be filtered
Request Parameters
GetEventDetailInfo : GetEventDetailInfo (required)
Response Parameters
GetEventDetailResult : EventDetail (required)
Go to top

GetEventList

Gets a list of all available events
Request Parameters
AppId : string (required)
Response Parameters
GetEventListResult : EventList (required)
Go to top

GetLastNotifications

Gets user's last notifications from any event type.
Request Parameters
GetLastNotificationsInfo : GetLastNotificationsInfo (required)
Response Parameters
GetLastNotificationsResult : NotificationList (optional)
Go to top

GetSubscriptionList

Gets an user subscription list
Request Parameters
UserInfo : UserInfo (required)
Response Parameters
GetSubscriptionListResult : SubscriptionList (required)
Go to top

GetSubscriptionListByEvent

Gets an user subscription list by event type
Request Parameters
GetSubscriptionListByEventInfo : GetSubscriptionListByEventInfo (required)
Response Parameters
GetSubscriptionListByEventResult : SubscriptionList (required)
Go to top

GetSubscriptionNotifications

Gets the last notifications for a given subscription.
Request Parameters
GetSubscriptionNotificationsInfo : GetSubscriptionNotificationsInfo (required)
Response Parameters
GetSubscriptionNotificationsResult : SubscriptionNotifications (required)
Go to top

GetSubscriptionsWithNotification

Gets all user subscriptions and the last notification for each.
Request Parameters
UserInfo : UserInfo (required)
Response Parameters
GetSubscriptionsWithNotificationResult : SubscriptionWithNotificationList (required)
Go to top

RemoveAllSubscriptions

Removes all subscriptions from an user
Request Parameters
UserInfo : UserInfo (required)
Response Parameters
Status : string (optional)
Go to top

RemoveDestination

Removes a user destination
Request Parameters
RemoveDestinationInfo : RemoveDestinationInfo (required)
Response Parameters
Status : string (optional)
Go to top

RemoveSubscription

Removes a subscription from an user
Request Parameters
RemoveSubscriptionInfo : RemoveSubscriptionInfo (required)
Response Parameters
Status : string (optional)
Go to top

RemoveUser

Removes an user and everything related with him
Request Parameters
UserInfo : UserInfo (required)
Response Parameters
Status : string (optional)
Go to top

SendValidationCode

Send the validation code for an unverified contact.
Request Parameters
SendValidationCodeInfo : SendValidationCodeInfo (required)
Response Parameters
SendValidationCodeResult : string (required)
Go to top

ValidateDestination

Validates a user destination
Request Parameters
ValidateDestinationInfo : ValidateDestinationInfo (required)
Response Parameters
ValidateDestinationResult : string (required)
Go to top

Entities

ActivateSubscriptionInfo

Go to top

CreateUserInfo

Go to top

DeliveryChannelList

Go to top

DestinationList

Attribute Name Description
List of UserDestination : UserDestination (optional)
Go to top

EventDetail

Go to top

EventList

Go to top

GetDestinationListBySubscriptionInfo

Go to top

GetEventDetailInfo

Go to top

GetLastNotificationsInfo

Go to top

GetSubscriptionListByEventInfo

Go to top

GetSubscriptionNotificationsInfo

Go to top

Notification

Go to top

NotificationList

Attribute Name Description
List of Notification : Notification (optional)
Go to top

RemoveDestinationInfo

Go to top

RemoveSubscriptionInfo

Go to top

SendValidationCodeInfo

Go to top

Subscription

Go to top

SubscriptionList

Go to top

SubscriptionNotifications

Go to top

SubscriptionWithNotification

Go to top

SubscriptionWithNotificationList

Attribute Name Description
List of SubscriptionWithNotification : SubscriptionWithNotification (optional)
Go to top

UserDestination

Go to top

UserInfo

Go to top

ValidateDestinationInfo

Go to top

SOAP API Authentication

Authenticating SOAP Request

Every request must contain authentication information to establish the identity of whom making the request and a autorization token called ESB Access Key.

ESB Access Key

Correct with the path to the access key

The ESB Access Key is what will authorize the usage of the API and is available when the buying process ends. In the costumer area you can find the product details where you can generate an ESB Access Key for you usage, another user registered on SAPO Services or even for everyone.

The element ESBAccessKey must appear on the message SOAP Header after the complex type ESBCredentials

Example:

ESBCredentials

ESBCredentials is a complex type that is used to pass the credentials in order to authenticate a SOAP request.

Request with username and password
Elements Description
ESBUsername The e-mail of the account that is used to access the API
ESBPassword The password that in combination with the ESBUsername is used to access the corresponding account

Example:

Request with ESBToken

Using a token instead of your username and password can be useful if you don't want to give your credentials to whom is using the API.

In order to generate a ESB Token you must use SAPO Security Token Service (STS). The ESBtoken is valid for 12 hours.

Requesting with an ESBtoken
Go to top