Skip to content

Phone

Business numbers that ring your team, with transfer, routing and recording.

Open Phone
Checked against the dashboard on November 19, 2026

Phone has fifty public methods, and the dashboard's Phone page is built on them. Forty-four act for the account whose API key you use. Six are for Xuda's own operators and need an admin key: the review of a country's compliance records and the settling of usage and registrations, plus adopt_voice_number, which assigns a number Xuda already owns to a profile with no purchase.

Send a request to a method with your key:

curl -s https://xuda.ai/cpi/search_voice_numbers \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","country":"US","type":"local","area_code":"415"}'
const res = await fetch('https://xuda.ai/cpi/search_voice_numbers', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY', country: 'US', type: 'local', area_code: '415' }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/search_voice_numbers',
    json={'api_key': 'YOUR_API_KEY', 'country': 'US', 'type': 'local', 'area_code': '415'},
)

Rent a number

This is what Rent a number does, in the same order.

See where numbers can be rented

get_voice_country_catalog lists the countries and number types that are open. get_voice_compliance_status for a country says what that country still needs from you before a number can be rented: its policies, the identity behind the number and, in a regulated country, the phone provider's registration.

Clear the country's checks

accept_voice_terms records the policies, with every id the country lists and the exact policy_version. get_voice_identity_requirements returns the fields the country asks for, update_profile_business_identity stores them and submit_voice_compliance sends them for review. For a regulated country, upload_voice_compliance_document sends each document the provider asks for and submit_voice_bundle sends the registration.

Search and quote

search_voice_numbers searches the free numbers by country and type (local, mobile, tollFree or national), narrowed by area_code, a contains pattern or required capabilities. get_voice_number_rates shows what the number can do and what use costs. quote_voice_number prices one candidate and holds that price for a short time, so it cannot move under an in-flight purchase.

Purchase

purchase_voice_number redeems the quote (quote_id and the same phone_number) and charges the recurring rental. Pass payment_method_id to choose the card that pays.

Release

release_voice_number gives a number back. It stops ringing at once and its monthly renewal is cancelled.

Texting is chosen when a number is rented: only a number that can text can send or receive texts, and it cannot be added later.

Say how a line answers

list_voice_numbers lists your numbers with the profile each is attached to. With shared_only: true it lists instead the lines other people shared with you and you accepted, each with shared_from; they never count toward your plan. attach_voice_number gives a number to a profile (one number per profile, and the main profile can never hold one) and detach_voice_number takes it off without releasing it.

get_voice_number_setup reads everything that decides how one number answers in a single call: the profile, what your plan allows, and the rules with the option lists behind them. update_voice_number_setup saves it. Each section is touched only when you send it, so saving one never resets another. The setup also carries auto_answer, the Public Assistant who answers the line and when (always, when_no_answer, when_closed, schedule), saved by sending only what changes; a pick that is not one of your live Public Assistants is refused with assistant_not_public. The rules' ring.contacts and ring.groups are contacts and contact groups of the line's own workspace that it also rings (one that is gone is refused with voice_answerer_not_found), and shared_with lists the people the line is shared with, waiting or accepted. get_profile_answering_rules and update_profile_answering_rules read and save the rules alone: business hours, the ring timeout, who is rung, forwarding to a mobile, voicemail and recording.

A setting your plan does not include is refused with voice_plan_upgrade_required, never silently dropped. A downgrade takes effect on the very next call, and what you saved stays in place so an upgrade brings it back.

list_voice_profile_members, share_voice_profile and revoke_voice_profile_member decide who is on a profile, and so who a line can ring and who a call can be transferred to. A line itself is shared through the team shares (create_share with the share type voice_number); an accepted share rings that person too. get_voice_browser_token with answering: true gives a browser one token for each line of somebody else's that rings this account, so it rings there too; they answer only.

Calls

  • list_voice_calls reads call history, for the account, a profile or one number.
  • get_voice_call_transcript reads the text of one call, when there is one.
  • get_voice_browser_token and create_voice_call_intent let a browser softphone place a call: the intent authorises one outbound call from a number you own to a to number. The Xuda iPhone app asks for its tokens with push_env (sandbox or production): each token then names the Twilio push credential of its own Twilio account, so a call rings the phone even with the app closed, and the answer says push: true.
  • list_voice_transfer_targets and transfer_voice_call move a live call to another person on the profile, and takeover_voice_call moves a call off the AI receptionist to your browser.
  • send_voice_announcement places a call from one of your numbers and speaks a typed message to whoever answers.

Texts

list_voice_message_threads lists conversations with the last message, the unread count and whether the contact opted out. list_voice_messages reads one conversation. send_voice_message sends one text from a number that can text; give it an idempotency_key and a retry is billed once. A contact who has sent STOP is refused until they send START. mark_voice_message_thread_read clears a conversation's unread count.

Plan, usage and the service

get_voice_plans reads the plan ladder and the plan you are on. set_voice_plan activates, upgrades or downgrades it, with either tier or the plan id (profile_phone_phone); it needs a paid Xuda account. get_voice_usage reads the month's calls and texts, with the spend cap that is left. get_voice_service_status and activate_voice_service read and prepare the account's phone service.

Methods

How is this guide?

Last updated on November 17, 2026