Direct Merchant Reporting Service
Description
The Reporting Service provides operations for retrieving performance statistics and lead content from ContactAtOnce! .
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/directmerchantreportingservice.asmx?wsdl
- Australia : https://services.contactatonce.com.au/directmerchantreportingservice.asmx?wsdl
- Europe : https://services.contactatonce.co.uk/directmerchantreportingservice.asmx?wsdl
Requests
GetIMDetail
Retrieve Advertiser Chat/IM Session Details. Retrieve a list of IM/Chat sessions meeting the filter criteria. Details of all observed IM/chat sessions are returned.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Array of ImPartnerDetail | IM/Chat session details retrieved for the specified filter criteria. A row in the array is returned for each observed IM/Chat session meeting for the specified filter criteria. |
GetIMDetailByVisitId
Retrieve Advertiser Chat/IM Session Details for single visit. Details of the observed IM/chat session are returned.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | ImPartnerDetail | IM/Chat session details retrieved for the specified filter criteria. A row in the array is returned for each observed IM/Chat session meeting for the specified filter criteria. |
GetImConversationTranscript
Retrieve Instant Messaging Conversation Transcript. Returns the conversation context and text transript of an Instant Messaging conversation.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| visitId | Long | Required | Unique identifier of the IM conversation. See VisitId |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | ImConversationTranscript | Context and individual messages that constitute the instant messaging conversation transcript. |
GetLeadDetail
Retrieve Advertiser Lead Details.
Retrieve a list of leads delivered meeting the ReportFilterCriteria. Details of all supported lead types are returned.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Array of LeadStat | Lead details retrieved for the specified filter criteria. A row in the array is returned for each observed lead meeting the specified filter criteria. |
GetPerformanceStatisticalSummary
Returns Partner performance summary data on a monthly basis for a specified date range.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| filter | ReportFilterCriteria | Required | Filtering criteria enabling the specification of Statistics to be returned. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | ImPartnerReportStat | Summarized Partner performance statistics. |
GetConsumerConsentProfile
Returns contact points for a specified phone number.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| userCredential | UserCredential | Required | Credentials required to authenticate and authorize the request. |
| merchantId | Int | Required if advertiserId is not provided | ContactAtOnce! unique identifier of the Merchant for which the Mobile Text Connect session is to be initiated. If MerchantId is not known, AdvertiserId must be provided and the MerchantId element not included. Either AdvertiserId or MerchantId should be included in request but not both. |
| advertiserId | String | Required if merchantId is not provided | Advertiser's unique identifier, of the Merchant for which the Mobile Text Connect session is to be initiated. If AdvertiserId is not known, MerchantId must be provided and the AdvertiserId element not included. Either AdvertiserId or MerchantId should be included in request but not both. |
| consumerPhoneNumber | String | Required | Phone number of consumer. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Array of ConsumerStatusSummary | Details about the Consumer, OptIn Status and First Contact Source |