TinyUrl

The TinyUrl API's allow you to generate tiny URL's for your SMS messages.

Custom Tiny URL's

DIY Surveys supports custom Tiny URL's for each user of the API. It is possible for you to use the standard DIY Surveys Tiny URL (diyu.me) or for us to register a domain and set this up for your account. For more information on this please contact us directly.

We also allow you to specify the tiny url as part of the call. In this instance you will be responsible for ensuring it has been successfully mapped with the DIY Surveys Platform.

Metadata

It is possible to associate meta data at the same time as registering the tinyurl so that it can be provided in any callback.

Register

Register a URL in return for a tiny URL.

URL: base/TinyUrl/Register
Method: POST
{
  "FullUrl": "http://diysurveys.com",
  "TinyUrl": "https://diyu.me",
  "MetaData": 
    [
        { "RequestID": "1234567890DEFED" },
        { "OrgID": 1010 },
        { "Instance": "ETRERT"},
        { "Campaign": 1242 },
        { "TimeStamp": "2020-02-04T11:47:33.645773+00:00" }
    ]
}

Returns

{ "http://diyu.me/23423" }

Statuses

Status

Description

400

There was a problem registering the tiny url

RegisterList

Register a list of URL's in return for a list of tiny URL's

URL: base/TinyUrl/RegisterList
Method: POST
{
  "UrlList": [
    {
      "FullUrl": "https://diysurveys.com"
      "TinyUrl": "https://diyu.me"
    },
    {
      "FullUrl": "https://www.google.co.uk"
      "TinyUrl": "https://diyu.me",
      "MetaData": 
      [
        { "RequestID": "1234567890DEFED" },
        { "OrgID": 1010 },
        { "Instance": "ETRERT"},
        { "Campaign": 1242 },
        { "TimeStamp": "2020-02-04T11:47:33.645773+00:00" }
      ]
    }
  ]
}

Returns

{
  "UrlList": [ "tinyUrl1", "tinyUrl2" ]
}

Statuses

Status

Description

400

There was a problem registering the tiny url

Last updated

Was this helpful?