Take a number offline without unlinking it
disconnect_numberTake a number offline deliberately, keeping its link to the phone.
The stored credentials survive, so connect_number brings it straight
back with no pairing. Nothing is deleted. Disconnecting does not stop billing:
an extra number is billed every cycle until it is removed.
Returns immediately, before the number is offline. The answer has the
number's alias, status set to disconnecting and at, the moment the
request was accepted. disconnecting is not a status that get_number
reports: it keeps showing the previous status and its own at until the
number is offline.
While disconnected the number cannot send or receive, and messages addressed to it are refused rather than queued. Deliberate: a message held for an unknown period and delivered later is worse than one that failed clearly.
Calling it again changes nothing further. A number that is already
offline answers with an already_disconnected error, which means the
goal is met, not that the call failed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| number_alias | No | Which of the organization's WhatsApp numbers this acts on: `main`, the alias of an extra number, or the number's `id` (`num_…`), which stays the same when the alias is renamed. Call `list_numbers` to see them. Defaults to the main number. | main |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||