Telefon
Forretningsnumre som ringer teamet ditt, med overføring, ruting og opptak.
Telefon har femti offentlige metoder, og dashbordets Telefon-side er bygget på dem. Førti-fire handler for kontoen hvis API-nøkkel du bruker. Seks er for Xudas egne operatører og krever en admin-nøkkel: gjennomgangen av et lands samsvarsposter og oppgjøret av bruk og registreringer, pluss adopt_voice_number, som tildeler et nummer Xuda allerede eier, til en profil uten kjøp.
Send en forespørsel til en metode med nøkkelen din:
Lei et nummer
Dette er det Lei et nummer gjør, i samme rekkefølge.
Se hvor numre kan leies
get_voice_country_catalog viser landene og nummertypene som er åpne. get_voice_compliance_status for et country sier hva landet fortsatt trenger fra deg før et nummer kan leies: retningslinjene, identiteten bak nummeret og, i et regulert land, telefonleverandørens registrering.
Fullfør landets kontroller
accept_voice_terms registrerer retningslinjene, med hver id landet oppgir og den nøyaktige policy_version. get_voice_identity_requirements returnerer feltene landet ber om, update_profile_business_identity lagrer dem og submit_voice_compliance sender dem til gjennomgang. For et regulert land sender upload_voice_compliance_document hvert dokument leverandøren ber om, og submit_voice_bundle sender registreringen.
Søk og få pris
search_voice_numbers søker blant de ledige numrene etter country og type (local, mobile, tollFree eller national), avgrenset med area_code, et contains-mønster eller påkrevde capabilities. get_voice_number_rates viser hva nummeret kan gjøre og hva bruk koster. quote_voice_number priser én kandidat og holder prisen en kort stund, så den ikke kan flytte seg under et kjøp som pågår.
Kjøp
purchase_voice_number løser inn tilbudet (quote_id og samme phone_number) og belaster den gjentakende leien. Send payment_method_id for å velge kortet som betaler.
Frigi
release_voice_number gir et nummer tilbake. Det slutter å ringe med en gang, og den månedlige fornyelsen avbestilles.
SMS velges når et nummer leies: bare et nummer som kan sende SMS, kan sende eller motta dem, og det kan ikke legges til senere.
Si hvordan en linje svarer
list_voice_numbers viser numrene dine med profilen hvert er knyttet til. Med shared_only: true viser den i stedet linjene andre har delt med deg og du har godtatt, hver med shared_from; de teller aldri mot planen din. attach_voice_number gir et nummer til en profil (ett nummer per profil, og hovedprofilen kan aldri ha ett) og detach_voice_number tar det av uten å frigi det.
get_voice_number_setup leser alt som avgjør hvordan ett nummer svarer, i ett kall: profilen, hva planen din tillater, og reglene med alternativlistene bak dem. update_voice_number_setup lagrer det. Hver del berøres bare når du sender den, så å lagre én nullstiller aldri en annen. Oppsettet har også auto_answer, den offentlige assistenten som svarer på linjen og når (always, when_no_answer, when_closed, schedule), lagret ved å sende bare det som endres; et valg som ikke er en av dine aktive offentlige assistenter, blir avvist med assistant_not_public. Reglenes ring.contacts og ring.groups er kontakter og kontaktgrupper i linjens eget arbeidsområde som den også ringer (en som er borte, blir avvist med voice_answerer_not_found), og shared_with viser personene linjen er delt med, ventende eller godtatt. get_profile_answering_rules og update_profile_answering_rules leser og lagrer bare reglene: åpningstider, ringetidsavbrudd, hvem som ringes, viderekobling til en mobil, telefonsvarer og opptak.
En innstilling planen din ikke inkluderer, blir avvist med voice_plan_upgrade_required, aldri stille droppet. En nedgradering trer i kraft ved aller neste samtale, og det du har lagret, blir stående, så en oppgradering bringer det tilbake.
list_voice_profile_members, share_voice_profile og revoke_voice_profile_member avgjør hvem som er på en profil, og dermed hvem en linje kan ringe og hvem en samtale kan overføres til. En linje deles selv gjennom teamdelingene (create_share med deletypen voice_number); en godtatt deling ringer den personen også. get_voice_browser_token med answering: true gir en nettleser én token for hver linje som tilhører noen andre og ringer denne kontoen, så den ringer der også; de kan bare svare.
Samtaler
list_voice_callsleser samtalehistorikken, for kontoen, en profil eller ett nummer.get_voice_call_transcriptleser teksten i én samtale, når det finnes en.get_voice_browser_tokenogcreate_voice_call_intentlar en nettleserbasert telefon ringe: intensjonen gir tillatelse til én utgående samtale fra et nummer du eier til etto-nummer. Xuda iPhone-appen ber om tokenene sine medpush_env(sandboxellerproduction): hver token navngir da Twilio-push-legitimasjonen til sin egen Twilio-konto, så en samtale ringer telefonen selv om appen er lukket, og svaret sierpush: true.list_voice_transfer_targetsogtransfer_voice_callflytter en levende samtale til en annen person på profilen, ogtakeover_voice_callflytter en samtale fra AI-resepsjonisten til nettleseren din.send_voice_announcementringer fra et av numrene dine og leser en skrevet melding høyt for den som svarer.
SMS
list_voice_message_threads viser samtaletråder med siste melding, antall uleste og om kontakten har meldt seg ut. list_voice_messages leser én samtaletråd. send_voice_message sender én SMS fra et nummer som kan sende SMS; gi den en idempotency_key, så blir et nytt forsøk fakturert én gang. En kontakt som har sendt STOP, blir avvist til de sender START. mark_voice_message_thread_read nullstiller antall uleste i en samtaletråd.
Plan, bruk og tjenesten
get_voice_plans leser planstigen og planen du er på. set_voice_plan aktiverer, oppgraderer eller nedgraderer den, med enten tier eller plan-id-en (profile_phone_phone); den krever en betalt Xuda-konto. get_voice_usage leser månedens samtaler og SMS, med utgiftsgrensen som er igjen. get_voice_service_status og activate_voice_service leser og forbereder kontoens telefontjeneste.