Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Concept

With Z-API, you can now make calls to any number, including sending audio during the call. For more details on how to use this feature, check the next pages in the documentation. Additionally, you can use the feature known as “call attention” — similar to the old Facebook “poke”. With it, you can start a call, wait up to 15 seconds, and automatically hang up. Through message webhooks, you can track call events and identify whether the recipient answered or rejected the call.

​
Important for Partners

If you are already a partner and want to enable the calling feature on an instance, check the options below:
  • Update an existing instance (already created and subscribed):
    Use the instance update endpoint:
    Updating the subscription
  • Create a new instance with calls enabled:
    When creating and subscribing the instance, use the withCalls=true parameter as described in the documentation:
    Subscribing an instance
Check the next pages to understand in detail how to use the calling endpoints.

​
About calls

Calls use the same communication channel as messages, so the queue is paused so that no other message is sent at the same time you’re calling someone.