Telefon
Numere de business care sună echipa ta, cu transfer, rutare și înregistrare.
Phone are cincizeci de metode publice, iar pagina Phone din tabloul de bord este construită pe ele. Patruzeci și patru acționează pentru contul a cărui cheie API o folosești. Șase sunt pentru operatorii Xuda și cer o cheie de admin: evaluarea înregistrărilor de conformitate ale unei țări și decontarea utilizării și a înregistrărilor, plus adopt_voice_number, care atribuie unui profil, fără achiziție, un număr pe care Xuda îl deține deja.
Trimite o cerere către o metodă cu cheia ta:
Închiriază un număr
Asta face Închiriați un număr, în aceeași ordine.
Vezi unde pot fi închiriate numere
get_voice_country_catalog listează țările și tipurile de numere deschise. get_voice_compliance_status pentru un country spune ce mai cere acea țară de la tine înainte ca un număr să poată fi închiriat: politicile ei, identitatea din spatele numărului și, într-o țară reglementată, înregistrarea la furnizorul de telefonie.
Treci de verificările țării
accept_voice_terms înregistrează politicile, cu fiecare id pe care îl listează țara și policy_version exact. get_voice_identity_requirements returnează câmpurile pe care le cere țara, update_profile_business_identity le stochează, iar submit_voice_compliance le trimite spre evaluare. Pentru o țară reglementată, upload_voice_compliance_document trimite fiecare document cerut de furnizor, iar submit_voice_bundle trimite înregistrarea.
Caută și cere o ofertă
search_voice_numbers caută printre numerele libere după country și type (local, mobile, tollFree sau national), restrânse cu area_code, un tipar contains sau capabilities cerute. get_voice_number_rates arată ce poate face numărul și cât costă folosirea. quote_voice_number stabilește prețul unui candidat și îl ține o scurtă perioadă, ca să nu se poată schimba în timpul unei achiziții în curs.
Cumpără
purchase_voice_number valorifică oferta (quote_id și același phone_number) și taxează chiria recurentă. Trimite payment_method_id ca să alegi cardul care plătește.
Eliberează
release_voice_number returnează un număr. Încetează imediat să sune, iar reînnoirea lui lunară este anulată.
Mesajele text se aleg când un număr este închiriat: doar un număr care poate trimite mesaje poate trimite sau primi mesaje text, și nu se poate adăuga mai târziu.
Spune cum răspunde o linie
list_voice_numbers listează numerele tale cu profilul de care este atașat fiecare. Cu shared_only: true listează în schimb liniile partajate cu tine de alții și pe care le-ai acceptat, fiecare cu shared_from; acestea nu contează niciodată pentru planul tău. attach_voice_number dă un număr unui profil (un număr pe profil, iar profilul principal nu poate avea niciodată unul) și detach_voice_number îl scoate fără să-l elibereze.
get_voice_number_setup citește într-un singur apel tot ce decide cum răspunde un număr: profilul, ce permite planul tău și regulile cu listele de opțiuni din spatele lor. update_voice_number_setup îl salvează. Fiecare secțiune este modificată doar când o trimiți, așa că salvarea uneia nu o resetează niciodată pe alta. Configurarea conține și auto_answer, Asistentul public care răspunde pe linie și când (always, when_no_answer, when_closed, schedule), salvat trimițând doar ce se schimbă; o alegere care nu este unul dintre Asistenții tăi publici activi este refuzată cu assistant_not_public. Câmpurile ring.contacts și ring.groups ale regulilor sunt contacte și grupuri de contacte din spațiul de lucru al liniei pe care aceasta le sună și ea (unul care nu mai există este refuzat cu voice_answerer_not_found), iar shared_with listează persoanele cu care linia este partajată, în așteptare sau acceptate. get_profile_answering_rules și update_profile_answering_rules citesc și salvează doar regulile: orele de program, timpul de sunat, cine este sunat, redirecționarea către un mobil, mesageria vocală și înregistrarea.
O setare pe care planul tău nu o include este refuzată cu voice_plan_upgrade_required, nu ignorată pe tăcute. O retrogradare intră în vigoare chiar la următorul apel, iar ce ai salvat rămâne pe loc, ca o îmbunătățire a planului să le readucă.
list_voice_profile_members, share_voice_profile și revoke_voice_profile_member stabilesc cine este pe un profil și deci pe cine poate suna o linie și cui poate fi transferat un apel. O linie în sine se partajează prin partajările echipei (create_share cu tipul de partajare voice_number); o partajare acceptată sună și acea persoană. get_voice_browser_token cu answering: true dă unui browser câte un token pentru fiecare linie a altcuiva care sună acest cont, ca să sune și acolo; ele doar răspund.
Apeluri
list_voice_callscitește istoricul apelurilor, pentru cont, un profil sau un număr.get_voice_call_transcriptcitește textul unui apel, când există.get_voice_browser_tokenșicreate_voice_call_intentlasă un softphone din browser să dea un apel: intenția autorizează un apel de ieșire de la un număr pe care îl deții către un numărto. Aplicația Xuda pentru iPhone își cere tokenurile cupush_env(sandboxsauproduction): fiecare token numește apoi credențialul push Twilio al propriului cont Twilio, așa că un apel sună telefonul chiar cu aplicația închisă, iar răspunsul spunepush: true.list_voice_transfer_targetsșitransfer_voice_callmută un apel live la o altă persoană de pe profil, iartakeover_voice_callmută un apel de la recepționerul AI în browserul tău.send_voice_announcementdă un apel de pe unul dintre numerele tale și rostește un mesaj scris celui care răspunde.
Mesaje
list_voice_message_threads listează conversațiile cu ultimul mesaj, numărul de necitite și dacă contactul s-a dezabonat. list_voice_messages citește o conversație. send_voice_message trimite un mesaj de pe un număr care poate trimite mesaje; dă-i un idempotency_key și o reîncercare este facturată o singură dată. Un contact care a trimis STOP este refuzat până trimite START. mark_voice_message_thread_read șterge numărul de necitite al unei conversații.
Plan, utilizare și serviciul
get_voice_plans citește scara de planuri și planul pe care ești. set_voice_plan îl activează, îl îmbunătățește sau îl retrogradează, cu tier sau cu id-ul planului (profile_phone_phone); are nevoie de un cont Xuda plătit. get_voice_usage citește apelurile și mesajele lunii, cu plafonul de cheltuieli rămas. get_voice_service_status și activate_voice_service citesc și pregătesc serviciul de telefonie al contului.