Welcome to the DIY Surveys API¶
Version 3.2
Welcome to the DIY Surveys API documentation. This documentation covers the general use of the DIY Surveys Open API.
Using this RESTful API you can:
- Send and receive messages, including SMS and WhatsApp messages.
- Track the delivery of sent messages.
- Retrieve message history.
- Manage keywords.
- Retrieve survey results.
Check our Getting Started Guide to help you.
API 3.2 documentation¶
API 3.2 is the latest documented contract. Its versioned route prefix is:
/v3.2/
The API is offered over HTTPS. HTTP is not supported.
Use the interactive Scalar API 3.2 reference to inspect the exact request and response schemas and generate client examples. The underlying OpenAPI document is also available directly.
API 3.2 removes the /api segment from the route prefix and introduces REST-style routes for messaging, keywords, and webhooks. See the API 3.2 migration guide before updating an existing integration. For the status of all versions, see API Versions.
Authentication¶
DIY Surveys supports Basic Access Tokens and HMAC authentication. See Security for details.
HTTP statuses¶
Every API returns a status. Standard responses include:
| 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. |
Additional status values are included in the relevant API method documentation.
Metadata¶
Metadata can be supplied with methods in versions that expose it, allowing you to track messaging and data more effectively. The current API 3.2 generated message model does not expose metadata. See Metadata for the version-specific guidance.
Callbacks¶
DIY Surveys supports callbacks for many methods. See Web Hooks and Callbacks.
Macros¶
DIY Surveys messages can include macros in versions that expose macro parameters, providing access to tools such as the DIY Surveys Tiny URL service. See Macros for the version-specific guidance.
API sections¶
- Keyword — keyword management.
- TinyUrl — TinyUrl creation.
- Messaging — message management.
- Survey — survey results.
- Recipient — recipient upload, de-duplication, and mobile-number validation.
- 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.