VoiceNotify API

Endpoint

POST https://api-v1.delight.fit/voicenotify

This endpoint allows you to automatically trigger outbound AI voice calls.

Headers

• Content-Type: application/x-www-form-urlencoded
  This tells the system how the data is being sent.

Request Body

Example request:

curl --location 'https://api-v1.delight.fit/voicenotify' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'access_token=YOUR_ACCESS_TOKEN' \
--data-urlencode 'rows=[{...}]'

Field Explanations

• access_token
  Your private authentication key. This verifies that the request is coming from your system. Keep this secure.
• rows
  An array of call requests. You can send multiple calls in one request.
• message
  The voice message that the AI will speak during the call.
• caller
  The phone number that will appear as the caller ID.
• phone
  The recipient’s phone number (the person being called).
• language
  Language used for the voice call (e.g., "ja" for Japanese, "en" for English).
• UTC
  Time zone reference for scheduling and processing the call.
• callback_token
  A custom identifier you define to match call results with your internal records.
• callback_url
  The URL where call results will be sent after the call is completed.

Response

{
    "success": "1",
    "date": "Tue, 21 Jan 2025 09:11:55 GMT",
    "result": {
        "count": "2",
        "success_count": "2",
        "errors_count": "0",
        "message": "Call results are posted to the callback URL you provided after the call is completed."
    }
}

Response Field Explanation

• success – Whether the request was accepted (1 = successful).
• count – Total number of calls requested.
• success_count – Number of calls successfully processed.
• errors_count – Number of failed calls.
• message – General system message about the request.

Callback URL Response

After each call completes, the system sends the results to your callback URL.

Query Strings

• callee – The phone number that received the call.
• caller – The caller ID used for the call.
• call_result_code – Technical status code of the call result.

Example Callback Response

{
    "callee": "8190390456xx",
    "caller": "8150505008xx",
    "call_result_code": ""
}

Call Result Codes

After each call is completed, the system returns a call_result_code. This code tells you what happened during the call and can be used for reporting, retry logic, or automation workflows.