Get one number and its connection status
get_numberCheck one WhatsApp number: its phone number, status, and when that status began.
id (num_…) is the number's permanent identifier. The alias can be
renamed, the id cannot. Either one works as number_alias.
connected means it can send right now. connecting means a connection
was just requested and is being set up; check again in a few seconds.
reconnecting means the number lost its connection and Turbo Notify is
bringing it back by itself: there is nothing to do but wait and check
again. Until it is connected again, sends are refused with
number_not_connected. disconnected means the link to the phone still
exists but the number is offline, so connect_number brings it back.
inactive is the same for a number that was linked and has not been
brought online yet: connect_number brings it online too.
pending means the number was never linked to a phone, and no_main_number
(what a brand-new account gets for main, and list_numbers is empty)
means there is no number at all yet: either way a person has to link it
from the Numbers page of the dashboard, so tell them and do not retry the
send meanwhile.
revoked means WhatsApp ended the link (the device was removed under
Linked devices on the phone, or the phone went more than 14 days
without being used) or another connection took it over. failed means a pairing did not complete; on an extra
number reason says why (for example pairing_timeout when the code
or QR code was not used in time, paired_phone_mismatch when another
WhatsApp used it). Either one has to be paired again by a person holding that phone:
from the dashboard (main or extra number) or, for an extra number,
through the API's pairing endpoint, by code or by QR code. No tool here
pairs a number: it needs a person with the phone.
pairing means a person is pairing the number right now. The code or
QR code they use is not part of this answer: it belongs to that person.
Check again later; the status moves to connected, or to failed
(with a reason on an extra number).
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_number"
}
}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 | |||