Intergate vorText with any system using our API

vorText offers several API endpoints that allow you to integrate your account with any system that can call our API endpoints. If you need to send and/or receive text messages, messages to groups, manage keywords or manage contacts - you can use our API to easily manage data between platforms.

URL Endpoint:

All API calls within our API have the same endpoint:

https://vortext.ca/vapi/1.0/

* Please note: This endpoint must end with /, and all API operations use HTTP Post.


Authentication


HTTP requests to the API are protected with HTTP Basic authentication. You will use your vorText API Token the password for HTTP Basic authentication with vorText via an HTTP header.

Required HTTP Headers

NAME VALUE
Authorization Basic [Your API Token] (located in the My Account area of the vorText portal)
Action The action you wish to perform

Example:


<http method="post" url="https://vortext.ca/vapi/1.0/">
  type="header" name="Authorization" value="Basic [your API Token]" />
  type="header" name="Action" value="addcontact" />
  type="body" value='{ "firstname":"Anne", "lastname":"Droid", "company":"Joes Pizza Parlor", "phone":"7053802408" }'>      
</http>

Supported response formats:

JSON.


Date and Time Format:

All dates and times are in (GMT -5:00) Eastern Standard Time (EST) and the following format: YYYY-MM-DD HH:MM:SS