1. Overview
Nedzo AI provides a streamlined way to automate outbound calls, manage contact lists, and receive detailed call data via webhooks. Currently, you can:
1. Make Single Call – Trigger an outbound call to a specific contact.
2. Add to List – Insert a contact into a Nedzo AI calling list.
3. Mark as Finished – Stop further calls to a contact.
After each call, Nedzo AI sends a post-call webhook containing the final call details (transcript, outcome, etc.).
2. Base URL
All requests are made to:
https://app.nedzo.ai/api/1.1/wf/
3. Authentication
• Method: Typically, requests include your account credentials or an API key.
• Headers: Use an Authorization header if required.
• If you need specific credentials, please reach out to your Nedzo AI account manager.
4. Actions & Endpoints
4.1 Make Single Call
• Endpoint: POST /single-call
• Description: Initiates a single outbound call to the provided contact.
• Request Body Example (JSON):
{
"businessName": "{{contact.company_name}}",
"jobTitle": "{{contact.job_title}}",
"address": "{{contact.address}}",
"city": "{{contact.city}}",
"state": "{{contact.state}}",
"country": "{{contact.country}}",
"postal_code": "{{contact.postal_code}}",
"full_address": "{{contact.full_address}}",
"email": "{{contact.email}}",
"first_name": "{{contact.first_name}}",
"last_name": "{{contact.last_name}}",
"phone": "{{contact.phone}}",
"organizationId": "your_organization_id",
"agentId": "your_agent_id"
}Replace {{...}} with actual contact fields.
4.2 Add to List
• Endpoint: /add-to-list
• Description: Adds a new contact (or updates an existing one) in Nedzo AI’s calling list.
• Request Body Example (JSON):
{
"Business Name": "Business name",
"Job Title": "Job title",
"contact_id": "Tt7uK040O2XrFThZCgg4",
"first_name": "First name",
"last_name": "Last name",
"full_name": "First Name Last Name",
"email": "email@nedzo.ai",
"phone": "+13024405445",
"address1": "Street Address",
"city": "City",
"state": "Delaware",
"country": "US",
"postal_code": "19702",
"full_address": "Street Address City Delaware 19702",
"timezone": "America/New_York",
"customData": {
"Organization": "your_organization_id",
"List": "your_list_id"
}
}Use customData to pass any extra info needed (e.g., internal identifiers).
4.3 Mark as Finished
• Endpoint: POST /contact-mark-as-finished
• Description: Tells Nedzo AI to stop further calls to a specific contact.
• Request Body Example (JSON):
{
"phone": "<phone>",
"customData": {
"Organization": "your_organization_id"
}
}
5. Post-Call Webhook
After each call completes, Nedzo AI sends a webhook to your specified endpoint with details about the call. Below is an example payload:
{
"firstName": "<firstName>",
"lastName": "<lastName>",
"phone": "<phone>",
"startedAt": "<startedAt>",
"email": "<email>",
"agentName": "<agentName>",
"callId": "<callId>",
"length": "<length>",
"outcome": "<outcome>",
"summary": "<summary>",
"agentPhoneNumber": "<agentPhoneNumber>",
"transcript": "<transcript>",
"dials": "<dials>",
"contactBusinessName": "<contactBusinessName>",
"contactJobTitle": "<contactJobTitle>",
"contactStreetAddress": "<contactStreetAddress>",
"contactCity": "<contactCity>",
"contactState": "<contactState>",
"contactCountry": "<contactCountry>",
"contactPostalCode": "<contactPostalCode>",
"contactFullAddress": "<contactFullAddress>",
"contactList": "<contactList>"
}
5.1 Receiving the Webhook
• Method: POST
• Content-Type: application/json
• Recommended Response: 200 OK or similar success response upon successful receipt.
5.2 Configuring Your Webhook URL
Inside the Nedzo AI dashboard, you can set or update the webhook endpoint where these call details will be posted.
Make sure your endpoint is publicly accessible (or uses secure tunneling) and can handle JSON requests.
6. Warm Transfers
Nedzo AI supports both cold transfers (direct) and warm transfers, allowing a handoff from the AI to a live agent with context. If you need to configure warm transfers, use Nedzo AI's in-app UI.
7. General Error Handling
• 4xx Errors: Typically indicate invalid data or missing parameters in your request.
• 5xx Errors: Server issues on Nedzo AI’s side. Contact support if these persist.
• Webhook Failures: If your endpoint fails to respond, Nedzo AI will retry a few times before marking the webhook as undelivered.
8. Hosting & Distribution
• Help Center: We recommend adding this guide to your existing Nedzo AI Help Center in the “Integrations” section.
• PDF Version: We also provide a PDF copy you can share internally or with your dev team.
9. Need More Endpoints?
If you require additional endpoints or custom features, let us know. We can create new actions or expand the data we send in webhooks based on your use case.
Contact us at support@nedzo.ai for more information or additional requests.