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/):


Requests


    GetAdvertiserPresence

    Retrieves real-time aggregate presence for one or more advertisers.

    Request   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    advertiserIdsArray of AdvertiserIdRequiredUnique ID assigned to Advertiser Account by Publisher at provisioning.

    ResponseArray of AdvertiserPresence  
    ParameterTypeDescription
    AdvertiserIdStringUnique ID assigned to Advertiser Account by Publisher at provisioning.
    IsAvailableBooleanObserved. 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   
    ParameterTypeRequiredDescription
    providerIdIntRequiredProviderId assigned by ContactAtOnce! to each Provider.
    advertiserIdStringRequiredUnique ID assigned to Advertiser Account by Publisher at provisioning.
    placementIdIntRequiredA unique identifier for an instance of a placement
    originationUrlStringRequiredURL of the web page from which the above PlacementId resides.

    ResponseArray of AdvertiserPresence  
    ParameterTypeDescription
    IsAvailableBooleanTrue/False. True if there is at least 1 agent online
    DropinDelayIntTime in seconds to wait before displaying business card dropin.

    GetDetailedAdvertiserPresenceInfo

    Retrieves real-time presence for a advertiser based on PlacementId and optional OrginationURL.

    Request   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    advertiserIdAdvertiserIdRequiredUnique ID assigned to Advertiser Account by Publisher at provisioning.
    placementIdIntRequiredA unique identifier for an instance of a placement
    originationUrlStringOptional URL of the web page from which the above PlacementId resides.

    ResponseArray of AdvertiserPresence  
    ParameterTypeDescription
    IsAvailableBooleanTrue/False. True if there is at least 1 agent online
    DropinDelayIntTime in seconds to wait before displaying business card dropin.