Mobile Text Connect REST Service
Description
The Mobile Text Connect Service provides operations for managing a Mobile Text Connect Conversation. 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.
Format: XML
Method: POST
URI (regionally defined):
- North America : https://services.contactatonce.com/MobileTextConnectRestService.svc/InitiateMobileTextConversation
- Australia : https://services.contactatonce.com.au/MobileTextConnectRestService.svc/InitiateMobileTextConversation
- Europe : https://services.contactatonce.co.uk/MobileTextConnectRestService.svc/InitiateMobileTextConversation
| Request | |||
|---|---|---|---|
| Parameter | Type | Required | Description |
| ProviderId | Int | Required | ProviderId assigned by ContactAtOnce! to each Provider. |
| UserName | String | Required | UserName assigned by ContactAtOnce! to each Provider for use with the ContactAtOnce! API. |
| Password | String | Required | Password for the account. Password initially assigned by ContactAtOnce! but may be changed via the Publisher Portal. |
| 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 | Optional | 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 |
| ConsumerPhoneNumber | String | Required | Describes the consumer's Mobile Text Connect request. |
| ConsumerPhoneNumberCountryCode | String | Required | Country code of the mobile phone number of the consumer. |
| ConsumerFirstName | String | Optional | First Name of the Consumer |
| ConsumerLastName | String | Optional | Last Name of the Consumer |
| ConsumerQuestion | String | Optional | Message from the consumer |
| Response | ||
|---|---|---|
| Parameter | Type | Description |
| Status | String | Values include:
|
| Description | String | Nullable. Descriptive text that describes user exceptions. |
If you require assistance, please click on the “We’re In” button below, call 1 (678) 648-6961 or email us at support@contactatonce.com.