Create Agent

Create a new voice AI agent configuration and settings

POST https://services.leadconnectorhq.com/voice-ai/agents

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Body

string

default:"LOC123456789ABCDEF"

required

Unique identifier for the account where this agent will operate

string

default:"Customer Support Agent"

Display name for the voice AI agent, between 1-40 characters. Default: “My Agent {random 3 digit number}”

string

default:"Acme Corporation"

Name of the business this agent represents. Default: Uses account name

string

Initial greeting spoken when the agent answers calls. Default: Auto generated

string

Custom instructions defining the agent’s behavior and personality. Default: Basic prompt generated automatically

string

default:"507f1f77bcf86cd799439011"

Identifier for the speech synthesis voice from available voice options. Default: Auto generated

string

Language code for the agent’s speech and understanding. Default: “en-US” Posibles valores: ‘en-US’, ‘pt-BR’, ‘es’, ‘fr’, ‘de’, ‘it’, ‘nl-NL’, ‘multi’

string

Tolerance level for caller response delays. Default: “high” Posibles valores: ‘low’, ‘medium’, ‘high’

number

default:"600"

Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes)

boolean

default:"True"

Enables automatic reminders when callers are silent. Default: true

number

default:"5"

Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds

string

default:"+1234567890"

Phone number for receiving inbound calls to this agent. Default: null

string

default:"pool_507f1f77bcf86cd799439011"

Identifier for the number pool managing phone number allocation. Default: null

string[]

Array of workflow IDs to trigger automatically when calls end. Default: []

object

Configuration for post-call email notifications to various recipients. Default: []

object[]

Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7)

Show cada item

number

default:"1"

required

Day of the week for this working hours configuration (Monday=1 to Sunday=7) Posibles valores: 1, 2, 3, 4, 5, 6, 7

object[]

required

Array of time intervals when the agent is available on this day

Show cada item

number

default:"9"

required

Starting hour of the working interval in 24-hour format (0-23)

number

default:"17"

required

Ending hour of the working interval in 24-hour format (0-23)

number

default:"0"

required

Starting minute of the working interval (0-59)

number

default:"30"

required

Ending minute of the working interval (0-59)

string

default:"America/New_York"

IANA timezone identifier affecting working hours and scheduling. Default: Account timezone

boolean

default:"False"

Prevents this agent from being used as a fallback option. Default: false (Available as backup agent)

object

Language translation settings including enablement flag and target language code. Rules: (1) translation.enabled can only be true if the agent’s language is not en-US; (2) when enabled, translation.language must be either the agent’s language or en-US; (3) when enabled, translation.language is required.

Respuestas

201 - Agent created successfully

string

default:"507f1f77bcf86cd799439011"

required

Unique identifier for the created agent

string

default:"LOC123456789ABCDEF"

required

Unique identifier for the account where this agent operates

string

default:"Customer Support Agent"

required

Display name of the voice AI agent

string

default:"Acme Corporation"

required

Name of the business this agent represents

string

required

Greeting message spoken when the agent answers calls

string

required

Custom instructions defining the agent’s behavior

string

default:"507f1f77bcf86cd799439011"

required

Identifier for the speech synthesis voice being used

string

default:"en-US"

required

Language code for the agent’s speech and understanding

string

default:"medium"

required

Current tolerance level for caller response delays

number

default:"600"

required

Maximum call duration in seconds, between 180-900

boolean

default:"True"

required

Indicates whether automatic idle reminders are enabled

number

default:"5"

required

Seconds to wait before sending idle reminders, between 1-20

string

default:"+1234567890"

Phone number for receiving inbound calls

string

default:"pool_507f1f77bcf86cd799439011"

Identifier for the number pool managing this agent’s phone allocation

string[]

Array of workflow IDs triggered automatically when calls end

object

Current post-call notification settings including recipient configuration

object[]

Time intervals when the agent accepts calls, organized by day of week

Show cada item

number

default:"1"

required

Day of the week for this working hours configuration (Monday=1 to Sunday=7) Posibles valores: 1, 2, 3, 4, 5, 6, 7

object[]

required

Array of time intervals when the agent is available on this day

Show cada item

number

default:"9"

required

Starting hour of the working interval in 24-hour format (0-23)

number

default:"17"

required

Ending hour of the working interval in 24-hour format (0-23)

number

default:"0"

required

Starting minute of the working interval (0-59)

number

default:"30"

required

Ending minute of the working interval (0-59)

string

default:"America/New_York"

required

IANA timezone identifier for working hours and scheduling

boolean

default:"False"

required

Indicates whether this agent is excluded from backup scenarios

object

Current language translation settings including enablement status and target language

