Mobile Text Connect Context Service

Partners who wish to add a website call to action that initiates a SMS conversation can use the built-in Tap To Text functionality (and not have to develop against APIs).
If a partner does wish to develop against APIs, then this API enables the website to send CAO context data, such as a vehicle or property ID displayed on the page. The CAO platform will then map this context data to the newly initiated conversation and display the context data in the Agent user interface. This marrying is made based on this assumption: if the API call and the conversation initiation happen within the same timeframe (approximately 5 minutes), then they are related. If two of these API calls happen within the timeframe then no mapping is made.

Format: XML
Method: POST

URI (regionally defined):

  • North America : https://services.contactatonce.com/MTCContextProvider.svc/MTCContext
  • Australia : https://services.contactatonce.com.au/MTCContextProvider.svc/MTCContext
  • Europe : https://services.contactatonce.co.uk/MTCContextProvider.svc/MTCContext

Request   
ParameterTypeRequiredDescription
ProviderIdIntRequiredProviderId assigned by ContactAtOnce! to each Provider.
UserNameStringRequiredUserName assigned by ContactAtOnce! to each Provider for use with the ContactAtOnce! API.
PasswordStringRequiredPassword for the account. Password initially assigned by ContactAtOnce! but may be changed via the Publisher Portal.
MerchantIdIntRequired if advertiserId is not providedContactAtOnce! 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.
AdvertiserIdStringRequired if merchantId is not providedAdvertiser'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.
MTCNumberStringRequiredMobile Text Connect phone number assigned to Advertiser for whom the web service call is being made.
ListingDetailsStringRequiredContextual data that describes the location from which the site visitor clicked. Listing details are passed to the merchant agents to facilitate effective answering. See Listing Details
PlacementIdIntOptionalPlacement Id from which the site visitor clicked to initiate the Mobile Text Connect session.
SessionIdStringOptionalIdentifier of the web session in which the user clicked the MTC link
OriginationURLStringOptionalURL from which the click action for MTCContext originated.
UserAgentStringStringOptionalUser Agent of the device where the MTCContext originated.

Response  
ParameterTypeDescription
StatusStringValues include:
  • Success - Requested transaction successfully completed
  • Failure - Requested transaction could not be completed including any user authentication errors.
DescriptionStringNullable. Descriptive text that describes user exceptions.