Loading...

Overview


TrueDialog’s RESTful API allows you to manage your account, contacts, campaigns, keywords, and much more. The tutorial pages will teach you the basics and you will quickly learn how to send gateway campaigns and more sophisticated campaigns that use keywords and contact lists.

While you can perform these operations directly from a REST client utility such as curl, WizTools RESTClient or the Postman plugin on Chrome.


Base URL

All the URLs referenced in the tutorails have the following base:

https://api.3seventy.com/api/v2.1

To ensure data privacy the REST API is served over HTTPS. HTTP requests to the REST API should use the HTTP protocol version 1.1 (HTTP/1.1).


Authentication

TrueDialog endpoints are protected with HTTP Basic authentication and you will have to provide your login and password with every REST call.

You received your login, password and accountId in the account creation confirmation email. We will reference them as {Login}, {Password} and {AccountId} in all the tutorial pages.

You can also use {apikey} and {Secret} in place of {Login} and {password}, it is a light weight and more secured way of authentication mechanism. You can GET your {apikey} and {secret} using the following endpoint.

GET   https://api.3seventy.com/api/v2.1/account/{AccountId}/apikey

Channels

TrueDialog supports different communication / transport channels: SMS, MMS, Voice and Email.

You need to specify the ID of the channel you want to use with many endpoints. Your account is already provisioned with a SMS channel and you received the ID in the confirmation email.


Verify your API acccount credentials

Verify that you can connect to the API using your supplied credentials. This can be accomplished by sending a HTTP/1.1 GET to the account resource

GET   https://api.3seventy.com/api/v2.1/account/{AccountId}

Send a Gateway Campaign with curl

curl -v --user {apikey}:{secret} "https://api.3seventy.com/api/v2.1/account/{AccountId}" \  
-H "Content-Type: application/json" \
-H "Accept: application/json