Callingly

Permanently delete one agent (Callingly user) from the account, removing them from every team they are on. This changes what the account is billed for.

Agency partners only: permanently delete a client account and everything under it. Prefer Set client active with is_active 0, which suspends the account reversibly.

Permanently delete one lead and its call history. Answers a JSON object whose success field is true.

Remove one agent from one team. The agent's own Callingly user is not deleted -- only their assignment to this team -- so they stop being rung for this team's calls.

Permanently delete one webhook, so Callingly stops posting that event to its target URL. Answers a JSON object whose message field confirms the deletion.

List the account's agents (Callingly users), with each one's phone number and extension, timezone, ring priority, do-not-disturb state and whether they are currently available to take a call. Returns a `data` array plus a `count`.

Retrieve one agent's weekly availability. Returns a bare JSON array of seven days, Sunday first, each with is_available and the time windows the agent can be called in; a window start may read allday.

List Callingly calls, newest first, optionally narrowed to a date range or one team. Returns a paginated envelope: `data` holds the calls and `links`/`meta` carry Laravel's page cursors, so read `meta.last_page` to know whether to ask for another page.

Retrieve one Callingly call by id, with its outcome, recording and lead. Returns the call's direction, status and lead status, ring status, duration in seconds, the agent who took it, the lead it reached, the team profile it ran under, any notes, and -- when Callingly recorded and processed the call -- recording_url, waveform_url, transcript and sales_advice.

List the client accounts under an agency partner account. Returns a `data` array of clients, each with its numeric id -- the id to pass as account_id on the operations that accept one -- plus the client's name, email and the number of users and phone numbers it is billed for. An account that is not an agency partner gets an empty list.

List leads, optionally narrowed to a date range or one phone number. Returns a bare JSON array (no `data` envelope -- unlike Get calls and Get teams), each lead carrying its owner, team, status, result, stage, tags, scheduled call time and the calls placed to it.

Retrieve one lead by id, with its owner, team, status, result, stage, tags, scheduled call time and whether it is stopped or blocked from further calls.

List the calling teams on the account. Returns a `data` array of teams, each with its numeric id, account id and name -- the ids other operations take as team_id.

Retrieve one team's full calling configuration: call mode, the agent and lead whisper scripts and voice, the ring delay, the retry and lead-retry schedules, whether calls are recorded, whether reschedule is offered, and the team's SMS settings.

List the agents assigned to one team, with each agent's calling priority and call cap. Returns an object whose `agents` array holds the assignments -- its own envelope, not the `data` one the other list operations use.

List the account's webhooks. Returns a bare JSON array (no `data` envelope), each webhook with its id, name, event, target URL and the filters that narrow when it fires.

Retrieve one webhook by id, with its event, target URL and filters.

Add a new agent (Callingly user) to the account, with the phone number Callingly will ring. Adding a user changes what the account is billed for.

PLACES A REAL PHONE CALL. Creates a lead in Callingly and immediately rings the team's agents to connect them to that person's phone number -- unless scheduled_at is set, which queues the call for later instead. This spends account call credits and dials a real number, so only invoke it when the user has asked for this specific person to be called.

Agency partners only: create a new client account under this agency, with its first user. Callingly bills the agency for the account, so this changes what the agency is charged.

Agency partners only: activate or deactivate a client account. A deactivated account stops placing and receiving calls and, on most plans, stops being billed; reactivating restores it.

SENDS A REAL TEXT MESSAGE to a real phone number, from one of the account's Callingly numbers. This costs money and reaches a person, so only invoke it when the user has asked for this specific message to be sent. The message body may use Callingly's Liquid personalization tags, and US/Canada traffic needs the STOP opt-out sentence to stay compliant.

Create a new calling team with its call mode, whisper script and retry schedules. The team can then be given agents with Set team agents and named as team_id when placing calls.

Create a webhook so Callingly POSTs to a URL you control when a call completes or a lead is created or updated. The optional fields narrow when it fires and only apply to the event named: call_direction, call_status, call_lead_status, team_id and number_id are call_completed only, while field and filter are lead_created / lead_updated only.

Update one agent's details, including the number Callingly rings and their do-not-disturb state. Setting donotdisturb stops this agent being rung until donotdisturb_until passes.

Replace one agent's whole weekly availability. The body is a JSON ARRAY of seven day objects, Sunday (day 0) through Saturday (day 6). This is a REPLACEMENT: a day left out of the array is not carried over, so send all seven.

Update one lead's details and call state. Setting is_stopped or is_blocked is what stops Callingly calling this person again, so this operation can end an in-progress call sequence.

Replace a team's agent roster with exactly the agents listed. This is a REPLACEMENT, not an addition: an agent currently on the team and absent from the list is removed from it.

Change one agent's calling priority and call cap within one team, without changing the rest of the roster.

Update one webhook. Partial updates are supported -- send only the fields to change, as Callingly's own sample body does.