The Prelude API is a REST API and uses standard HTTP features and statuses.

The current URL is https://api.ding.live/v1.

​
Authentication

To perform requests on the API, you need to provide two secrets:

  • API_TOKEN - a token that identifies your application in the x-api-key header.
  • CUSTOMER_UUID - a token that identifies your app in the customer_uuid request body field.

You can get them in the Settings > API tab of the Dashboard.

Example request
curl --request POST \
     --url 'https://api.ding.live/v1/*' \
     --header 'Accept: application/json' \
     --header 'x-api-key: YOUR_API_TOKEN'

​
Errors

The Prelude API returns errors using a JSON object in the response body with a machine-readable code and a human-readable message.

See Errors for more details.

​
SDKs

Prelude offers SDKs for the most popular languages:

Node

Python

Go

Java

PHP

Ruby

C#

​
Reference

Explore the Prelude API reference to learn more about the available endpoints:

OTP

Send OTP codes to your users.

Lookup

Retrieve metadata about phone numbers.

Transactional

Send transactional messages to your users.

Errors

Handle errors in your integration.

Was this page helpful?

Errors