Initiate Mobile Text Conversation Extension API

Initiate Mobile Text Conversation Extension is a RESTful web service that allows authorized third parties to start a new MTC Conversation with listing details. This web service can not be used if there is an existing MTC Conversation with the consumer.

Since the API is based on REST principles, it’s very easy to write and test applications. You can use your browser to access URLs, and you can use pretty much any HTTP client in any programming language to interact with the API. The ContactAtOnce! Initiate MTC Variation REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

The Initiate Mobile Text Conversation Extension REST web service uses Basic Authentication. ContactAtOnce! can issue you an APIKEY to use. A username and password are not necessary.

Initiate Mobile Text Conversation Extension

This REST service is used to create a new MTC Conversation with a consumer.
Format: JSON
Method: POST

URI (regionally defined):

  • North America :
  • Australia :
  • Europe :

ConsumerPhoneNumberStringRequiredThe Consumer's mobile phone number.
MerchantPhoneNumberStringOptionalThe Mobile Text Connect number assigned to the account. If provided and and it matches a currently provisioned number, this number will be used. Otherwise, the default number will be used.
MessageTextStringRequiredMessage to be sent.
AdvertiserIdStringRequiredAdvertiserId for the Advertiser. Unique Id from the Publisher.
ConsumerFirstNameStringOptionalContacts First name
ConsumerLastNameStringOptionalContacts Last name
ListingDetailsStringOptionalContextual 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
  • 0 - None
  • 1 - HotLead
  • 2 - AnsweredHotLead
  • 3 - MissedCall

  • 0 - Success
  • 1 - Failure

FailureDescriptionStringNullable. Descriptive text that describes user exceptions.

Sample Header- JSON

Authorization: Basic {YOUR_API_KEY}
Accept: version=2;


	"MessageText":"This is Amy from Contact At Once!.  May I text you?", 

Sample Response- JSON

   "Status": 0,
   "FailureDescription": null

Back to Top