Getting Started

1. Get A DIY SMS Account

In order to use the API you will need a DIY Surveys Account. You can register for this on the main administration platform at https://diysurveys.com.

2. Create an Acces Token

The DIY SMS API support Basic Security and HMAC Security. To use this you will need to create the type of access token you want to use. An access token can consist of two parts:

1. The AppId which appears in the authentication header.

2. For an HMAC Access token, the Key which is the hidden key used by your client and our API to encrypt and decrypt the authentication header.

3. To save time set up default Metadata to use with your messaging.

More recently we allow access tokens to last for as long as you require. Previously our approach was for a more strict security conformity we only allow an access token to last for 365 days. You no longer need to renew your access token before this time to ensure your access to the API continues to function correctly.

You can create as many access tokens as you require for different applications.

For more information please review our security information.

3. Add a Webhook

Webhooks are used for Callbacks. You can define as many Webhooks as you require to handle different events in the platform. You can also define custom webhooks with many of the API methods.

4. Send a Message

You are now ready to use the message API to send out an SMS.

You can use the Webhook feature in your account to review the callbacks you have set up and their success.

You can use the Message History to monitor inbound and outbound messages through your Account.

5. Set up an Organization

An organization is like an account, with the difference that you can share it with others in the DIY Surveys Platform. Use your own account as a test environment and an Organization as the live environment. Work with other team members to coordinate your efforts.