Telefoon
Zakelijke nummers die je team laten bellen, met doorverbinden, routering en opnemen.
Phone heeft vijftig openbare methoden, en de Phone-pagina van het dashboard is erop gebouwd. Vierenveertig werken voor het account waarvan je de API-sleutel gebruikt. Zes zijn voor de eigen operators van Xuda en vragen een beheerderssleutel: de beoordeling van de nalevingsgegevens van een land en het afhandelen van gebruik en registraties, plus adopt_voice_number, dat een nummer dat Xuda al bezit zonder aankoop aan een profiel toewijst.
Stuur een verzoek naar een methode met je sleutel:
Huur een nummer
Dit is wat Huur een nummer doet, in dezelfde volgorde.
Kijk waar nummers te huur zijn
get_voice_country_catalog toont de landen en nummertypen die open zijn. get_voice_compliance_status voor een country zegt wat dat land nog van je nodig heeft voordat een nummer kan worden gehuurd: de regels, de identiteit achter het nummer en, in een gereguleerd land, de registratie bij de telefoonaanbieder.
Doorloop de controles van het land
accept_voice_terms legt de regels vast, met elke id die het land noemt en de exacte policy_version. get_voice_identity_requirements geeft de velden die het land vraagt, update_profile_business_identity slaat ze op en submit_voice_compliance stuurt ze ter beoordeling. Voor een gereguleerd land stuurt upload_voice_compliance_document elk document dat de aanbieder vraagt en submit_voice_bundle de registratie.
Zoek en offerte
search_voice_numbers zoekt de vrije nummers op country en type (local, mobile, tollFree of national), beperkt met area_code, een contains-patroon of vereiste capabilities. get_voice_number_rates toont wat het nummer kan en wat gebruik kost. quote_voice_number prijst één kandidaat en houdt die prijs even vast, zodat hij niet kan bewegen onder een lopende aankoop.
Aankoop
purchase_voice_number verzilvert de offerte (quote_id en hetzelfde phone_number) en brengt de terugkerende huur in rekening. Geef payment_method_id mee om de kaart te kiezen waarmee wordt betaald.
Vrijgeven
release_voice_number geeft een nummer terug. Het gaat meteen niet meer over en de maandelijkse verlenging wordt geannuleerd.
Sms wordt gekozen bij het huren van een nummer: alleen een nummer dat kan sms'en, kan sms'jes verzenden of ontvangen, en het kan later niet worden toegevoegd.
Bepaal hoe een lijn opneemt
list_voice_numbers toont je nummers met het profiel waaraan elk is gekoppeld. Met shared_only: true toont het in plaats daarvan de lijnen die anderen met je hebben gedeeld en die je hebt geaccepteerd, elk met shared_from; die tellen nooit mee voor je abonnement. attach_voice_number geeft een nummer aan een profiel (één nummer per profiel, en het hoofdprofiel kan er nooit een hebben) en detach_voice_number haalt het eraf zonder het vrij te geven.
get_voice_number_setup leest alles wat bepaalt hoe één nummer opneemt in één aanroep: het profiel, wat je abonnement toestaat, en de regels met de optielijsten erachter. update_voice_number_setup slaat het op. Elk onderdeel wordt alleen aangeraakt als je het meestuurt, dus het opslaan van het ene zet een ander nooit terug. De instelling bevat ook auto_answer, de Openbare assistent die de lijn beantwoordt en wanneer (always, when_no_answer, when_closed, schedule), opgeslagen door alleen te sturen wat verandert; een keuze die niet een van je live Openbare assistenten is, wordt geweigerd met assistant_not_public. De ring.contacts en ring.groups van de regels zijn contacten en contactgroepen van de eigen werkruimte van de lijn die hij ook laat overgaan (een die er niet meer is, wordt geweigerd met voice_answerer_not_found), en shared_with toont de mensen met wie de lijn wordt gedeeld, wachtend of geaccepteerd. get_profile_answering_rules en update_profile_answering_rules lezen en bewaren alleen de regels: openingstijden, de beltime-out, wie er overgaat, doorsturen naar een mobiel, voicemail en opnemen.
Een instelling die je abonnement niet bevat, wordt geweigerd met voice_plan_upgrade_required, nooit stilzwijgend weggelaten. Een downgrade geldt vanaf het eerstvolgende gesprek, en wat je hebt opgeslagen blijft staan, zodat een upgrade het terugbrengt.
list_voice_profile_members, share_voice_profile en revoke_voice_profile_member bepalen wie er op een profiel zit, en dus wie een lijn kan laten overgaan en naar wie een gesprek kan worden doorverbonden. Een lijn zelf wordt gedeeld via de teamdelingen (create_share met het deeltype voice_number); een geaccepteerde deling laat ook die persoon overgaan. get_voice_browser_token met answering: true geeft een browser één token voor elke lijn van iemand anders die dit account laat overgaan, zodat het daar ook overgaat; ze kunnen alleen opnemen.
Gesprekken
list_voice_callsleest de gespreksgeschiedenis, voor het account, een profiel of één nummer.get_voice_call_transcriptleest de tekst van één gesprek, als die er is.get_voice_browser_tokenencreate_voice_call_intentlaten een softphone in de browser een gesprek plaatsen: de intent machtigt één uitgaand gesprek vanaf een nummer dat je bezit naar eento-nummer. De Xuda iPhone-app vraagt haar tokens aan metpush_env(sandboxofproduction): elk token noemt dan de Twilio-pushgegevens van het eigen Twilio-account, zodat een gesprek de telefoon laat overgaan, ook als de app gesloten is, en het antwoordpush: truezegt.list_voice_transfer_targetsentransfer_voice_callverplaatsen een live gesprek naar een andere persoon op het profiel, entakeover_voice_callhaalt een gesprek van de AI-receptioniste naar je browser.send_voice_announcementplaatst een gesprek vanaf een van je nummers en spreekt een getypt bericht uit tegen wie opneemt.
Sms
list_voice_message_threads toont gesprekken met het laatste bericht, het aantal ongelezen en of het contact zich heeft afgemeld. list_voice_messages leest één gesprek. send_voice_message verstuurt één sms vanaf een nummer dat kan sms'en; geef het een idempotency_key en een nieuwe poging wordt één keer gefactureerd. Een contact dat STOP heeft gestuurd, wordt geweigerd tot die START stuurt. mark_voice_message_thread_read wist het aantal ongelezen van een gesprek.
Abonnement, gebruik en de dienst
get_voice_plans leest de abonnementenladder en het abonnement waarop je zit. set_voice_plan activeert, upgradet of downgradet het, met tier of de abonnements-id (profile_phone_phone); het vraagt een betaald Xuda-account. get_voice_usage leest de gesprekken en sms'jes van de maand, met de bestedingslimiet die overblijft. get_voice_service_status en activate_voice_service lezen en bereiden de telefoondienst van het account voor.