Phone
Geschäftsnummern, die bei Ihrem Team klingeln, mit Weiterleitung, Routing und Aufzeichnung.
Phone hat fünfzig öffentliche Methoden, und die Phone-Seite des Dashboards ist darauf aufgebaut. Vierundvierzig handeln für das Konto, dessen API-Schlüssel du verwendest. Sechs sind für die eigenen Operatoren von Xuda und brauchen einen Admin-Schlüssel: die Prüfung der Compliance-Unterlagen eines Landes und das Abrechnen von Nutzung und Registrierungen, dazu adopt_voice_number, das einem Profil eine Nummer zuweist, die Xuda schon gehört, ohne Kauf.
Sende mit deinem Schlüssel eine Anfrage an eine Methode:
Eine Nummer mieten
Das tut Eine Nummer mieten, in derselben Reihenfolge.
Sehen, wo Nummern gemietet werden können
get_voice_country_catalog listet die Länder und Nummernarten auf, die offen sind. get_voice_compliance_status für ein country sagt, was dieses Land noch von dir braucht, bevor eine Nummer gemietet werden kann: seine Richtlinien, die Identität hinter der Nummer und in einem regulierten Land die Registrierung beim Telefonanbieter.
Die Prüfungen des Landes erledigen
accept_voice_terms hält die Richtlinien fest, mit jeder ID, die das Land auflistet, und der genauen policy_version. get_voice_identity_requirements gibt die Felder zurück, die das Land verlangt, update_profile_business_identity speichert sie und submit_voice_compliance sendet sie zur Prüfung. Für ein reguliertes Land sendet upload_voice_compliance_document jedes Dokument, das der Anbieter verlangt, und submit_voice_bundle sendet die Registrierung.
Suchen und Preis abfragen
search_voice_numbers durchsucht die freien Nummern nach country und type (local, mobile, tollFree oder national), eingegrenzt durch area_code, ein contains-Muster oder verlangte capabilities. get_voice_number_rates zeigt, was die Nummer kann und was die Nutzung kostet. quote_voice_number nennt den Preis eines Kandidaten und hält diesen Preis für kurze Zeit, sodass er sich während eines laufenden Kaufs nicht bewegen kann.
Kaufen
purchase_voice_number löst das Angebot ein (quote_id und dieselbe phone_number) und belastet die wiederkehrende Miete. Übergib payment_method_id, um die Karte zu wählen, die bezahlt.
Freigeben
release_voice_number gibt eine Nummer zurück. Sie hört sofort auf zu klingeln, und ihre monatliche Verlängerung wird gekündigt.
Textnachrichten werden beim Mieten einer Nummer gewählt: Nur eine Nummer, die Textnachrichten kann, kann sie senden oder empfangen, und das lässt sich später nicht hinzufügen.
Festlegen, wie eine Leitung antwortet
list_voice_numbers listet deine Nummern mit dem Profil auf, dem jede zugeordnet ist. Mit shared_only: true listet es stattdessen die Leitungen auf, die andere mit dir geteilt haben und die du angenommen hast, jede mit shared_from; sie zählen nie auf deinen Tarif. attach_voice_number gibt einem Profil eine Nummer (eine Nummer pro Profil, und das Hauptprofil kann nie eine haben) und detach_voice_number nimmt sie davon ab, ohne sie freizugeben.
get_voice_number_setup liest alles, was entscheidet, wie eine Nummer antwortet, in einem einzigen Aufruf: das Profil, was dein Tarif erlaubt, und die Regeln mit den Optionslisten dahinter. update_voice_number_setup speichert es. Jeder Abschnitt wird nur angefasst, wenn du ihn sendest, das Speichern eines Abschnitts setzt also nie einen anderen zurück. Das Setup trägt auch auto_answer, den Öffentlichen Assistant, der die Leitung annimmt, und wann (always, when_no_answer, when_closed, schedule), gespeichert, indem nur gesendet wird, was sich ändert; eine Auswahl, die keiner deiner aktiven Öffentlichen Assistants ist, wird mit assistant_not_public abgelehnt. ring.contacts und ring.groups der Regeln sind Kontakte und Kontaktgruppen des eigenen Workspace der Leitung, bei denen sie auch klingelt (eine, die nicht mehr existiert, wird mit voice_answerer_not_found abgelehnt), und shared_with listet die Personen auf, mit denen die Leitung geteilt ist, wartend oder angenommen. get_profile_answering_rules und update_profile_answering_rules lesen und speichern nur die Regeln: Geschäftszeiten, das Klingel-Timeout, wer klingelt, Weiterleitung an ein Handy, Mailbox und Aufzeichnung.
Eine Einstellung, die dein Tarif nicht enthält, wird mit voice_plan_upgrade_required abgelehnt, nie stillschweigend verworfen. Ein Downgrade wirkt ab dem nächsten Anruf, und was du gespeichert hast, bleibt erhalten, sodass ein Upgrade es zurückbringt.
list_voice_profile_members, share_voice_profile und revoke_voice_profile_member bestimmen, wer in einem Profil ist und damit, bei wem eine Leitung klingeln kann und an wen ein Anruf weitergeleitet werden kann. Eine Leitung selbst wird über die Team-Freigaben geteilt (create_share mit dem Freigabetyp voice_number); eine angenommene Freigabe lässt auch bei dieser Person klingeln. get_voice_browser_token mit answering: true gibt einem Browser ein Token für jede Leitung eines anderen, die bei diesem Konto klingelt, damit sie auch dort klingelt; sie nehmen nur an.
Anrufe
list_voice_callsliest den Anrufverlauf, für das Konto, ein Profil oder eine Nummer.get_voice_call_transcriptliest den Text eines Anrufs, wenn es einen gibt.get_voice_browser_tokenundcreate_voice_call_intentlassen ein Browser-Softphone einen Anruf tätigen: Der Intent autorisiert einen ausgehenden Anruf von einer Nummer, die dir gehört, an eineto-Nummer. Die Xuda-iPhone-App fragt ihre Token mitpush_env(sandboxoderproduction) an: Jedes Token nennt dann die Twilio-Push-Zugangsdaten seines eigenen Twilio-Kontos, sodass ein Anruf das Telefon auch bei geschlossener App klingeln lässt, und die Antwort sagtpush: true.list_voice_transfer_targetsundtransfer_voice_callverlegen einen laufenden Anruf zu einer anderen Person im Profil, undtakeover_voice_callholt einen Anruf von der KI-Rezeption in deinen Browser.send_voice_announcementtätigt einen Anruf von einer deiner Nummern und spricht eine getippte Nachricht zu dem, der annimmt.
Textnachrichten
list_voice_message_threads listet Unterhaltungen mit der letzten Nachricht, der Zahl ungelesener Nachrichten und der Angabe auf, ob der Kontakt sich abgemeldet hat. list_voice_messages liest eine Unterhaltung. send_voice_message sendet eine Textnachricht von einer Nummer, die Textnachrichten kann; gib ihr einen idempotency_key, und ein Wiederholungsversuch wird einmal berechnet. Ein Kontakt, der STOP gesendet hat, wird abgelehnt, bis er START sendet. mark_voice_message_thread_read setzt die Zahl ungelesener Nachrichten einer Unterhaltung zurück.
Tarif, Nutzung und der Dienst
get_voice_plans liest die Tarifstufen und den Tarif, den du hast. set_voice_plan aktiviert, erhöht oder senkt ihn, entweder mit tier oder der Tarif-ID (profile_phone_phone); er braucht ein kostenpflichtiges Xuda-Konto. get_voice_usage liest die Anrufe und Textnachrichten des Monats, mit der Ausgabengrenze, die noch übrig ist. get_voice_service_status und activate_voice_service lesen und bereiten den Telefondienst des Kontos vor.