{
  "id": "507f1f77bcf86cd799439011",
  "locationId": "LOC123456789ABCDEF",
  "agentName": "Customer Support Agent",
  "businessName": "Acme Corporation",
  "welcomeMessage": "Hello! Thank you for calling. How can I assist you today?",
  "agentPrompt": "You are a helpful customer service representative.",
  "voiceId": "507f1f77bcf86cd799439011",
  "language": "en-US",
  "patienceLevel": "medium",
  "maxCallDuration": 600,
  "sendUserIdleReminders": true,
  "reminderAfterIdleTimeSeconds": 5,
  "inboundNumber": "+1234567890",
  "numberPoolId": "pool_507f1f77bcf86cd799439011",
  "callEndWorkflowIds": [],
  "agentWorkingHours": [],
  "timezone": "America/New_York",
  "isAgentAsBackupDisabled": false
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/voice-ai/agents' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "locationId": "LOC123456789ABCDEF",
  "agentName": "Customer Support Agent",
  "businessName": "Acme Corporation",
  "welcomeMessage": "Hello! Thank you for calling Acme Corporation. How can I assist you today?",
  "agentPrompt": "You are a helpful customer service representative. Always be polite and professional.",
  "voiceId": "507f1f77bcf86cd799439011",
  "language": "en-US",
  "patienceLevel": "low",
  "maxCallDuration": 600,
  "sendUserIdleReminders": true,
  "reminderAfterIdleTimeSeconds": 5,
  "inboundNumber": "+1234567890",
  "numberPoolId": "pool_507f1f77bcf86cd799439011",
  "callEndWorkflowIds": [
    "wf_507f1f77bcf86cd799439011",
    "wf_507f1f77bcf86cd799439012"
  ],
  "agentWorkingHours": [
    {
      "dayOfTheWeek": 1,
      "intervals": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 30
        }
      ]
    }
  ],
  "timezone": "America/New_York",
  "isAgentAsBackupDisabled": false
}'

const response = await fetch('https://services.leadconnectorhq.com/voice-ai/agents', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"locationId": "LOC123456789ABCDEF", "agentName": "Customer Support Agent", "businessName": "Acme Corporation", "welcomeMessage": "Hello! Thank you for calling Acme Corporation. How can I assist you today?", "agentPrompt": "You are a helpful customer service representative. Always be polite and professional.", "voiceId": "507f1f77bcf86cd799439011", "language": "en-US", "patienceLevel": "low", "maxCallDuration": 600, "sendUserIdleReminders": true, "reminderAfterIdleTimeSeconds": 5, "inboundNumber": "+1234567890", "numberPoolId": "pool_507f1f77bcf86cd799439011", "callEndWorkflowIds": ["wf_507f1f77bcf86cd799439011", "wf_507f1f77bcf86cd799439012"], "agentWorkingHours": [{"dayOfTheWeek": 1, "intervals": [{"startHour": 9, "startMinute": 0, "endHour": 17, "endMinute": 30}]}], "timezone": "America/New_York", "isAgentAsBackupDisabled": false}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/voice-ai/agents',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"locationId": "LOC123456789ABCDEF", "agentName": "Customer Support Agent", "businessName": "Acme Corporation", "welcomeMessage": "Hello! Thank you for calling Acme Corporation. How can I assist you today?", "agentPrompt": "You are a helpful customer service representative. Always be polite and professional.", "voiceId": "507f1f77bcf86cd799439011", "language": "en-US", "patienceLevel": "low", "maxCallDuration": 600, "sendUserIdleReminders": true, "reminderAfterIdleTimeSeconds": 5, "inboundNumber": "+1234567890", "numberPoolId": "pool_507f1f77bcf86cd799439011", "callEndWorkflowIds": ["wf_507f1f77bcf86cd799439011", "wf_507f1f77bcf86cd799439012"], "agentWorkingHours": [{"dayOfTheWeek": 1, "intervals": [{"startHour": 9, "startMinute": 0, "endHour": 17, "endMinute": 30}]}], "timezone": "America/New_York", "isAgentAsBackupDisabled": false},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/voice-ai/agents');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'locationId': 'LOC123456789ABCDEF', 'agentName': 'Customer Support Agent', 'businessName': 'Acme Corporation', 'welcomeMessage': 'Hello! Thank you for calling Acme Corporation. How can I assist you today?', 'agentPrompt': 'You are a helpful customer service representative. Always be polite and professional.', 'voiceId': '507f1f77bcf86cd799439011', 'language': 'en-US', 'patienceLevel': 'low', 'maxCallDuration': 600, 'sendUserIdleReminders': true, 'reminderAfterIdleTimeSeconds': 5, 'inboundNumber': '+1234567890', 'numberPoolId': 'pool_507f1f77bcf86cd799439011', 'callEndWorkflowIds': ['wf_507f1f77bcf86cd799439011', 'wf_507f1f77bcf86cd799439012'], 'agentWorkingHours': [{'dayOfTheWeek': 1, 'intervals': [{'startHour': 9, 'startMinute': 0, 'endHour': 17, 'endMinute': 30}]}], 'timezone': 'America/New_York', 'isAgentAsBackupDisabled': false}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo