DigiCalls Developers / Quickstart

Connect your app to DigiCalls.

Send business messages, receive replies and keep your software in sync. One API, with permissions chosen for each integration.

API v1https://digicalls.com/api/v1

01 / YOUR SOFTWAREA business eventA request, appointment or customer update.

02 / DIGICALLSSMS APISend text or a published template through your approved number.

03 / YOUR SOFTWAREA reply or statusA signed webhook points your app to the message.

1. Prepare your business account

Request a DigiCalls account or sign in to an existing business.
Ask DigiCalls to confirm API Access and SMS messaging for that business. An API key does not activate a service.
For sending, complete SMS setup: approved business/sender registration, an active SMS-capable number, enabled sending and recorded recipient consent for the configured messaging purpose.
Choose a server-side environment for your application or integration platform. Each connected business uses its own credentials.

2. Create an API key

The account owner or administrator opens API & Integrations → Create an API key. Give the key a recognizable name, choose an expiry and select only the permissions your integration needs.

Start with	Permission
Confirm the connected business	`account:read`
List senders and read messages	`sms:read`
List and preview published templates	`sms:templates:read`

Copy the key when it is shown and put it in your server’s secret manager as DIGICALLS_API_KEY. It is not shown again. Do not put it in browser JavaScript, mobile app bundles, URLs, source control or support messages.

Add sms:send only when your app needs to send. Webhook and automation management have separate permissions. See all permissions →

3. Confirm the account

Run this on your server with the secret environment variable already configured.

cURL · account check

curl --fail-with-body \
  "https://digicalls.com/api/v1/account" \
  --header "Authorization: Bearer $DIGICALLS_API_KEY"

Example response

{
  "data": {
    "id": "YOUR_CUSTOMER_ID",
    "object": "account",
    "businessName": "Example Business"
  },
  "requestId": "REQUEST_ID"
}

Compare data.id with the Customer ID in your DigiCalls account. The credential selects the business; do not send an internal tenant ID.

4. Check your SMS sender

cURL · sender readiness

curl --fail-with-body \
  "https://digicalls.com/api/v1/sms/senders" \
  --header "Authorization: Bearer $DIGICALLS_API_KEY"

Select your assigned number from data[].phoneNumber. sendingReady: true means sender setup and the sending switch are ready; the recipient still needs valid consent and your account needs remaining allowance.

If it is false, review SMS settings with your account owner or DigiCalls. Keep working with template previews while sending setup is being completed.

5. Preview a message

Use a published template and supply its variables. This example is suitable for a service request, support case or another business workflow.

cURL · preview only

curl --fail-with-body --request POST \
  "https://digicalls.com/api/v1/sms/templates/preview" \
  --header "Authorization: Bearer $DIGICALLS_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "id": "builtin:request_received",
  "version": 1,
  "values": {
    "business_name": "Example Business",
    "reference": "REQUEST-001"
  }
}'

The response includes data.body, data.encoding and data.segments. Review the final text before sending.

Send your first SMS →Optional Postman checks

Choose the next step

Send & track SMS →Submit one message, reuse an event key and follow its delivery status.Receive replies →Verify a signed notification and retrieve the message in your application.Use your own templates →Publish reusable text with variables in the DigiCalls dashboard.Automate a workflow →Connect business events or schedule a template message for later.

Account information and call history are also available through GET /api/v1/account and GET /api/v1/calls with their corresponding read permissions. These guides focus on SMS integration.