Telefon
Numery firmowe, które dzwonią do Twojego zespołu, z przekazywaniem, kierowaniem i nagrywaniem.
Phone ma pięćdziesiąt publicznych metod, a strona Phone w panelu jest na nich zbudowana. Czterdzieści cztery działają w imieniu konta, którego klucza API używasz. Sześć jest dla operatorów Xuda i wymaga klucza administratora: przegląd dokumentów zgodności kraju oraz rozliczanie użycia i rejestracji, a także adopt_voice_number, które przypisuje do profilu numer będący już własnością Xuda, bez zakupu.
Wyślij żądanie do metody ze swoim kluczem:
Wynajmij numer
To robi Wynajmij numer, w tej samej kolejności.
Sprawdź, gdzie można wynająć numery
get_voice_country_catalog wymienia kraje i rodzaje numerów, które są otwarte. get_voice_compliance_status dla country mówi, czego ten kraj jeszcze od Ciebie wymaga, zanim numer będzie można wynająć: jego zasad, tożsamości stojącej za numerem i, w kraju regulowanym, rejestracji u dostawcy telefonii.
Spełnij wymogi kraju
accept_voice_terms zapisuje zasady, ze wszystkimi identyfikatorami, które kraj wymienia, i dokładną wartością policy_version. get_voice_identity_requirements zwraca pola, o które pyta kraj, update_profile_business_identity je zapisuje, a submit_voice_compliance wysyła je do przeglądu. Dla kraju regulowanego upload_voice_compliance_document wysyła każdy dokument, o który prosi dostawca, a submit_voice_bundle wysyła rejestrację.
Wyszukaj i wycen
search_voice_numbers wyszukuje wolne numery według country i type (local, mobile, tollFree lub national), zawężone przez area_code, wzorzec contains lub wymagane capabilities. get_voice_number_rates pokazuje, co numer potrafi i ile kosztuje użycie. quote_voice_number wycenia jednego kandydata i przez krótki czas trzyma tę cenę, aby nie mogła się zmienić w trakcie zakupu.
Kup
purchase_voice_number realizuje wycenę (quote_id i ten sam phone_number) i pobiera cykliczną opłatę za wynajem. Podaj payment_method_id, aby wybrać kartę, która płaci.
Zwolnij
release_voice_number oddaje numer. Przestaje dzwonić od razu, a jego miesięczne odnowienie jest anulowane.
SMS-y wybiera się w chwili wynajmu numeru: tylko numer, który może wysyłać SMS-y, może je wysyłać i odbierać, i nie można tego dodać później.
Ustal, jak linia odbiera
list_voice_numbers wymienia Twoje numery z profilem, do którego każdy jest podpięty. Z shared_only: true wymienia natomiast linie, które inni Ci udostępnili i które zaakceptowałeś lub zaakceptowałaś, każdą z shared_from; nigdy nie liczą się do Twojego planu. attach_voice_number przypisuje numer do profilu (jeden numer na profil, a profil główny nigdy nie może go mieć), a detach_voice_number zdejmuje go bez zwalniania.
get_voice_number_setup odczytuje jednym wywołaniem wszystko, co decyduje o tym, jak odbiera jeden numer: profil, co pozwala Twój plan, i reguły z listami opcji za nimi. update_voice_number_setup to zapisuje. Każda sekcja jest dotykana tylko wtedy, gdy ją wyślesz, więc zapis jednej nigdy nie resetuje innej. Konfiguracja zawiera też auto_answer, czyli Asystenta publicznego, który odbiera linię, i kiedy (always, when_no_answer, when_closed, schedule), zapisywane przez wysłanie tylko tego, co się zmienia; wybór, który nie jest jednym z Twoich aktywnych Asystentów publicznych, jest odrzucany z assistant_not_public. Pola ring.contacts i ring.groups w regułach to kontakty i grupy kontaktów z własnego obszaru roboczego linii, do których też dzwoni (taki, który zniknął, jest odrzucany z voice_answerer_not_found), a shared_with wymienia osoby, którym linia jest udostępniona, oczekujące lub zaakceptowane. get_profile_answering_rules i update_profile_answering_rules odczytują i zapisują same reguły: godziny pracy, limit czasu dzwonienia, do kogo się dzwoni, przekierowanie na komórkę, pocztę głosową i nagrywanie.
Ustawienie, którego Twój plan nie obejmuje, jest odrzucane z voice_plan_upgrade_required, nigdy po cichu pomijane. Obniżenie planu obowiązuje od następnego połączenia, a to, co zapisałeś lub zapisałaś, zostaje na miejscu, więc podwyższenie planu to przywraca.
list_voice_profile_members, share_voice_profile i revoke_voice_profile_member decydują, kto jest w profilu, a więc do kogo linia może dzwonić i komu można przekazać połączenie. Sama linia jest udostępniana przez udostępnienia zespołu (create_share z typem udostępnienia voice_number); zaakceptowane udostępnienie dzwoni także do tej osoby. get_voice_browser_token z answering: true daje przeglądarce po jednym tokenie dla każdej cudzej linii, która dzwoni do tego konta, więc dzwoni też tam; mogą tylko odbierać.
Połączenia
list_voice_callsodczytuje historię połączeń dla konta, profilu lub jednego numeru.get_voice_call_transcriptodczytuje tekst jednego połączenia, jeśli jest.get_voice_browser_tokenicreate_voice_call_intentpozwalają telefonowi w przeglądarce wykonać połączenie: intencja uprawnia do jednego połączenia wychodzącego z numeru, który posiadasz, na numerto. Aplikacja Xuda na iPhone'a prosi o swoje tokeny zpush_env(sandboxlubproduction): każdy token wskazuje wtedy dane push Twilio własnego konta Twilio, więc połączenie dzwoni na telefonie nawet przy zamkniętej aplikacji, a odpowiedź mówipush: true.list_voice_transfer_targetsitransfer_voice_callprzenoszą trwające połączenie do innej osoby z profilu, atakeover_voice_callzdejmuje połączenie z recepcjonisty AI do Twojej przeglądarki.send_voice_announcementwykonuje połączenie z jednego z Twoich numerów i wypowiada wpisaną wiadomość każdemu, kto odbierze.
SMS-y
list_voice_message_threads wymienia rozmowy z ostatnią wiadomością, liczbą nieprzeczytanych i informacją, czy kontakt zrezygnował. list_voice_messages odczytuje jedną rozmowę. send_voice_message wysyła jeden SMS z numeru, który może wysyłać SMS-y; podaj idempotency_key, a ponowienie zostanie rozliczone raz. Kontakt, który wysłał STOP, jest odrzucany, dopóki nie wyśle START. mark_voice_message_thread_read zeruje licznik nieprzeczytanych rozmowy.
Plan, użycie i usługa
get_voice_plans odczytuje drabinę planów i plan, na którym jesteś. set_voice_plan go aktywuje, podwyższa lub obniża, z tier albo identyfikatorem planu (profile_phone_phone); wymaga płatnego konta Xuda. get_voice_usage odczytuje połączenia i SMS-y miesiąca wraz z pozostałym limitem wydatków. get_voice_service_status i activate_voice_service odczytują i przygotowują usługę telefoniczną konta.