Mobile Text Connect Service
Description
The Mobile Text Connect Service provides operations for managing a Mobile Text Connect Conversation.
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/TextToChatService.asmx?WSDL
- Australia : https://services.contactatonce.com.au/TextToChatService.asmx?WSDL
- Europe : https://services.contactatonce.co.uk/TextToChatService.asmx?WSDL
NOTE: You may also use the InitiateMobileTextConversation REST service.
Requests
InitiateMobileTextConversation
Initiate a Mobile Text Connect Conversation Request. This is intended to support a consumer-initiated text conversation (e.g. consumer clicks on a website button). No actual SMS is sent. The call can include metadata in the ListingDetails parameter.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | 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. |
placementId | Int | Required | Placement Id from which the site visitor clicked to initiate the Mobile Text Connect session. |
listingDetails | String | Optional | Contextual 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 |
consumer | ConsumerInformation | Required | Describes the consumer's Mobile Text Connect request. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
SendMobileTextConversationMessage
Send a Mobile Text Connect Message Request. This sends a message from the agent to the consumer.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | 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. |
agentId | String | Required if an agent has not yet been assigned to the conversation | Id of the answering Agent |
consumerPhoneNumber | String | Required | The mobile phone number of the consumer. |
consumerPhoneNumberCountryCode | String | Required | Country code of the mobile phone number of the consumer. |
messageText | String | Required | The message to be sent via SMS to the Consumer Phone Number. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
SendMobileTextConversationMediaMessage
Send a Mobile Text Connect Message Request with media. This sends a message with media from the agent to the consumer. If the carrier supports MMS, then the phone displays the media that is hosted at the URL. If the carrier does not support MMS, then the phone just shows the URL.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | 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. |
agentId | String | Required if an agent has not yet been assigned to the conversation | Id of the answering Agent |
consumerPhoneNumber | String | Required | The mobile phone number of the consumer. |
consumerPhoneNumberCountryCode | String | Required | Country code of the mobile phone number of the consumer. |
messageText | String | Required | The message to be sent via SMS to the Consumer Phone Number. |
mediaUrl | String | Required | URL to the hosted media. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
MarkConsumerOptOut
Mark a consumer’s mobile phone number as opted out.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | 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 | The mobile phone number of the consumer. |
consumerPhoneNumberCountryCode | String | Required | Country code of the mobile phone number of the consumer. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |
InitiateInteractiveAlert
Allows authorized third parties to send a Mobile Text Connect message to a shopper with an optional alert going to Agent. This enables a third party to send one message to a consumer and one message to an agent.
An account-level setting determines whether or not the agent is alerted when the SMS message is sent. If this setting is off, then the agent is only alerted if the consumer responds.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | 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. |
interactiveAlert | InteractiveAlert | Required | Information about the Shopper for the alert. |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. |
Body | Base Response | Standard ContactAtOnce! Web Service Response Body. |