send/v1

Send SMS, Email, Link-SMS, MMS, Fax messages

RESTful style

New prettier version of documentation, OpenApi format

(Temporary location, don't bookmark, will move to tellustalk.com site soon)

--------------------------------------------------------------------------------------------------------------------------------------------------------------------

Request Headers and Response Format

Host URL: https://api.tellustalk.com/send/v1

Request Method

POST

Request Headers:

Content-Type: application/json (recommended), application/xml, or application/x-www-form-urlencoded

Authorization: Basic username:password (base64-encoded)

Response:

If successful, HTTP status code is 200 (OK)

Response data has one item (in the accepted format)

job_id: The id of the request, to use with /logs/v1

If failed: A HTTP status code and possibly an explaining text.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------

Request BODY:

A message with a few required and several optional values formatted as JSON (preferred) or XML.

Basic options shown below. For more options, see Rest Api Dictionary.

Request Examples

Example (Simplest):

Example (More than one recipient, with attachments):

Secure Messaging and Signatures

Secure messages and signature requests can be sent, simply by appending parameters in addressing.

More options for Sign/Login

The sign_options struct has additional values used in the login or signing process.

All values are optional.

Use the html_... options only if you want to do the extra work to make things more in line with your graphical style.

There is also an API for direct use (ie without sending a message), see shopping_cart/v1

Redirect to sign/login from your website

Login, Signatures and Payments may also be requested from your website without sending a message.

This is used to start a job when you handle communication with the end user, eg

• present the job link directly on your website

  • send the job link via your own mail system or other messaging channel

REQUEST

In the to field, use protocol log:, instead of address put your own string (an application id or your internal job id)

Example:

{

"to": ["log:yoursearchkey.sign"],

"text": "Please sign this simple test text!"

}

This example allows anyone to view and sign.

Normally you would specify personal ID on each login/sign:

{ "to": ["log:anystring.login199101012020.sign199101012020",

"sms:0760000000.login200111223030.sign200111223030"],

...}

Multiple recipients (max 5) are allowed in the log: redirect api requests.

anystring/yoursearchkey may be used as search key in our logs, to identify your different applications, or your internal job id.

anystring can be alphanumeric, an email address or almost anything without ? or & chars

RESPONSE

When you send to log: the HTTP response body includes the value log_href:

{

"job_id": "12345678",

"log_href": "https://ebox.nu/z_123code"

}

Use the log_href value for a redirect on your web page, the user is sent directly to our login and/or sign pages.

We store the job before the /send/v1 call returns to you.

So you can redirect your users to the ebox page immediately without showing a clickable link.

NOTE: This feature works with only a few recipients (max 5) in a single message.

Integrate using Wordpress Gravity Forms - contact us at support@tellustalk.com for documentation.

Cookie-free browsing!

When you embedd a request to tellustalk from your own site inside an IFRAME, cookies are not propagated in some browsers (notably Safari).

To get around this, put /nocookie/ first in the tellustalk redirect URL path, eg:

https://ebox.nu/nocookie/z_requestcode

https://ebox.nu/nocookie/payment/shopping_cart/v1.htm

etc.

When end user clicks or is redirected to the link, the /nocookie part is replaced with a session key that works like a cookie.