Welcome to the DIY Surveys API

Version 3.0

Welcome to the DIY Surveys API Documentation. This is for general use of DIY Surveys Open API. Using this RESTful API you can send and receive messages (SMS, WhatsApp, etc.), track the delivery of sent messages, retrieve the message history, manage keywords and surveys.

Check our Getting Started Guide to help you.

Base URL

All URLs referenced in this documentation have the following base url:

https://api.diysurveys.com/api/v3.0

The API is offered over HTTPS, HTTP is not supported in order to support a secure platform. For more information on versions please click here.

Authentication

DIY Surveys Platform supports Basic Access Tokens and the use of HMAC. For more information please click here.

HTTP Statuses

Every API will return a status which can be one of the following:

Status	Description
200	Success
400	Bad request. the HTTP message will vary depending on the type of problem.
401	Unauthorized. The session details cannot be successfully authenticated for the API method.

Any other Status values are included in the documentation for the API method.

Meta Data

It is possible to provide meta data with any API method (where appropriate) in order to help track your messaging more effectively. For more information on this refer to the Metadata Documentation.

Call Backs

DIY Surveys offers the ability for callbacks on many of the methods. For more information check here.

Macros

DIY Surveys makes it possible to include macros in your messaging that give access to powerful tools such as the DIY Surveys Tiny URL Service. For more information check here.

API's

The API's are split into the following:

1. Keyword - Keyword Management

2. TinyUrl - TinyUrl Creation

3. Message - SMS Message Management

4. Survey - Survey Results

5. Recipient - Upload Recipients with de-duplication and mobile number validation

6. Usage - Usage reporting

Frequently Asked Questions

After you have read all the documentation we have tried to answer all your frequently asked questions here.

Reporting Issues

DIY Surveys is focused on continually improving the quality of its software where our customer's satisfaction is our No 1 priority. If you experience any issues or have any question then please report it through the public GitHub Issues. If you believe the issue is related to the security of the service then please contact us directly.