Phone
Números comerciais que tocam para a sua equipa, com transferência, encaminhamento e gravação.
O Phone tem cinquenta métodos públicos, e a página do Phone do dashboard é construída sobre eles. Quarenta e quatro atuam pela conta cuja chave de API usa. Seis são para os operadores da própria Xuda e exigem uma chave de administrador: a revisão dos registos de conformidade de um país e o acerto de utilização e de registos, mais adopt_voice_number, que atribui a um perfil, sem compra, um número que a Xuda já possui.
Envie um pedido a um método com a sua chave:
Alugar um número
Isto é o que Alugar um número faz, pela mesma ordem.
Veja onde se podem alugar números
get_voice_country_catalog lista os países e os tipos de número que estão abertos. get_voice_compliance_status para um country diz o que esse país ainda exige de si antes de um número poder ser alugado: as suas políticas, a identidade por trás do número e, num país regulado, o registo do fornecedor de telefone.
Cumpra as verificações do país
accept_voice_terms regista as políticas, com todos os ids que o país lista e a policy_version exata. get_voice_identity_requirements devolve os campos que o país pede, update_profile_business_identity guarda-os e submit_voice_compliance envia-os para revisão. Para um país regulado, upload_voice_compliance_document envia cada documento que o fornecedor pede e submit_voice_bundle envia o registo.
Pesquise e peça orçamento
search_voice_numbers pesquisa os números livres por country e type (local, mobile, tollFree ou national), restringidos por area_code, um padrão contains ou capabilities exigidas. get_voice_number_rates mostra o que o número pode fazer e quanto custa a utilização. quote_voice_number calcula o preço de um candidato e mantém esse preço durante pouco tempo, para que não possa mudar durante uma compra em curso.
Compre
purchase_voice_number resgata o orçamento (quote_id e o mesmo phone_number) e cobra o aluguer recorrente. Passe payment_method_id para escolher o cartão que paga.
Liberte
release_voice_number devolve um número. Deixa de tocar de imediato e a sua renovação mensal é cancelada.
O envio de mensagens é escolhido quando um número é alugado: só um número que pode enviar mensagens as pode enviar ou receber, e não pode ser adicionado depois.
Dizer como uma linha atende
list_voice_numbers lista os seus números com o perfil a que cada um está associado. Com shared_only: true lista em vez disso as linhas que outras pessoas partilharam consigo e que aceitou, cada uma com shared_from; nunca contam para o seu plano. attach_voice_number dá um número a um perfil (um número por perfil, e o perfil principal nunca pode ter um) e detach_voice_number retira-o sem o libertar.
get_voice_number_setup lê numa única chamada tudo o que decide como um número atende: o perfil, o que o seu plano permite e as regras com as listas de opções por trás delas. update_voice_number_setup guarda-o. Cada secção só é tocada quando a envia, por isso guardar uma nunca repõe outra. A configuração também inclui auto_answer, o Assistente público que atende a linha e quando (always, when_no_answer, when_closed, schedule), guardado enviando apenas o que muda; uma escolha que não seja um dos seus Assistentes públicos ativos é recusada com assistant_not_public. Os ring.contacts e ring.groups das regras são contactos e grupos de contactos da própria área de trabalho da linha a quem ela também toca (um que já não exista é recusado com voice_answerer_not_found), e shared_with lista as pessoas com quem a linha é partilhada, pendentes ou aceites. get_profile_answering_rules e update_profile_answering_rules leem e guardam apenas as regras: horário comercial, o tempo limite de toque, quem recebe a chamada, reencaminhamento para um telemóvel, correio de voz e gravação.
Uma definição que o seu plano não inclui é recusada com voice_plan_upgrade_required, nunca ignorada em silêncio. Uma descida de plano entra em vigor na chamada seguinte, e o que guardou continua no lugar para que uma subida o traga de volta.
list_voice_profile_members, share_voice_profile e revoke_voice_profile_member decidem quem está num perfil, e portanto a quem uma linha pode tocar e a quem uma chamada pode ser transferida. Uma linha em si é partilhada através das partilhas da equipa (create_share com o tipo de partilha voice_number); uma partilha aceite toca também a essa pessoa. get_voice_browser_token com answering: true dá a um navegador um token por cada linha de outra pessoa que toca a esta conta, para que toque também aí; só atendem.
Chamadas
list_voice_callslê o histórico de chamadas, da conta, de um perfil ou de um número.get_voice_call_transcriptlê o texto de uma chamada, quando existe.get_voice_browser_tokenecreate_voice_call_intentpermitem a um softphone de navegador fazer uma chamada: a intenção autoriza uma chamada de saída de um número seu para um númeroto. A app Xuda para iPhone pede os seus tokens compush_env(sandboxouproduction): cada token nomeia então a credencial push da Twilio da sua própria conta Twilio, por isso uma chamada toca no telemóvel mesmo com a app fechada, e a resposta dizpush: true.list_voice_transfer_targetsetransfer_voice_callmovem uma chamada em curso para outra pessoa do perfil, etakeover_voice_callmove uma chamada do rececionista de IA para o seu navegador.send_voice_announcementfaz uma chamada a partir de um dos seus números e diz uma mensagem escrita a quem atender.
Mensagens
list_voice_message_threads lista as conversas com a última mensagem, a contagem de não lidas e se o contacto optou por sair. list_voice_messages lê uma conversa. send_voice_message envia uma mensagem a partir de um número que pode enviar mensagens; dê-lhe uma idempotency_key e uma repetição é faturada uma só vez. Um contacto que enviou STOP é recusado até enviar START. mark_voice_message_thread_read limpa a contagem de não lidas de uma conversa.
Plano, utilização e o serviço
get_voice_plans lê a escada de planos e o plano em que está. set_voice_plan ativa-o, sobe-o ou desce-o, com tier ou o id do plano (profile_phone_phone); exige uma conta Xuda paga. get_voice_usage lê as chamadas e mensagens do mês, com o limite de gastos que resta. get_voice_service_status e activate_voice_service leem e preparam o serviço telefónico da conta.