Phone
Des numéros professionnels qui sonnent chez votre équipe, avec transfert, routage et enregistrement.
Téléphone a cinquante méthodes publiques, et la page Téléphone du tableau de bord est construite dessus. Quarante-quatre agissent pour le compte dont vous utilisez la clé d'API. Six sont réservées aux opérateurs de Xuda et demandent une clé d'administrateur : la revue des dossiers de conformité d'un pays et le règlement de l'utilisation et des enregistrements, ainsi que adopt_voice_number, qui attribue à un profil un numéro que Xuda possède déjà, sans achat.
Envoyez une requête à une méthode avec votre clé :
Louer un numéro
C'est ce que fait Louer un numéro, dans le même ordre.
Voyez où des numéros peuvent être loués
get_voice_country_catalog liste les pays et les types de numéros ouverts. get_voice_compliance_status pour un country indique ce que ce pays attend encore de vous avant qu'un numéro puisse être loué : ses politiques, l'identité derrière le numéro et, dans un pays réglementé, l'enregistrement auprès de l'opérateur téléphonique.
Passez les contrôles du pays
accept_voice_terms enregistre les politiques, avec chaque id que le pays liste et la policy_version exacte. get_voice_identity_requirements renvoie les champs que le pays demande, update_profile_business_identity les stocke et submit_voice_compliance les envoie en revue. Pour un pays réglementé, upload_voice_compliance_document envoie chaque document que l'opérateur demande et submit_voice_bundle envoie l'enregistrement.
Recherchez et obtenez un devis
search_voice_numbers cherche les numéros libres par country et type (local, mobile, tollFree ou national), affinés par area_code, un motif contains ou des capabilities requises. get_voice_number_rates montre ce que le numéro peut faire et ce que coûte son usage. quote_voice_number chiffre un candidat et garde ce prix un court moment, pour qu'il ne puisse pas bouger pendant un achat en cours.
Achetez
purchase_voice_number utilise le devis (quote_id et le même phone_number) et débite la location récurrente. Passez payment_method_id pour choisir la carte qui paie.
Libérez
release_voice_number rend un numéro. Il cesse de sonner immédiatement et son renouvellement mensuel est annulé.
Les SMS se choisissent à la location d'un numéro : seul un numéro qui peut envoyer des SMS peut en envoyer ou en recevoir, et cela ne peut pas être ajouté plus tard.
Dire comment une ligne répond
list_voice_numbers liste vos numéros avec le profil auquel chacun est rattaché. Avec shared_only: true, il liste à la place les lignes que d'autres personnes ont partagées avec vous et que vous avez acceptées, chacune avec shared_from ; elles ne comptent jamais dans votre forfait. attach_voice_number donne un numéro à un profil (un numéro par profil, et le profil principal ne peut jamais en avoir) et detach_voice_number le retire sans le libérer.
get_voice_number_setup lit en un seul appel tout ce qui décide comment un numéro répond : le profil, ce que votre forfait autorise, et les règles avec les listes d'options qui les accompagnent. update_voice_number_setup l'enregistre. Chaque section n'est touchée que si vous l'envoyez, si bien qu'en enregistrer une ne réinitialise jamais une autre. La configuration porte aussi auto_answer, l'Assistant public qui répond à la ligne et quand (always, when_no_answer, when_closed, schedule), enregistré en n'envoyant que ce qui change ; un choix qui n'est pas l'un de vos Assistants publics actifs est refusé avec assistant_not_public. Les ring.contacts et ring.groups des règles sont des contacts et des groupes de contacts de l'espace de travail propre à la ligne qu'elle fait aussi sonner (un contact disparu est refusé avec voice_answerer_not_found), et shared_with liste les personnes avec qui la ligne est partagée, en attente ou acceptées. get_profile_answering_rules et update_profile_answering_rules lisent et enregistrent les règles seules : heures d'ouverture, délai de sonnerie, qui sonne, transfert vers un mobile, messagerie vocale et enregistrement.
Un réglage que votre forfait n'inclut pas est refusé avec voice_plan_upgrade_required, jamais abandonné en silence. Un passage à un forfait inférieur prend effet dès l'appel suivant, et ce que vous avez enregistré reste en place pour qu'une montée en gamme le rétablisse.
list_voice_profile_members, share_voice_profile et revoke_voice_profile_member décident qui est dans un profil, et donc qui une ligne peut faire sonner et à qui un appel peut être transféré. Une ligne elle-même se partage par les partages d'équipe (create_share avec le type de partage voice_number) ; un partage accepté fait aussi sonner cette personne. get_voice_browser_token avec answering: true donne à un navigateur un jeton pour chaque ligne de quelqu'un d'autre qui fait sonner ce compte, pour qu'elle sonne là aussi ; ils répondent seulement.
Appels
list_voice_callslit l'historique des appels, pour le compte, un profil ou un numéro.get_voice_call_transcriptlit le texte d'un appel, quand il y en a un.get_voice_browser_tokenetcreate_voice_call_intentpermettent à un softphone de navigateur de passer un appel : l'intention autorise un appel sortant depuis un numéro que vous possédez vers un numéroto. L'app Xuda pour iPhone demande ses jetons avecpush_env(sandboxouproduction) : chaque jeton nomme alors l'identifiant push Twilio de son propre compte Twilio, de sorte qu'un appel fait sonner le téléphone même app fermée, et la réponse indiquepush: true.list_voice_transfer_targetsettransfer_voice_calldéplacent un appel en cours vers une autre personne du profil, ettakeover_voice_callretire un appel à la réceptionniste IA pour le passer à votre navigateur.send_voice_announcementpasse un appel depuis l'un de vos numéros et dit un message saisi à la personne qui répond.
SMS
list_voice_message_threads liste les conversations avec le dernier message, le nombre de non lus et si le contact s'est désabonné. list_voice_messages lit une conversation. send_voice_message envoie un SMS depuis un numéro qui peut en envoyer ; donnez-lui une idempotency_key et une nouvelle tentative n'est facturée qu'une fois. Un contact qui a envoyé STOP est refusé jusqu'à ce qu'il envoie START. mark_voice_message_thread_read remet à zéro le compteur de non lus d'une conversation.
Forfait, utilisation et service
get_voice_plans lit l'échelle des forfaits et celui que vous avez. set_voice_plan l'active, le monte ou le descend, avec tier ou l'id du forfait (profile_phone_phone) ; il demande un compte Xuda payant. get_voice_usage lit les appels et les SMS du mois, avec le plafond de dépenses restant. get_voice_service_status et activate_voice_service lisent et préparent le service téléphonique du compte.