Advertiser Manager Service
Description
The AdvertiserManager Service provides operations for defining new advertisers to the ContactAtOnce! service and for removing advertisers from the ContactAtOnce! service. An advertiser must be provisioned for ContactAtOnce! in order to use the ContactAtOnce! service. Unprovisioning advertisers logically deletes the advertiser from the Provider’s account.
Version 5 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/contactatonceadvertisermanager.asmx?wsdl
- Australia : https://services.contactatonce.com.au/contactatonceadvertisermanager.asmx?wsdl
- Europe : https://services.contactatonce.co.uk/contactatonceadvertisermanager.asmx?wsdl
Requests
ActivateAdvertiserDashboard
Activates the Dashboard for a specific Advertiser.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
ActivateConsumerAdvocate
Activates the Consumer Advocate feature for a specific Advertiser.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
ActivateNetworkConnect
Resource Properties
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| chatVendorName | String | Required | The Name of the Vendor you would like to Activate: CONTACT_AT_ONCE |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
ActivateScheduledPresence
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
ActivateTrackedNumberAlert
Activates the alerting service for a specific tracked telephone number.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| trackedNumber | String | Required | The Tracked Number for which the Tracked Number alerting service is to be activated. |
| forwardToNumber | String | Required | The telephone number to which calls to the Tracked Number will be forwarded. |
| vendor | String | Required | The Vendor of the Tracked Number for which the alerting service is to be activated. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
AddEmailContact
Add an Email Contact to existing Advertiser.
ContactAtOnce! supports three types of email contacts for each Advertiser account. The following types of email contacts may be added through this web service method:
- Transcript – the address to which chat transcripts will be sent at the conclusion of every chat.
- CRM – the address to which leads are sent in a specified CRM format.
- SalesLead – the address to which leads are sent.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| type | String | Required | The Type of email contact to be added. Supported values include:
|
| address | String | Required | The email address to be added. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
AssignExternalMobileTextConnectNumber
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| numberRequest | ExternalMTCNumberRequest | Required | The MTC number and configurations for number being assigned. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
ChangeReferenceId
Change the ReferenceId or AdvertiserId of an existing Advertiser.
This function enables a Publisher to change the specified AdvertiserId for an Advertiser. AdvertiserId and ReferenceId are synonymous. Once a ChangeReferenceId has been completed, a Publisher may immediately begin using the new AdvertiserId.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| currentReferenceId | String | Required | The current AdvertiserId for the Advertiser that is to be updated. |
| newReferenceId | String | Required | The new AdvertiserId for the Advertiser that will replace the old Id. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
DeactivateAdvertiserDashboard
Deactivates the Dashboard for a specific Advertiser.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
DeactivateConsumerAdvocate
Deactivates the Consumer Advocate feature for a specific Advertiser.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
DeactivateNetworkConnect
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
DeactivateScheduledPresence
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
DeactivateTrackedNumberAlert
Deactivates the alerting service for a specific tracked telephone number.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| trackedNumber | String | Required | The Tracked Number for which the Tracked Number alerting service is to be deactivated. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
GetAdvertiserAccountStatus
Retrieve advertiser account status summary and detail for a specific Advertiser account.
This function enables a Publisher to retrieve overall account status and detailed provisioning status information.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | AccountStatusSummary | AccountStatusSummaryResult |
GetAgentList
Retrieve Advertiser Agent Details and Presence.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Array of AgentDetail | Agent details including presence status for the specified advertiser. |
GetDirectAdvertiserAccountStatus
Retrieve direct advertiser account status summary and detail for a specific Advertiser account.
This function enables a Web Site Provider (WSP) to retrieve overall account status and detailed provisioning status information.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | AccountStatusSummary Note: This is different than the GetAdvertiserAccountStatus. It will contain ProviderId and MerchantId | Summary of Account Status |
GetEmailContacts
Get the email address of specified type from existing Advertiser.
ContactAtOnce! supports three types of email contacts for each Advertiser account. The following types of email contacts may be retrieved through this web service method:
- Transcript – the address to which chat transcripts will be sent at the conclusion of every chat.
- CRM – the address to which leads are sent in a specified CRM format.
- SalesLead – the address to which leads are sent.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| type | String | Required | The Type of email contact to be retrieved. Supported values include:
|
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | GetEmailContactsResult | GetEmailContactsResult. Standard Response Body and array of Email addresses that match the search criteria. |
GetTrackedNumberAssignmentList
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| includeInactive | Boolean | Required | True/False. Would you like to include your inactive Tracked Numbers? |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Array of TrackedNumberAssignment | TrackedNumberAssignment details |
Provision
Provision a new Advertiser.
Publishers must provision advertisers in order for the advertiser to use ContactAtOnce!. The provision service initiates a work flow process that culminates with the Advertiser being enabled for ContactAtOnce!
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| request | AdvertiserProvisionRequest | Required | Request to Provision Advertiser. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
ProvisionAgent
Provisions a new sales agent for an existing advertiser account.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| request | AgentProvision Request | Required | Request to provision an agent. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
ProvisionDirectAdvertiser
Provision a new Advertiser.
Web Site Provider (WSP) must provision advertisers in order for the advertiser to use ContactAtOnce!. The provision service initiates a work flow process that culminates with the Advertiser being enabled for ContactAtOnce!
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| request | DirectAdvertiserProvisionRequest | Required | Object for Provisioning Direct Advertiser. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
ProvisionTrackedTelephoneNumber
Provisions a tracked telephone number for an existing advertiser account.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| request | TrackedNumberRequest | Required | Request to provision tracked telephone numbers for the Provider - Advertiser pair. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | ProvisionTrackedTelephoneNumberResult | ProvisionTrackedTelephoneNumberResult |
Reinstate
Reinstate a previously inactivated (unprovisioned) advertiser account.
This function enables a Publisher to restore to active status an advertiser account that has been provisioned and then subsequently unprovisioned.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
ReleaseTrackedTelephoneNumber
Releases a previously provisioned tracked telephone number for an existing advertiser account.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| trackedTelephoneNumber | Long | Required | Tracked telephone number to be released. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
RemoveEmailContact
Remove an Email Contact from an existing Advertiser.
ContactAtOnce! supports three types of email contacts for each Advertiser account. The following types of email contacts may be removed through this web service method:
- Transcript – the address to which chat transcripts will be sent at the conclusion of every chat.
- CRM – the address to which leads are sent in a specified CRM format.
- SalesLead – the address to which leads are sent.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| type | String | Required | The Type of email contact to be added. Supported values include:
|
| address | String | Required | The email address to be added. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
UnassignExternalMobileTextConnectNumber
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| number | String | Required | Mobile Text Connect number to be released |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
Unprovision
Unprovision an existing Advertiser.
Unprovisioning, or deprovisioning, an existing advertiser releases the resources associated with the advertiser including as appropriate subscription licenses. A work flow process to complete the unprovisioning is initiated. Once an advertiser is unprovisioned, they will no longer be authorized or able to use ContactAtOnce! for that Publisher account.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | -- | -- |
UnprovisionAgent
Logically deletes Agent from Advertiser account.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| agentId | Int | Required | Unique Id of Agent to be logically deleted. |
| userName | String | Required | User Name of the person executing the unprovision. |
| userEmail | String | Required | User Email Address of person executing the unprovision. |
| userId | Int | Required | User Id Email Address of person executing the unprovision. |
| userIP | String | Required | IP Address of person executing the unprovision. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
UpdateTrackedTelephoneNumber
Updates a previously provisioned tracked telephone number for an existing advertiser account.
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
| advertiserId | String | Required | AdvertiserId for the Advertiser. Unique Id from the Publisher. |
| request | UpdateTrackedTelephoneNumber | Required | Information about Tracked Number to be updated. |
| Response | ||
|---|---|---|
| ResponsePart | Data | Description |
| Header | Header | Standard ContactAtOnce! Web Service Response Header. |
| Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |