Skip to content

FAQ

Quick answers to the questions developers ask most. Each one links to the full guide.

Calls

I created a lead. Why hasn't it been called?

Creating a lead through the API doesn't start a call. Ask for it with POST /leads/{id}/request-qualification (or /candidates/{id}/request-screening). If that answered 409, the code says why: call_waiting (kept, and starts by itself once the employee is working and the wallet has credits), offering_not_active, do_not_contact, already_in_progress or lead_closed.

Asked for, but still not ringing? Outside your calling hours the call waits for them, and call_timing on the lead shows held_for_hours: true. A person is also never called by two AI employees at once: the second call waits a few minutes. See Ask for the call.

How fast does the call go out?

During calling hours, usually within a minute of asking. Outside them, at the start of the next calling window.

call_timing.seconds_to_call on the lead shows exactly how long it took.

When are calls made?

Within the calling hours set on each AI employee's phone line in the app (9 am to 8 pm unless you change them), in your business's time zone. Whatever you set, commercial calls only go out between 9 am and 9 pm, as the TRAI rules require.

Which language does the AI employee speak?

The person's preferred_language if you sent one (te-IN, hi-IN or en-IN), else the AI employee's main language. On the call it follows the person if they switch.

Someone asked us to stop calling them. How do I make sure they aren't called?

If they say so on a call with your AI employee, Progz marks them do_not_contact by itself. If they asked anywhere else (your website, email, a store visit), set do_not_contact to true on their contact with PATCH /contacts/{id}, or switch on Do not contact on their page in the app. From then on no call or message goes to them, and asking for a call answers 409 do_not_contact.

Building your integration

Is there a sandbox or test mode?

No. Keys work on real data and real calls. Create a separate business for testing, with its own API key, and put your own phone number on the test leads. The AI employee's setup in the app also lets you try test calls to your own phone, charged from your credits (new businesses start with welcome credits).

Do you send webhooks when something changes?

Not yet. Check for changes on a schedule instead: every 5 to 15 minutes is plenty.

Keeping your system up to date has a complete example.

Can I call the API from my website's JavaScript?

No. The browser would expose your API key to every visitor, and the API doesn't accept requests from other websites' pages. Send the form to your own server and call the API from there.

If you have no server, use the AI employee's public form link instead. See the website example.

Is there an SDK or an OpenAPI file?

Not yet. The API is plain JSON over HTTPS, so any HTTP client works; these docs give curl, Python and Node.js examples.

Why was my request rejected with 422?

A field is missing, has the wrong type, or isn't one the endpoint knows. The details list names each field and what is wrong. Unknown fields, such as a fact name that isn't on the list, are rejected rather than ignored.

See Validation errors and the list of facts.

I sent the same person twice. What happens?

People are matched by phone number, so there is never a second contact. The second lead for the same offering (or candidate for the same job) answers 409 already_lead or already_candidate; treat that as success.

We run several businesses. Can one key cover them all?

No. A key belongs to one business. Create a key in each business and use the right one per request.

How many requests can I make?

300 a minute per API key. Every response carries X-RateLimit-Remaining; on 429, wait the Retry-After seconds and try again.

Costs and data

What does a call cost?

Calls are paid from your prepaid credits by talk time, at the same price as calls started in the app. The first 4 test calls from the AI employee's setup are free, and so is the API itself.

Current prices are on the pricing page.

What happens when our credits run out?

New calls wait instead of failing: asking for one answers 409 call_waiting, and the call starts by itself after you recharge.

Can I delete a person?

DELETE /contacts/{id} archives them, so they leave your lists. Archiving doesn't stop calls by itself: if they asked not to be contacted, also set do_not_contact. For a person's request to erase their data, write to us and we will help you respond.

Are times in UTC?

Yes. Every time we send back is UTC (ending in Z). Send times with any offset, such as +05:30. Bookings also carry the business's timezone for showing them in local time.