​
Overview

Place a Robo call request to a specified phone number.
  1. Send a voice call request and receive a call ID
  2. Get the status of the call using the call ID

​
Authentication

All API requests require an API key to be included in the headers: 
Authorization: Bearer [access-key]

​
Endpoint

POST https://voicebot.intron.health/voicebot/v1/robocall/call

​
Request Body JSON

FieldTypeDescriptionRequiredOptionsDefault
workflow_idStringUnique identifier for the workflow to be executedyes
workflow_paramsArrayArray of objects containing phone numbers and workflow variables. Phone number is required for each entry.yes
tts_voice_accentStringAccent for the voice used on the callnoSee Premium Voices section
tts_voice_genderStringGender of the voice used on the callnomale | female

​
Basic request and response sample

curl --location 'https://voicebot.intron.health/voicebot/v1/call' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer api-key' \
--data '{
    "tts_voice_accent": "igbo",
    "tts_voice_gender": "female",
    "workflow_id": "9b643eb4-0799-4761-bd34-9580eb315aaf",
    "workflow_params": [
        {
            "phone_number": "+2348076960623",
            "user_tag_identifiers": {"customer_id": "CUST001"},
            "workflow_variables": {
                "name": "James"
            }
        }
    ]
}'

​
Callback URL on Request Completion

When a workflow request is completed, Intron makes a POST request to your configured callback URL with the following JSON payload. This allows you to receive real-time updates about the status and results of your workflow requests.

​
Request Payload

{
  "request_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "COMPLETED",
  "integrator_id": "456e7890-e12b-34d5-b678-526614174111",
  "stats": {
    "total_calls": 2,
    "completed_calls": 2,
    "timeout_calls": 0,
    "replied_calls": 2,
    "response_options_counts": 2,
    "avg_duration": 30.0,
    "success_rate": 100.0
  },
  "request_calls": [
    {
      "id": "aaa111bb-2222-3333-4444-555555555555",
      "status": "COMPLETED",
      "phone_number": "+23480xxxxxxxx",
      "user_tag_identifiers": {"customer_id": "CUST001"},
      "call_result_duration": 32,
      "call_result_options_selected": "1",
      "created_at": "2024-06-21T10:00:00.000000"
    },
    {
      "id": "bbb222cc-3333-4444-5555-666666666666",
      "status": "COMPLETED",
      "phone_number": "+23480xxxxxxxx",
      "user_tag_identifiers": {"customer_id": "CUST002"},
      "call_result_duration": 28,
      "call_result_options_selected": "2",
      "created_at": "2024-06-21T10:01:00.000000"
    }
  ]
}
Expected Response: Your server should return HTTP 200 to acknowledge receipt of the callback.

​
Workflow Message Requirements

  • The message length after replacing variables must not exceed 4000 characters
  • Use [parameter_name] syntax to insert dynamic values in your message
  • Example: “Hello [name], your appointment is scheduled for [date] at [time]“

​
Premium Voices

Premium voices offer enhanced quality and more natural-sounding speech synthesis for your robocalls. These voices are marked with a Premium badge in the voice selection.

​
Available Voices

Afrikaans (Female) Premium
Afrikaans (Male) Premium
Amharic (Female) Premium
Arabic (Female) Premium
Bajju (Female) Premium
Bette (Female) Premium
Bette (Male) Premium
Chichewa (Female) Premium
Ebira (Female) Premium
Ebira (Male) Premium
Epie (Male) Premium
French (Male) Premium
Fulani (Male) Premium
Hausa (Male) Premium
Ibibio (Female) Premium
Ibibio (Male) Premium
Igala (Female) Premium
Igala (Male) Premium
Igbo (Female) Premium
Isoko (Male) Premium
Kanuri (Female) Premium
Luhya (Male) Premium
Nyandang (Female) Premium
Sesotho (Male) Premium
Tswana (Female) Premium
Twi (Female) Premium
Urhobo (Male) Premium
Yoruba (Female) Premium
Zulu (Female) Premium

​
Benefits for Robocalls

  • Enhanced audio quality for better call clarity
  • More natural-sounding speech synthesis
  • Improved customer experience and engagement
  • Professional voice quality for business communications

​
Quotas and Limits

  • Rate limit: 5 requests per second