Presence Service
Description
This web service allows, as authorized, publishers to retrieve real-time aggregate availability for Advertisers.
Version 1 WSDL
Format: XML
Method: POST
URL (regionally defined. Note: The SOAP action between regions does not change and will always be at base url https://services.contactatonce.com/):
- North America : https://services.contactatonce.com/presenceservice.asmx?wsdl
- Australia : https://services.contactatonce.com.au/presenceservice.asmx?wsdl
- Europe : https://services.contactatonce.co.uk/presenceservice.asmx?wsdl
Requests
GetAdvertiserPresence
Retrieves real-time aggregate presence for one or more advertisers.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
advertiserIds | Array of AdvertiserId | Required | Unique ID assigned to Advertiser Account by Publisher at provisioning. |
Response | Array of AdvertiserPresence | |
---|---|---|
Parameter | Type | Description |
AdvertiserId | String | Unique ID assigned to Advertiser Account by Publisher at provisioning. |
IsAvailable | Boolean | Observed. Current, real-time, point-in-time aggregate presence for the advertiser. |
GetDetailedAdvertiserPresence
Retrieves real-time presence for a advertiser based on PlacementId and optional OrginationURL.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
providerId | Int | Required | ProviderId assigned by ContactAtOnce! to each Provider. |
advertiserId | String | Required | Unique ID assigned to Advertiser Account by Publisher at provisioning. |
placementId | Int | Required | A unique identifier for an instance of a placement |
originationUrl | String | Required | URL of the web page from which the above PlacementId resides. |
Response | Array of AdvertiserPresence | |
---|---|---|
Parameter | Type | Description |
IsAvailable | Boolean | True/False. True if there is at least 1 agent online |
DropinDelay | Int | Time in seconds to wait before displaying business card dropin. |
GetDetailedAdvertiserPresenceInfo
Retrieves real-time presence for a advertiser based on PlacementId and optional OrginationURL.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
advertiserId | AdvertiserId | Required | Unique ID assigned to Advertiser Account by Publisher at provisioning. |
placementId | Int | Required | A unique identifier for an instance of a placement |
originationUrl | String | Optional | URL of the web page from which the above PlacementId resides. |
Response | Array of AdvertiserPresence | |
---|---|---|
Parameter | Type | Description |
IsAvailable | Boolean | True/False. True if there is at least 1 agent online |
DropinDelay | Int | Time in seconds to wait before displaying business card dropin. |