Allo

Ajouter un site web

Ajoute un site web aux connaissances du réceptionniste. Allo explore le site à partir de l'URL envoyée. L'exploration se fait en arrière-plan : l'appel…

POST/v2/api/numbers/{number}/agent/knowledge/websites

Comportement

Ajoute un site web aux connaissances du réceptionniste. Allo explore le site à partir de l'URL envoyée. L'exploration se fait en arrière-plan : l'appel renvoie 201 tout de suite avec l'entrée (statut ACTIVE). Le réceptionniste peut répondre à partir du site une fois l'indexation terminée. Si l'exploration échoue, l'API ne le signale pas.

Envoyez l'URL d'un site accessible publiquement. Une URL sans http:// ni https:// est enregistrée en https://. Le nombre de sites web n'est pas limité, mais la même URL ne peut pas être ajoutée deux fois sur une ligne.

Les sites web appartiennent à la bibliothèque de connaissances de votre équipe. Si une autre ligne de l'équipe a déjà ajouté cette URL, Allo relie le site existant à cette ligne au lieu de l'explorer à nouveau.

La réponse ne contient jamais le texte extrait. Ce texte est ce que le réceptionniste lit, pas quelque chose que vous configurez.

Erreurs

  • 400 INVALID_KNOWLEDGE_URL : l'URL n'a pas d'hôte public (par exemple acme au lieu de acme.com).
  • 409 AGENT_KNOWLEDGE_ALREADY_EXISTS : cette ligne utilise déjà un site web avec cette URL.
  • 404 PHONE_NUMBER_NOT_FOUND : ce numéro n'est pas un numéro auquel vous avez accès.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

numberstringrequis

Allo phone number in E.164 format

Corps

urlstringrequis

The URL of a publicly reachable site. A URL without a scheme is stored as https://.

Réponses

201The entry that was created
dataobject

A website of the team's knowledge library, crawled for the receptionist to answer from. The crawled text itself is not reported: it is what the receptionist reads, not something you configure.

5 champs
idstring
urlstring
statusenum<string>

ACTIVE when this line's receptionist answers from the website, DISABLED when this line does not use it.

ACTIVEDISABLED

created_atstring<date-time> | null
updated_atstring<date-time> | null
400
401
403
404
409
429