Telefón
Firemné čísla, ktoré zvonia vášmu tímu, s prepájaním, smerovaním a nahrávaním.
Telefón má päťdesiat verejných metód a stránka Telefón v dashboarde je na nich postavená. Štyridsaťštyri koná pre účet, ktorého API kľúč použijete. Šesť je pre vlastných operátorov Xuda a vyžaduje kľúč správcu: preskúmanie záznamov o súlade krajiny a vyrovnanie využitia a registrácií, plus adopt_voice_number, ktorá priradí profilu číslo, ktoré Xuda už vlastní, bez nákupu.
Pošlite požiadavku metóde so svojím kľúčom:
Prenajatie čísla
Toto robí Prenajať si číslo v rovnakom poradí.
Zistite, kde sa čísla dajú prenajať
get_voice_country_catalog uvádza krajiny a typy čísel, ktoré sú otvorené. get_voice_compliance_status pre country hovorí, čo ešte krajina od vás potrebuje, kým sa číslo dá prenajať: svoje zásady, totožnosť za číslom a v regulovanej krajine registráciu u poskytovateľa telefónnych služieb.
Splňte kontroly krajiny
accept_voice_terms zaznamená zásady so všetkými id, ktoré krajina uvádza, a presnou policy_version. get_voice_identity_requirements vráti polia, ktoré krajina pýta, update_profile_business_identity ich uloží a submit_voice_compliance ich pošle na posúdenie. Pre regulovanú krajinu upload_voice_compliance_document pošle každý dokument, ktorý poskytovateľ pýta, a submit_voice_bundle pošle registráciu.
Vyhľadajte a ocenite
search_voice_numbers vyhľadá voľné čísla podľa country a type (local, mobile, tollFree alebo national), zúžené pomocou area_code, vzoru contains alebo požadovaných capabilities. get_voice_number_rates ukazuje, čo číslo dokáže a koľko stojí používanie. quote_voice_number ocení jedného kandidáta a drží túto cenu krátky čas, aby sa nemohla pohnúť pod prebiehajúcim nákupom.
Nákup
purchase_voice_number uplatní ponuku (quote_id a rovnaké phone_number) a účtuje opakovaný prenájom. Zadajte payment_method_id, aby ste vybrali kartu, ktorá platí.
Uvoľnenie
release_voice_number vráti číslo. Okamžite prestane zvoniť a jeho mesačné obnovenie sa zruší.
SMS sa vyberá pri prenájme čísla: SMS môže posielať alebo prijímať iba číslo, ktoré to dokáže, a nedá sa pridať neskôr.
Povedzte, ako linka odpovedá
list_voice_numbers uvádza vaše čísla s profilom, ku ktorému je každé pripojené. S shared_only: true namiesto toho uvádza linky, ktoré s vami zdieľali iní ľudia a vy ste ich prijali, každú so shared_from; nikdy sa nepočítajú do vášho plánu. attach_voice_number dá číslo profilu (jedno číslo na profil a hlavný profil nikdy nemôže žiadne mať) a detach_voice_number ho odoberie bez uvoľnenia.
get_voice_number_setup číta všetko, čo rozhoduje o tom, ako jedno číslo odpovedá, jedným volaním: profil, čo váš plán dovoľuje, a pravidlá so zoznamami možností za nimi. update_voice_number_setup ho uloží. Každá sekcia sa dotkne iba vtedy, keď ju pošlete, takže uloženie jednej nikdy neresetuje inú. Nastavenie nesie aj auto_answer, Verejného asistenta, ktorý odpovedá na linku, a kedy (always, when_no_answer, when_closed, schedule), uložené odoslaním iba toho, čo sa mení; výber, ktorý nie je jedným z vašich živých Verejných asistentov, sa odmietne s assistant_not_public. Pravidlá ring.contacts a ring.groups sú kontakty a skupiny kontaktov pracovného priestoru samotnej linky, ktorým tiež zvoní (ten, ktorý zanikol, sa odmietne s voice_answerer_not_found), a shared_with uvádza ľudí, s ktorými je linka zdieľaná, čakajúcich alebo prijatých. get_profile_answering_rules a update_profile_answering_rules čítajú a ukladajú samotné pravidlá: pracovné hodiny, časový limit zvonenia, komu sa zvoní, presmerovanie na mobil, hlasovú schránku a nahrávanie.
Nastavenie, ktoré váš plán nezahŕňa, sa odmietne s voice_plan_upgrade_required, nikdy sa potichu nezahodí. Zníženie plánu nadobudne účinnosť pri úplne ďalšom hovore a to, čo ste uložili, zostáva na mieste, takže zvýšenie plánu to vráti.
list_voice_profile_members, share_voice_profile a revoke_voice_profile_member rozhodujú, kto je na profile, a teda komu môže linka zvoniť a komu sa dá hovor prepojiť. Samotná linka sa zdieľa cez zdieľania tímu (create_share s typom zdieľania voice_number); prijaté zdieľanie zvoní aj tejto osobe. get_voice_browser_token s answering: true dá prehliadaču jeden token pre každú linku niekoho iného, ktorá zvoní tomuto účtu, takže zvoní aj tam; iba odpovedajú.
Hovory
list_voice_callsčíta históriu hovorov pre účet, profil alebo jedno číslo.get_voice_call_transcriptčíta text jedného hovoru, ak existuje.get_voice_browser_tokenacreate_voice_call_intentumožňujú softvérovému telefónu v prehliadači uskutočniť hovor: zámer oprávňuje jeden odchádzajúci hovor z čísla, ktoré vlastníte, na čísloto. Aplikácia Xuda pre iPhone žiada o svoje tokeny spush_env(sandboxaleboproduction): každý token potom pomenúva push poverenie Twilio vlastného účtu Twilio, takže hovor zvoní na telefóne aj so zatvorenou aplikáciou a odpoveď hovorípush: true.list_voice_transfer_targetsatransfer_voice_callpresúvajú živý hovor na inú osobu na profile atakeover_voice_callpresúva hovor od AI recepčnej do vášho prehliadača.send_voice_announcementuskutoční hovor z jedného z vašich čísel a prehovorí napísanú správu tomu, kto odpovie.
SMS
list_voice_message_threads uvádza konverzácie s poslednou správou, počtom neprečítaných a tým, či sa kontakt odhlásil. list_voice_messages číta jednu konverzáciu. send_voice_message pošle jednu SMS z čísla, ktoré môže posielať SMS; dajte mu idempotency_key a opakovanie sa účtuje raz. Kontakt, ktorý poslal STOP, sa odmietne, kým neposlal START. mark_voice_message_thread_read vymaže počet neprečítaných v konverzácii.
Plán, využitie a služba
get_voice_plans číta rebríček plánov a plán, na ktorom ste. set_voice_plan ho aktivuje, zvýši alebo zníži, buď pomocou tier, alebo id plánu (profile_phone_phone); vyžaduje platený účet Xuda. get_voice_usage číta hovory a SMS mesiaca so zostávajúcim limitom výdavkov. get_voice_service_status a activate_voice_service čítajú a pripravujú telefónnu službu účtu.