Telefon
Firemní čísla, která zvoní vašemu týmu, s přepojením, směrováním a nahráváním.
Telefon má padesát veřejných metod a stránka Telefon v přehledu je na nich postavená. Čtyřicet čtyři jedná za účet, jehož klíč API používáte. Šest je pro vlastní operátory Xuda a vyžaduje klíč správce: posouzení záznamů o shodě s předpisy dané země a vypořádání využití a registrací, plus adopt_voice_number, které přiřadí profilu číslo, které Xuda už vlastní, bez nákupu.
Požadavek na metodu pošlete se svým klíčem:
Pronajmout číslo
Toto dělá Pronajmout číslo, ve stejném pořadí.
Zjistěte, kde lze čísla pronajmout
get_voice_country_catalog uvádí země a typy čísel, které jsou otevřené. get_voice_compliance_status pro country říká, co ještě daná země od vás potřebuje, než lze číslo pronajmout: své zásady, identitu za číslem a v regulované zemi registraci u poskytovatele telefonních služeb.
Splňte kontroly dané země
accept_voice_terms zaznamená zásady se všemi id, které země uvádí, a přesným policy_version. get_voice_identity_requirements vrací pole, která země žádá, update_profile_business_identity je uloží a submit_voice_compliance je odešle k posouzení. Pro regulovanou zemi upload_voice_compliance_document odešle každý dokument, který poskytovatel žádá, a submit_voice_bundle odešle registraci.
Hledejte a oceňte
search_voice_numbers hledá volná čísla podle country a type (local, mobile, tollFree nebo national), zúžené pomocí area_code, vzoru contains nebo požadovaných capabilities. get_voice_number_rates ukazuje, co číslo umí a kolik stojí používání. quote_voice_number ocení jednoho kandidáta a drží tuto cenu krátkou dobu, takže se nemůže pohnout pod probíhajícím nákupem.
Nákup
purchase_voice_number uplatní nabídku (quote_id a stejné phone_number) a naúčtuje opakovaný pronájem. Předejte payment_method_id, abyste vybrali kartu, která platí.
Uvolnění
release_voice_number číslo vrátí. Přestane zvonit hned a jeho měsíční obnovení se zruší.
SMS se volí při pronájmu čísla: jen číslo, které umí SMS, je může posílat a přijímat, a nelze je přidat později.
Určete, jak linka odpovídá
list_voice_numbers uvádí vaše čísla s profilem, ke kterému je každé připojeno. S shared_only: true místo toho uvádí linky, které s vámi jiní sdíleli a vy jste přijali, každou s shared_from; do vašeho tarifu se nikdy nezapočítávají. attach_voice_number dá číslo profilu (jedno číslo na profil a hlavní profil nikdy žádné mít nemůže) a detach_voice_number ho odebere bez uvolnění.
get_voice_number_setup čte jedním voláním vše, co rozhoduje o tom, jak jedno číslo odpovídá: profil, co váš tarif dovoluje, a pravidla se seznamy voleb za nimi. update_voice_number_setup ho ukládá. Každá sekce se dotkne jen tehdy, když ji pošlete, takže uložení jedné nikdy neresetuje jinou. Nastavení také nese auto_answer, veřejného asistenta, který linku přijímá, a kdy (always, when_no_answer, when_closed, schedule), uložené odesláním jen toho, co se mění; volba, která není jedním z vašich živých veřejných asistentů, se odmítne s assistant_not_public. ring.contacts a ring.groups v pravidlech jsou kontakty a skupiny kontaktů pracovního prostoru samotné linky, kterým také zvoní (ten, který zmizel, se odmítne s voice_answerer_not_found), a shared_with uvádí lidi, se kterými je linka sdílena, čekající nebo přijaté. get_profile_answering_rules a update_profile_answering_rules čtou a ukládají samotná pravidla: pracovní dobu, časový limit zvonění, komu se zvoní, přesměrování na mobil, hlasovou schránku a nahrávání.
Nastavení, které váš tarif neobsahuje, se odmítne s voice_plan_upgrade_required, nikdy se potichu nezahodí. Přechod na nižší tarif se projeví při dalším hovoru a to, co jste uložili, zůstane na místě, takže přechod na vyšší ho vrátí.
list_voice_profile_members, share_voice_profile a revoke_voice_profile_member rozhodují, kdo je na profilu, a tedy komu linka může zvonit a komu lze hovor přepojit. Samotná linka se sdílí přes týmová sdílení (create_share s typem sdílení voice_number); přijaté sdílení zvoní i tomuto člověku. get_voice_browser_token s answering: true dá prohlížeči jeden token pro každou cizí linku, která tomuto účtu zvoní, takže zvoní i tam; ti jen přijímají.
Hovory
list_voice_callsčte historii hovorů, pro účet, profil nebo jedno číslo.get_voice_call_transcriptčte text jednoho hovoru, pokud nějaký je.get_voice_browser_tokenacreate_voice_call_intentnechávají softwarový telefon v prohlížeči uskutečnit hovor: záměr opravňuje jeden odchozí hovor z čísla, které vlastníte, na čísloto. Aplikace Xuda pro iPhone si žádá tokeny spush_env(sandboxneboproduction): každý token pak pojmenovává push přihlašovací údaje Twilio vlastního účtu Twilio, takže hovor zazvoní na telefonu i se zavřenou aplikací a odpověď říkápush: true.list_voice_transfer_targetsatransfer_voice_callpřesunou živý hovor na jinou osobu na profilu atakeover_voice_callpřesune hovor od recepčního AI do vašeho prohlížeče.send_voice_announcementuskuteční hovor z jednoho z vašich čísel a vyřkne zadanou zprávu tomu, kdo přijme.
SMS
list_voice_message_threads uvádí konverzace s poslední zprávou, počtem nepřečtených a zda se kontakt odhlásil. list_voice_messages čte jednu konverzaci. send_voice_message pošle jednu SMS z čísla, které umí SMS; dejte jí idempotency_key a opakování se účtuje jednou. Kontaktu, který poslal STOP, se odmítá, dokud neposlal START. mark_voice_message_thread_read vymaže počet nepřečtených konverzace.
Tarif, využití a služba
get_voice_plans čte žebříček tarifů a tarif, na kterém jste. set_voice_plan ho aktivuje, zvýší nebo sníží, buď pomocí tier, nebo id tarifu (profile_phone_phone); vyžaduje placený účet Xuda. get_voice_usage čte hovory a SMS za měsíc se zbývajícím limitem výdajů. get_voice_service_status a activate_voice_service čtou a připravují telefonní službu účtu.