{"openapi":"3.1.0","info":{"title":"EnableCalls API","description":"Place calls, run campaigns and get every conversation's result from your own\nsystems, n8n, Make, Zapier or Pabbly.\n\nAuthenticate with `Authorization: Bearer ec_live_…` (create keys on **Developers** in the\ndashboard). Every rule of the product applies: the employee's own number, calling hours\n(9 AM–9 PM India time; 10 AM–7 PM for promotional), your do-not-call list and your coins.\nTry any write with `\"dry_run\": true` first. Guides: https://enablecalls.com/developers\n","version":"2026-10-31"},"servers":[{"url":"/v1"},{"url":"https://api.enablecalls.com/v1"}],"paths":{"/me":{"get":{"tags":["Account"],"summary":"Check your API key","operationId":"me_me_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/balance":{"get":{"tags":["Account"],"summary":"Get your coin balance","description":"1 coin = ₹1. Held coins are reserved for calls in progress.","operationId":"balance_balance_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/employees":{"get":{"tags":["Employees"],"summary":"List employees","operationId":"list_employees_employees_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Employee_"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/employees/{employee_id}":{"get":{"tags":["Employees"],"summary":"Get an employee","operationId":"get_employee_employees__employee_id__get","parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Employee Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/phone-numbers":{"get":{"tags":["Phone numbers"],"summary":"List phone numbers","operationId":"list_numbers_phone_numbers_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PhoneNumber_"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/phone-numbers/{number_id}":{"get":{"tags":["Phone numbers"],"summary":"Get a phone number","operationId":"get_number_phone_numbers__number_id__get","parameters":[{"name":"number_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Number Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumber"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/calls":{"post":{"tags":["Calls"],"summary":"Place a call","description":"Ask an employee to call one person now (or at the next calling window).","operationId":"create_call_calls_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Call"},{"$ref":"#/components/schemas/CallPreview"}],"title":"Response Create Call Calls Post"}}}},"200":{"description":"Dry run, or the same Idempotency-Key replayed"},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"get":{"tags":["Calls"],"summary":"List calls","description":"Single calls: API calls and lead-source leads, newest first.\n\n`status` is applied after reading, so a page may hold fewer than `limit`\nitems while `has_more` is true.","operationId":"list_calls_calls_get","parameters":[{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Employee Id"}},{"name":"phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"enum":["api","lead_source","facebook","dashboard","callback","missed_call"],"type":"string"},{"type":"null"}],"title":"Source"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["queued","scheduled","in_progress","completed","not_connected","failed","canceled","blocked"],"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"created_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created After"}},{"name":"created_before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Before"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/calls/{call_id}":{"get":{"tags":["Calls"],"summary":"Get a call","operationId":"get_call_calls__call_id__get","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Call"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/calls/{call_id}/cancel":{"post":{"tags":["Calls"],"summary":"Cancel a call","description":"Only a call still waiting (calling hours or a retry) can be cancelled.","operationId":"cancel_call_calls__call_id__cancel_post","parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Call"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/leads":{"get":{"tags":["Leads"],"summary":"List leads","description":"Newest first. Poll with `updated_after` to pick up results as calls finish.","operationId":"list_leads_leads_get","parameters":[{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Employee Id"}},{"name":"campaign_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Campaign Id"}},{"name":"outcome","in":"query","required":false,"schema":{"anyOf":[{"enum":["qualified","callback","converted","unqualified"],"type":"string"},{"type":"null"}],"title":"Outcome"}},{"name":"channel","in":"query","required":false,"schema":{"anyOf":[{"enum":["instant","bulk","inbound"],"type":"string"},{"type":"null"}],"description":"instant: single calls; bulk: campaigns; inbound: calls in.","title":"Channel"},"description":"instant: single calls; bulk: campaigns; inbound: calls in."},{"name":"hot","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hot"}},{"name":"sentiment","in":"query","required":false,"schema":{"anyOf":[{"enum":["positive","neutral","negative"],"type":"string"},{"type":"null"}],"title":"Sentiment"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"}},{"name":"updated_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated After"}},{"name":"created_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created After"}},{"name":"created_before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Before"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/leads/{lead_id}":{"get":{"tags":["Leads"],"summary":"Get a lead, with its transcript","operationId":"get_lead_leads__lead_id__get","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Lead Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/campaigns":{"get":{"tags":["Campaigns"],"summary":"List campaigns","operationId":"list_campaigns_campaigns_get","parameters":[{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Employee Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"post":{"tags":["Campaigns"],"summary":"Create a campaign","description":"Create a campaign with its people, optionally starting it (`launch: true`).","operationId":"create_campaign_campaigns_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/campaigns/{campaign_id}":{"get":{"tags":["Campaigns"],"summary":"Get a campaign","operationId":"get_campaign_campaigns__campaign_id__get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/campaigns/{campaign_id}/contacts":{"get":{"tags":["Campaigns"],"summary":"List a campaign's people","operationId":"list_campaign_contacts_campaigns__campaign_id__contacts_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["pending","queued","answered","no_answer","busy","failed","skipped"],"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignContactList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/campaigns/{campaign_id}/launch":{"post":{"tags":["Campaigns"],"summary":"Start calling","description":"Starts now, or at start_at when that is later.","operationId":"launch_campaign_campaigns__campaign_id__launch_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/campaigns/{campaign_id}/pause":{"post":{"tags":["Campaigns"],"summary":"Pause","operationId":"pause_campaign_campaigns__campaign_id__pause_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/campaigns/{campaign_id}/resume":{"post":{"tags":["Campaigns"],"summary":"Resume","operationId":"resume_campaign_campaigns__campaign_id__resume_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/campaigns/{campaign_id}/stop":{"post":{"tags":["Campaigns"],"summary":"Stop for good","description":"People not called yet are skipped. Calls already ringing finish.","operationId":"stop_campaign_campaigns__campaign_id__stop_post","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/contacts":{"get":{"tags":["Contacts"],"summary":"List contacts","operationId":"list_contacts_contacts_get","parameters":[{"name":"phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Search"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"post":{"tags":["Contacts"],"summary":"Create Contact","description":"Add a person. Their fields fill {{placeholders}} on campaign calls.","operationId":"create_contact_contacts_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/contacts/{contact_id}":{"get":{"tags":["Contacts"],"summary":"Get Contact","operationId":"get_contact_contacts__contact_id__get","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"patch":{"tags":["Contacts"],"summary":"Update Contact","operationId":"update_contact_contacts__contact_id__patch","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"delete":{"tags":["Contacts"],"summary":"Delete Contact","description":"Removes the person from your contacts; their past calls and leads stay.","operationId":"delete_contact_contacts__contact_id__delete","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Contact Id"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/contact-fields":{"get":{"tags":["Contacts"],"summary":"List your contact fields","operationId":"list_contact_fields_contact_fields_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFieldList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/dnc":{"get":{"tags":["Do-not-call"],"summary":"List do-not-call","operationId":"list_dnc_dnc_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DncList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"post":{"tags":["Do-not-call"],"summary":"Add Dnc","description":"Never call this number again. Calls already waiting for it are stopped too.","operationId":"add_dnc_dnc_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DncAdd"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DncEntry"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/dnc/{phone}":{"delete":{"tags":["Do-not-call"],"summary":"Remove Dnc","operationId":"remove_dnc_dnc__phone__delete","parameters":[{"name":"phone","in":"path","required":true,"schema":{"type":"string","title":"Phone"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/appointments":{"get":{"tags":["Appointments"],"summary":"List appointments","description":"Booked on calls or by your team, by start time (default: 30 days back, 90 ahead).","operationId":"list_appointments_appointments_get","parameters":[{"name":"starts_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Starts After"}},{"name":"starts_before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Starts Before"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/appointments/{appointment_id}":{"get":{"tags":["Appointments"],"summary":"Get Appointment","operationId":"get_appointment_appointments__appointment_id__get","parameters":[{"name":"appointment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Appointment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/webhook-endpoints":{"get":{"tags":["Webhooks"],"summary":"List webhook endpoints","operationId":"list_endpoints_webhook_endpoints_get","parameters":[],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"post":{"tags":["Webhooks"],"summary":"Create a webhook endpoint","description":"Events are POSTed to the URL, signed with the secret returned here (once).","operationId":"create_endpoint_webhook_endpoints_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointWithSecret"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/webhook-endpoints/{endpoint_id}":{"get":{"tags":["Webhooks"],"summary":"Get Endpoint","operationId":"get_endpoint_webhook_endpoints__endpoint_id__get","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Endpoint Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Endpoint"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"patch":{"tags":["Webhooks"],"summary":"Update Endpoint","operationId":"update_endpoint_webhook_endpoints__endpoint_id__patch","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Endpoint Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Endpoint"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Delete Endpoint","operationId":"delete_endpoint_webhook_endpoints__endpoint_id__delete","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Endpoint Id"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/webhook-endpoints/{endpoint_id}/rotate-secret":{"post":{"tags":["Webhooks"],"summary":"Get a new signing secret","description":"The old secret stops working at once; update your receiver first if you can.","operationId":"rotate_secret_webhook_endpoints__endpoint_id__rotate_secret_post","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Endpoint Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointWithSecret"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/webhook-endpoints/{endpoint_id}/test":{"post":{"tags":["Webhooks"],"summary":"Send a test event","description":"Sends a `test` event (`\"test\": true`) within a few seconds.","operationId":"send_test_webhook_endpoints__endpoint_id__test_post","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Endpoint Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sent"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/webhook-endpoints/{endpoint_id}/deliveries":{"get":{"tags":["Webhooks"],"summary":"List deliveries to an endpoint","operationId":"list_deliveries_webhook_endpoints__endpoint_id__deliveries_get","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Endpoint Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["pending","sent","failed"],"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/resend":{"post":{"tags":["Webhooks"],"summary":"Send a delivery again","operationId":"resend_webhook_endpoints__endpoint_id__deliveries__delivery_id__resend_post","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Endpoint Id"}},{"name":"delivery_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Delivery Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sent"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/events":{"get":{"tags":["Events"],"summary":"List events","description":"Everything sent (or that would be sent) to webhooks in the last 30 days.","operationId":"list_events_events_get","parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["call.completed","call.not_connected","call.inbound_missed","lead.updated","appointment.booked","appointment.updated"],"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"created_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"starting_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starting After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventList"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}},"/events/{event_id}":{"get":{"tags":["Events"],"summary":"Get an event","operationId":"get_event_events__event_id__get","parameters":[{"name":"event_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Event Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOut"}}}}}}}},"components":{"schemas":{"Appointment":{"properties":{"object":{"type":"string","const":"appointment","title":"Object","default":"appointment"},"id":{"type":"string","format":"uuid","title":"Id"},"employee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Employee Id"},"lead_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Lead Id"},"call_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Call Id"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"},"customer_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Phone"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Starts At"},"duration_minutes":{"type":"integer","title":"Duration Minutes"},"status":{"type":"string","title":"Status"},"source":{"type":"string","enum":["ai","manual"],"title":"Source"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","employee_id","lead_id","call_id","customer_name","customer_phone","starts_at","duration_minutes","status","source","notes","created_at"],"title":"Appointment"},"AppointmentList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Appointment"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["data"],"title":"AppointmentList"},"Balance":{"properties":{"object":{"type":"string","const":"balance","title":"Object","default":"balance"},"available_coins":{"type":"number","title":"Available Coins"},"held_coins":{"type":"number","title":"Held Coins"},"currency":{"type":"string","const":"INR","title":"Currency","default":"INR"}},"type":"object","required":["available_coins","held_coins"],"title":"Balance"},"Call":{"properties":{"object":{"type":"string","const":"call","title":"Object","default":"call"},"id":{"type":"string","format":"uuid","title":"Id"},"employee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Employee Id"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"details":{"additionalProperties":true,"type":"object","title":"Details"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"source":{"type":"string","enum":["api","lead_source","facebook","dashboard","callback","missed_call"],"title":"Source"},"status":{"type":"string","enum":["queued","scheduled","in_progress","completed","not_connected","failed","canceled","blocked"],"title":"Status"},"status_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Detail"},"attempts_made":{"type":"integer","title":"Attempts Made"},"max_attempts":{"type":"integer","title":"Max Attempts"},"next_attempt_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Attempt At"},"last_call_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Last Call Id"},"lead_id":{"type":"string","format":"uuid","title":"Lead Id"},"result":{"anyOf":[{"$ref":"#/components/schemas/CallResult"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","employee_id","phone","name","details","external_id","metadata","source","status","status_detail","attempts_made","max_attempts","next_attempt_at","last_call_id","lead_id","result","created_at"],"title":"Call"},"CallCreate":{"properties":{"employee_id":{"type":"string","format":"uuid","title":"Employee Id"},"phone":{"anyOf":[{"type":"string","maxLength":32,"minLength":5},{"type":"null"}],"title":"Phone"},"name":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"title":"Email"},"details":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"object","title":"Details"},"external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"max_attempts":{"type":"integer","maximum":3.0,"minimum":1.0,"title":"Max Attempts","default":1},"retry_after_minutes":{"type":"integer","maximum":1440.0,"minimum":15.0,"title":"Retry After Minutes","default":60},"scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled At"},"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Contact Id"},"lead_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Lead Id"},"dry_run":{"type":"boolean","title":"Dry Run","default":false}},"type":"object","required":["employee_id"],"title":"CallCreate","description":"Who to call: `phone`, or `contact_id` (a contact) or `lead_id` (call a lead again).\n\n`details` fill the employee's {{placeholders}} (up to 25). `external_id` and\n`metadata` (up to 4 KB) come back with every result and are never read by\nthe AI. `max_attempts` (1-3) and `retry_after_minutes` (15-1440) retry an\nunanswered call. `scheduled_at` (up to 30 days ahead) calls later; a time\noutside 9 AM-9 PM India time moves to the next opening."},"CallList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Call"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"CallList"},"CallPreview":{"properties":{"object":{"type":"string","const":"call_preview","title":"Object","default":"call_preview"},"dry_run":{"type":"boolean","const":true,"title":"Dry Run","default":true},"would_call":{"type":"boolean","title":"Would Call"},"status":{"type":"string","enum":["queued","scheduled","blocked","failed"],"title":"Status"},"next_attempt_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Attempt At"},"checks":{"items":{"$ref":"#/components/schemas/Check"},"type":"array","title":"Checks"},"warnings":{"items":{"type":"string"},"type":"array","title":"Warnings"}},"type":"object","required":["would_call","status","next_attempt_at","checks","warnings"],"title":"CallPreview"},"CallResult":{"properties":{"connected":{"type":"boolean","title":"Connected"},"outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Outcome"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"captured":{"additionalProperties":true,"type":"object","title":"Captured"},"hot":{"type":"boolean","title":"Hot"},"sentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","negative"]},{"type":"null"}],"title":"Sentiment","description":"How the customer felt by the end of the call."},"callback_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Callback At"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Seconds"},"coins_charged":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coins Charged"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ended At"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"}},"type":"object","required":["connected","outcome","summary","captured","hot","callback_at","duration_seconds","coins_charged","started_at","ended_at","recording_url"],"title":"CallResult"},"Campaign":{"properties":{"object":{"type":"string","const":"campaign","title":"Object","default":"campaign"},"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"employee_id":{"type":"string","format":"uuid","title":"Employee Id"},"contact_list_id":{"type":"string","format":"uuid","title":"Contact List Id"},"status":{"type":"string","title":"Status"},"purpose":{"type":"string","title":"Purpose"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"},"calling_window_start":{"type":"string","title":"Calling Window Start"},"calling_window_end":{"type":"string","title":"Calling Window End"},"time_zone":{"type":"string","title":"Time Zone"},"lines":{"type":"integer","title":"Lines"},"max_attempts":{"type":"integer","title":"Max Attempts"},"retry_after_minutes":{"type":"integer","title":"Retry After Minutes"},"brief":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brief"},"block_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Block Reason"},"counts":{"$ref":"#/components/schemas/CampaignCounts"},"progress_pct":{"type":"integer","title":"Progress Pct"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At"},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completed At"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","name","employee_id","contact_list_id","status","purpose","start_at","end_at","calling_window_start","calling_window_end","time_zone","lines","max_attempts","retry_after_minutes","brief","block_reason","counts","progress_pct","started_at","completed_at","created_at"],"title":"Campaign"},"CampaignContact":{"properties":{"object":{"type":"string","const":"campaign_contact","title":"Object","default":"campaign_contact"},"id":{"type":"string","format":"uuid","title":"Id"},"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Contact Id"},"phone":{"type":"string","title":"Phone"},"status":{"type":"string","title":"Status"},"attempts":{"type":"integer","title":"Attempts"},"next_attempt_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Attempt At"},"skip_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Skip Reason"},"last_call_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Last Call Id"}},"type":"object","required":["id","contact_id","phone","status","attempts","next_attempt_at","skip_reason","last_call_id"],"title":"CampaignContact"},"CampaignContactIn":{"properties":{"phone":{"type":"string","maxLength":40,"minLength":5,"title":"Phone"},"name":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"title":"Email"},"fields":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"object","title":"Fields","description":"Fill {{placeholders}} for this person."}},"type":"object","required":["phone"],"title":"CampaignContactIn"},"CampaignContactList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/CampaignContact"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"CampaignContactList"},"CampaignCounts":{"properties":{"total":{"type":"integer","title":"Total"},"pending":{"type":"integer","title":"Pending"},"in_progress":{"type":"integer","title":"In Progress"},"answered":{"type":"integer","title":"Answered"},"no_answer":{"type":"integer","title":"No Answer"},"busy":{"type":"integer","title":"Busy"},"failed":{"type":"integer","title":"Failed"},"skipped":{"type":"integer","title":"Skipped"},"retrying":{"type":"integer","title":"Retrying"},"qualified":{"type":"integer","title":"Qualified"},"callbacks":{"type":"integer","title":"Callbacks"},"won":{"type":"integer","title":"Won"},"not_interested":{"type":"integer","title":"Not Interested"},"talk_seconds":{"type":"integer","title":"Talk Seconds"},"coins_spent":{"type":"number","title":"Coins Spent"}},"type":"object","required":["total","pending","in_progress","answered","no_answer","busy","failed","skipped","retrying","qualified","callbacks","won","not_interested","talk_seconds","coins_spent"],"title":"CampaignCounts"},"CampaignCreate":{"properties":{"name":{"type":"string","maxLength":160,"minLength":1,"title":"Name"},"employee_id":{"type":"string","format":"uuid","title":"Employee Id"},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/CampaignContactIn"},"type":"array","maxItems":1000},{"type":"null"}],"title":"Contacts","description":"Up to 1,000 people."},"contact_list_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Contact List Id","description":"Or a contact list you already have."},"consent_source":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Consent Source","description":"Where these people agreed to be called (needed for promotional)."},"purpose":{"type":"string","enum":["service","promotional"],"title":"Purpose","default":"service"},"start_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start At","description":"Default: now."},"end_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End At","description":"Default: 7 days after start."},"calling_window_start":{"type":"string","format":"time","title":"Calling Window Start","default":"10:00:00"},"calling_window_end":{"type":"string","format":"time","title":"Calling Window End","default":"19:00:00"},"lines":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Lines","description":"Calls at the same time.","default":1},"max_attempts":{"type":"integer","maximum":3.0,"minimum":1.0,"title":"Max Attempts","default":2},"retry_after_minutes":{"type":"integer","maximum":1440.0,"minimum":15.0,"title":"Retry After Minutes","default":120},"brief":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Brief"},"launch":{"type":"boolean","title":"Launch","description":"Start calling (or schedule for start_at) right away.","default":false},"dry_run":{"type":"boolean","title":"Dry Run","default":false}},"type":"object","required":["name","employee_id"],"title":"CampaignCreate"},"CampaignList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Campaign"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"CampaignList"},"Check":{"properties":{"name":{"type":"string","title":"Name"},"ok":{"type":"boolean","title":"Ok"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"}},"type":"object","required":["name","ok"],"title":"Check"},"Contact":{"properties":{"object":{"type":"string","const":"contact","title":"Object","default":"contact"},"id":{"type":"string","format":"uuid","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"fields":{"additionalProperties":{"type":"string"},"type":"object","title":"Fields"},"consent_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consent Source"},"consent_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consent At"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","name","phone","email","notes","tags","fields","consent_source","consent_at","created_at"],"title":"Contact"},"ContactFieldList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/ContactFieldOut"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["data"],"title":"ContactFieldList"},"ContactFieldOut":{"properties":{"object":{"type":"string","const":"contact_field","title":"Object","default":"contact_field"},"label":{"type":"string","title":"Label"},"key":{"type":"string","title":"Key"},"hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hint"},"private":{"type":"boolean","title":"Private","description":"Never sent to the AI; still returned to you."}},"type":"object","required":["label","key","hint","private"],"title":"ContactFieldOut"},"ContactIn":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}],"title":"Name"},"phone":{"type":"string","maxLength":32,"minLength":5,"title":"Phone"},"email":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"title":"Email"},"notes":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Notes"},"tags":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Tags"},"fields":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"object","title":"Fields","description":"Your contact fields: label → value."},"consent_source":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Consent Source","description":"Where they agreed to be called."},"dry_run":{"type":"boolean","title":"Dry Run","default":false}},"type":"object","required":["phone"],"title":"ContactIn"},"ContactList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"ContactList"},"ContactPatch":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}],"title":"Name"},"phone":{"anyOf":[{"type":"string","maxLength":32,"minLength":5},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}],"title":"Email"},"notes":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Notes"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Tags"},"fields":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"type":"object","maxProperties":25},{"type":"null"}],"title":"Fields","description":"Replaces all fields."},"consent_source":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Consent Source"}},"type":"object","title":"ContactPatch"},"Delivery":{"properties":{"object":{"type":"string","const":"delivery","title":"Object","default":"delivery"},"id":{"type":"string","format":"uuid","title":"Id"},"event_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Event Id"},"event_type":{"type":"string","title":"Event Type"},"status":{"type":"string","enum":["pending","sent","failed"],"title":"Status"},"attempts":{"type":"integer","title":"Attempts"},"last_status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Status Code"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"next_attempt_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Attempt At"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"delivered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delivered At"}},"type":"object","required":["id","event_id","event_type","status","attempts","last_status_code","last_error","next_attempt_at","created_at","delivered_at"],"title":"Delivery"},"DeliveryList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Delivery"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"DeliveryList"},"DncAdd":{"properties":{"phone":{"type":"string","maxLength":32,"minLength":6,"title":"Phone"},"reason":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"title":"Reason"},"dry_run":{"type":"boolean","title":"Dry Run","default":false}},"type":"object","required":["phone"],"title":"DncAdd"},"DncEntry":{"properties":{"object":{"type":"string","const":"dnc_entry","title":"Object","default":"dnc_entry"},"id":{"type":"string","format":"uuid","title":"Id"},"phone":{"type":"string","title":"Phone"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","phone","reason","source","created_at"],"title":"DncEntry"},"DncList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/DncEntry"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"DncList"},"Employee":{"properties":{"object":{"type":"string","const":"employee","title":"Object","default":"employee"},"id":{"type":"string","format":"uuid","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"languages":{"items":{"type":"string"},"type":"array","title":"Languages"},"incoming_calls_enabled":{"type":"boolean","title":"Incoming Calls Enabled"},"max_call_seconds":{"type":"integer","title":"Max Call Seconds","description":"Longest a call may run; the employee says goodbye 30 s before.","default":600},"script_strictness":{"type":"integer","title":"Script Strictness","description":"1 talks freely .. 5 keeps exactly to the instructions' words.","default":3},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"},"placeholders":{"items":{"type":"string"},"type":"array","title":"Placeholders"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","name","role","status","languages","incoming_calls_enabled","phone_number","phone_number_id","placeholders","created_at"],"title":"Employee"},"Endpoint":{"properties":{"object":{"type":"string","const":"webhook_endpoint","title":"Object","default":"webhook_endpoint"},"id":{"type":"string","format":"uuid","title":"Id"},"url":{"type":"string","title":"Url"},"events":{"items":{"type":"string"},"type":"array","title":"Events"},"active":{"type":"boolean","title":"Active"},"last_status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Status"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"last_sent_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Sent At"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","url","events","active","last_status","last_error","last_sent_at","created_at"],"title":"Endpoint"},"EndpointIn":{"properties":{"url":{"type":"string","maxLength":500,"minLength":10,"title":"Url","description":"A public https URL."},"events":{"items":{"anyOf":[{"type":"string","enum":["call.completed","call.not_connected","call.inbound_missed","lead.updated","appointment.booked","appointment.updated"]},{"type":"string","const":"*"}]},"type":"array","maxItems":7,"minItems":1,"title":"Events"},"dry_run":{"type":"boolean","title":"Dry Run","default":false}},"type":"object","required":["url","events"],"title":"EndpointIn"},"EndpointList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Endpoint"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["data"],"title":"EndpointList"},"EndpointPatch":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"events":{"anyOf":[{"items":{"anyOf":[{"type":"string","enum":["call.completed","call.not_connected","call.inbound_missed","lead.updated","appointment.booked","appointment.updated"]},{"type":"string","const":"*"}]},"type":"array","maxItems":7,"minItems":1},{"type":"null"}],"title":"Events"}},"type":"object","title":"EndpointPatch"},"EndpointWithSecret":{"properties":{"object":{"type":"string","const":"webhook_endpoint","title":"Object","default":"webhook_endpoint"},"id":{"type":"string","format":"uuid","title":"Id"},"url":{"type":"string","title":"Url"},"events":{"items":{"type":"string"},"type":"array","title":"Events"},"active":{"type":"boolean","title":"Active"},"last_status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Status"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"last_sent_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Sent At"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"secret":{"type":"string","title":"Secret","description":"Shown once. Verify X-EnableCalls-Signature with it."}},"type":"object","required":["id","url","events","active","last_status","last_error","last_sent_at","created_at","secret"],"title":"EndpointWithSecret"},"Event":{"properties":{"object":{"type":"string","const":"event","title":"Object","default":"event"},"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","title":"Type"},"api_version":{"type":"string","title":"Api Version"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"test":{"type":"boolean","title":"Test","default":false},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"type":"object","required":["id","type","api_version","created_at","data"],"title":"Event"},"EventList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Event"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"EventList"},"Lead":{"properties":{"object":{"type":"string","const":"lead","title":"Object","default":"lead"},"id":{"type":"string","format":"uuid","title":"Id"},"employee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Employee Id"},"campaign_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Campaign Id"},"channel":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel"},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"null"}],"title":"Direction"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"outcome":{"anyOf":[{"type":"string","enum":["qualified","callback","converted","unqualified"]},{"type":"null"}],"title":"Outcome"},"hot":{"type":"boolean","title":"Hot"},"sentiment":{"anyOf":[{"type":"string","enum":["positive","neutral","negative"]},{"type":"null"}],"title":"Sentiment","description":"How the person felt on their latest call."},"callback_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Callback At"},"captured":{"additionalProperties":true,"type":"object","title":"Captured"},"contact":{"anyOf":[{"$ref":"#/components/schemas/LeadContact"},{"type":"null"}]},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"call_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Call Id"},"call_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Status"},"business_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Number"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Seconds"},"coins_charged":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coins Charged"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ended At"},"recording_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recording Url"},"transcript":{"anyOf":[{"items":{"$ref":"#/components/schemas/TranscriptLine"},"type":"array"},{"type":"null"}],"title":"Transcript"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","employee_id","campaign_id","channel","direction","name","phone","email","status","outcome","hot","callback_at","captured","contact","external_id","metadata","call_id","call_status","business_number","summary","duration_seconds","coins_charged","started_at","ended_at","recording_url","created_at","updated_at"],"title":"Lead"},"LeadContact":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"fields":{"additionalProperties":true,"type":"object","title":"Fields"}},"type":"object","required":["id","fields"],"title":"LeadContact"},"LeadList":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Lead"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"LeadList"},"Me":{"properties":{"object":{"type":"string","const":"me","title":"Object","default":"me"},"account":{"$ref":"#/components/schemas/MeAccount"},"key":{"$ref":"#/components/schemas/MeKey"},"api_version":{"type":"string","title":"Api Version"}},"type":"object","required":["account","key","api_version"],"title":"Me"},"MeAccount":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","required":["id","business_name","email"],"title":"MeAccount"},"MeKey":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"prefix":{"type":"string","title":"Prefix"},"scope":{"type":"string","enum":["full","read"],"title":"Scope"}},"type":"object","required":["id","name","prefix","scope"],"title":"MeKey"},"Page_Employee_":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/Employee"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"Page[Employee]"},"Page_PhoneNumber_":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array","title":"Data"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"Page[PhoneNumber]"},"PhoneNumber":{"properties":{"object":{"type":"string","const":"phone_number","title":"Object","default":"phone_number"},"id":{"type":"string","format":"uuid","title":"Id"},"number":{"type":"string","title":"Number"},"status":{"type":"string","title":"Status"},"channels":{"type":"integer","title":"Channels"},"employee_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Employee Id"},"incoming_enabled":{"type":"boolean","title":"Incoming Enabled"},"outgoing_enabled":{"type":"boolean","title":"Outgoing Enabled"},"paid_until":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid Until"}},"type":"object","required":["id","number","status","channels","employee_id","incoming_enabled","outgoing_enabled","paid_until"],"title":"PhoneNumber"},"Sent":{"properties":{"object":{"type":"string","const":"delivery_queued","title":"Object","default":"delivery_queued"},"queued":{"type":"boolean","title":"Queued"}},"type":"object","required":["queued"],"title":"Sent"},"TranscriptLine":{"properties":{"speaker":{"type":"string","enum":["employee","caller"],"title":"Speaker"},"text":{"type":"string","title":"Text"},"at_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"At Seconds"}},"type":"object","required":["speaker","text","at_seconds"],"title":"TranscriptLine"},"ErrorOut":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"request_id":{"type":"string"}}}}}},"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"ec_live_…","description":"Create a key on Developers in your EnableCalls dashboard."}}},"tags":[{"name":"Account","description":"Your key and your coins."},{"name":"Employees","description":"Your AI employees."},{"name":"Phone numbers","description":"Numbers your employees call from and answer."},{"name":"Calls","description":"Ask an employee to call one person."},{"name":"Leads","description":"The result of every conversation."},{"name":"Campaigns","description":"Call a list within calling hours."},{"name":"Contacts","description":"People and your own details about them."},{"name":"Appointments","description":"Booked on calls or by your team."},{"name":"Do-not-call","description":"Numbers never to call."},{"name":"Webhooks","description":"Results pushed to your URL as they happen."},{"name":"Events","description":"Everything that happened, for 30 days."}],"security":[{"ApiKey":[]}]}