curl -X POST https://api.nedzo.ai/v1/call \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agentId": "123e4567-e89b-12d3-a456-426614174000",
"type": "contact",
"contactId": "456e4567-e89b-12d3-a456-426614174000"
}'
curl -X POST https://api.nedzo.ai/v1/call \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agentId": "123e4567-e89b-12d3-a456-426614174000",
"type": "phoneNumber",
"phoneNumber": "+14155551234",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"businessName": "Acme Inc",
"customFields": {
"Lead Source": "Website",
"Company Size": "50-100"
}
}'
{
"conversationId": "123e4567-e89b-12d3-a456-426614174000"
}
Calls
Make a call
Initiate an outbound AI voice call via the Nedzo REST API. Specify the agent, phone number, and optional metadata to start an automated conversation.
POST
/
call
curl -X POST https://api.nedzo.ai/v1/call \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agentId": "123e4567-e89b-12d3-a456-426614174000",
"type": "contact",
"contactId": "456e4567-e89b-12d3-a456-426614174000"
}'
curl -X POST https://api.nedzo.ai/v1/call \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agentId": "123e4567-e89b-12d3-a456-426614174000",
"type": "phoneNumber",
"phoneNumber": "+14155551234",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"businessName": "Acme Inc",
"customFields": {
"Lead Source": "Website",
"Company Size": "50-100"
}
}'
{
"conversationId": "123e4567-e89b-12d3-a456-426614174000"
}
string
required
UUID of the agent to use for the call
string
required
Type of call target. Valid values:
contact, phoneNumberobject
Custom variables to pass to the assistant. These override contact field values.
- Contact
- Phone Number
The agent must have a phone number assigned in Agent Builder > Settings before you can make outbound calls. Calls fail with
400 Bad Request if the agent has no number connected — Nedzo never falls back to another workspace number, since that would surface the wrong caller ID to the recipient.Errors
| Status | Detail | Cause |
|---|---|---|
400 | Agent does not have a phone number assigned. Please assign a number in Agent Builder > Settings before making outbound calls. | The agent has no phone number connected. |
400 | Phone number is not synced to voice engine. | The agent’s assigned number hasn’t finished syncing to the voice engine yet. |
400 | Phone number is not active. | The agent’s assigned number is in pending or another non-active status. |
400 | Invalid call type | type is something other than contact or phoneNumber. |
curl -X POST https://api.nedzo.ai/v1/call \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agentId": "123e4567-e89b-12d3-a456-426614174000",
"type": "contact",
"contactId": "456e4567-e89b-12d3-a456-426614174000"
}'
curl -X POST https://api.nedzo.ai/v1/call \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"agentId": "123e4567-e89b-12d3-a456-426614174000",
"type": "phoneNumber",
"phoneNumber": "+14155551234",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"businessName": "Acme Inc",
"customFields": {
"Lead Source": "Website",
"Company Size": "50-100"
}
}'
{
"conversationId": "123e4567-e89b-12d3-a456-426614174000"
}
Was this page helpful?