​
Overview

Place a conversation workflow call request to initiate interactive voice conversations.
  1. Send a conversation workflow request and receive a batch ID
  2. Use the batch ID to track the processing status of your conversation requests
  3. The workflow must be of type “CONVERSATION” and have “ACTIVE” status

​
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/convobot/call

​
Request Body JSON

FieldTypeDescriptionRequiredOptionsDefault
workflow_idStringUnique identifier for the conversation 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 callnopidgin, englishpidgin
tts_voice_genderStringGender of the voice used on the callnomale | femalefemale

​
Basic request and response sample

curl -X POST "https://voicebot.intron.health/voicebot/v1/convobot/call" \
-H "Authorization: Bearer your_access_key_here" \
-H "Content-Type: application/json" \
-d '{
    "workflow_id": "550e8400-e29b-41d4-a716-446655440000",
    "workflow_params": [
        {
            "name": "John Doe",
            "phone_number": "+1234567890"
        }
    ],
    "tts_voice_accent": "pidgin",
    "tts_voice_gender": "female"
}'

​
Workflow Message Requirements

  • The workflow must be of type “CONVERSATION” and have “ACTIVE” status
  • Use double curly braces {{parameter_name}} syntax to insert dynamic values in your message template
  • Example: “Hello {{name}}, your appointment is scheduled for {{date}} at {{time}}”
  • The endpoint creates a batch record for processing multiple conversation requests

​
Quotas and Limits

  • Rate limit: 5 requests per second
  • Workflow must be of type “CONVERSATION” (not “ROBOCALL”)
  • Workflow status must be “ACTIVE”