Phone
Numeri aziendali che squillano al Suo team, con trasferimento, instradamento e registrazione.
Phone ha cinquanta metodi pubblici, e la pagina Phone della dashboard è costruita su di essi. Quarantaquattro agiscono per l'account di cui usi la chiave API. Sei sono per gli operatori di Xuda e richiedono una chiave admin: la revisione dei registri di conformità di un paese e la regolazione di utilizzo e registrazioni, più adopt_voice_number, che assegna a un profilo un numero che Xuda possiede già, senza acquisto.
Invia una richiesta a un metodo con la tua chiave:
Noleggia un numero
Questo è ciò che fa Noleggi un numero, nello stesso ordine.
Vedi dove si possono noleggiare i numeri
get_voice_country_catalog elenca i paesi e i tipi di numero aperti. get_voice_compliance_status per un country dice che cosa quel paese richiede ancora da te prima che un numero possa essere noleggiato: le sue politiche, l'identità dietro il numero e, in un paese regolamentato, la registrazione presso il fornitore telefonico.
Supera i controlli del paese
accept_voice_terms registra le politiche, con ogni id elencato dal paese e l'esatta policy_version. get_voice_identity_requirements restituisce i campi richiesti dal paese, update_profile_business_identity li memorizza e submit_voice_compliance li invia in revisione. Per un paese regolamentato, upload_voice_compliance_document invia ogni documento richiesto dal fornitore e submit_voice_bundle invia la registrazione.
Cerca e richiedi un preventivo
search_voice_numbers cerca i numeri liberi per country e type (local, mobile, tollFree o national), ristretti da area_code, un modello contains o capabilities richieste. get_voice_number_rates mostra che cosa può fare il numero e quanto costa usarlo. quote_voice_number calcola il prezzo di un candidato e lo mantiene per breve tempo, così non può cambiare durante un acquisto in corso.
Acquista
purchase_voice_number riscatta il preventivo (quote_id e lo stesso phone_number) e addebita il noleggio ricorrente. Passa payment_method_id per scegliere la carta che paga.
Rilascia
release_voice_number restituisce un numero. Smette subito di squillare e il suo rinnovo mensile viene annullato.
Gli SMS si scelgono quando un numero viene noleggiato: solo un numero che può inviare SMS può inviarli o riceverli, e la funzione non si può aggiungere in seguito.
Decidi come risponde una linea
list_voice_numbers elenca i tuoi numeri con il profilo a cui ciascuno è collegato. Con shared_only: true elenca invece le linee che altre persone hanno condiviso con te e che hai accettato, ciascuna con shared_from; non contano mai per il tuo piano. attach_voice_number dà un numero a un profilo (un numero per profilo, e il profilo principale non può mai averne uno) e detach_voice_number lo toglie senza rilasciarlo.
get_voice_number_setup legge in una sola chiamata tutto ciò che decide come risponde un numero: il profilo, che cosa consente il tuo piano e le regole con gli elenchi di opzioni che le sostengono. update_voice_number_setup lo salva. Ogni sezione viene toccata solo quando la invii, quindi salvarne una non ne reimposta mai un'altra. La configurazione contiene anche auto_answer, l'Assistente pubblico che risponde alla linea e quando (always, when_no_answer, when_closed, schedule), salvato inviando solo ciò che cambia; una scelta che non è uno dei tuoi Assistenti pubblici attivi viene rifiutata con assistant_not_public. I ring.contacts e ring.groups delle regole sono contatti e gruppi di contatti del workspace della linea stessa che essa fa squillare anche (uno che non esiste più viene rifiutato con voice_answerer_not_found), e shared_with elenca le persone con cui la linea è condivisa, in attesa o accettate. get_profile_answering_rules e update_profile_answering_rules leggono e salvano solo le regole: orari di lavoro, timeout dello squillo, chi viene fatto squillare, inoltro a un cellulare, segreteria e registrazione.
Un'impostazione che il tuo piano non include viene rifiutata con voice_plan_upgrade_required, mai scartata in silenzio. Un downgrade ha effetto sulla chiamata immediatamente successiva, e ciò che hai salvato resta al suo posto, così un upgrade lo riporta.
list_voice_profile_members, share_voice_profile e revoke_voice_profile_member decidono chi è in un profilo, e quindi chi una linea può far squillare e a chi si può trasferire una chiamata. Una linea in sé si condivide tramite le condivisioni del team (create_share con il tipo di condivisione voice_number); una condivisione accettata fa squillare anche quella persona. get_voice_browser_token con answering: true dà a un browser un token per ogni linea di qualcun altro che fa squillare questo account, così squilla anche lì; possono solo rispondere.
Chiamate
list_voice_callslegge la cronologia delle chiamate, per l'account, un profilo o un numero.get_voice_call_transcriptlegge il testo di una chiamata, quando c'è.get_voice_browser_tokenecreate_voice_call_intentpermettono a un softphone nel browser di fare una chiamata: l'intento autorizza una chiamata in uscita da un numero che possiedi verso un numeroto. L'app Xuda per iPhone chiede i suoi token conpush_env(sandboxoproduction): ogni token indica allora la credenziale push Twilio del proprio account Twilio, così una chiamata fa squillare il telefono anche con l'app chiusa, e la risposta dicepush: true.list_voice_transfer_targetsetransfer_voice_callspostano una chiamata in corso a un'altra persona del profilo, etakeover_voice_callsposta una chiamata dal receptionist AI al tuo browser.send_voice_announcementfa una chiamata da uno dei tuoi numeri e pronuncia un messaggio digitato a chi risponde.
SMS
list_voice_message_threads elenca le conversazioni con l'ultimo messaggio, il conteggio dei non letti e se il contatto ha rifiutato. list_voice_messages legge una conversazione. send_voice_message invia un SMS da un numero che può inviarne; dagli un idempotency_key e un nuovo tentativo viene fatturato una volta sola. Un contatto che ha inviato STOP viene rifiutato finché non invia START. mark_voice_message_thread_read azzera il conteggio dei non letti di una conversazione.
Piano, utilizzo e servizio
get_voice_plans legge la scala dei piani e il piano in cui sei. set_voice_plan lo attiva, lo aumenta o lo riduce, con tier oppure con l'id del piano (profile_phone_phone); richiede un account Xuda a pagamento. get_voice_usage legge le chiamate e gli SMS del mese, con il tetto di spesa che resta. get_voice_service_status e activate_voice_service leggono e preparano il servizio telefonico dell'account.