Berichten maken met de Bot Connector-API
Uw bot verzendt activiteitsobjecten van het type bericht om informatie aan gebruikers te communiceren en ontvangt ook berichtactiviteiten van gebruikers. Sommige berichten kunnen gewoon bestaan uit tekst zonder opmaak, terwijl andere mogelijk uitgebreidere inhoud bevatten, zoals tekst die moet worden uitgesproken, voorgestelde acties, mediabijlagen, rtf-kaarten en kanaalspecifieke gegevens. In dit artikel worden enkele veelgebruikte berichteigenschappen beschreven.
Berichttekst en -opmaak
Berichttekst kan worden opgemaakt met behulp van platte opmaak, Markdown of XML. De standaardindeling voor de textFormat
eigenschap is markdown en interpreteert tekst met behulp van Markdown-opmaakstandaarden. Het ondersteuningsniveau voor tekstindelingen varieert per kanaal.
Tip
Zie het naslagartikel over kanalen voor informatie over welke functies op elk kanaal worden ondersteund.
De textFormat
eigenschap van het object Activity kan worden gebruikt om de opmaak van de tekst op te geven. Als u bijvoorbeeld een basisbericht wilt maken dat alleen tekst zonder opmaak bevat, stelt u de textFormat
eigenschap van het Activity
object in op niet-opgemaakt, stelt u de text
eigenschap in op de inhoud van het bericht en stelt u de locale
eigenschap in op de landinstelling van de afzender.
Bijlagen
De attachments
eigenschap van het object Activity kan worden gebruikt voor het verzenden van eenvoudige mediabijlagen (afbeelding, audio, video, bestand) en uitgebreide kaarten. Zie Mediabijlagen toevoegen aan berichten en Kaarten met opmaak toevoegen aan berichten voor meer informatie.
Entiteiten
De entities
eigenschap van het object Activity is een matrix van open-ended schema.org-objecten waarmee algemene contextuele metagegevens tussen het kanaal en de bot kunnen worden uitgewisseld.
Entiteiten vermelden
Veel kanalen ondersteunen de mogelijkheid voor een bot of gebruiker om iemand te 'vermelden' in de context van een gesprek. Als u een gebruiker in een bericht wilt vermelden, vult u de eigenschap van entities
het bericht in met een vermeldingsobject .
Entiteiten plaatsen
Als u locatiegerelateerde informatie in een bericht wilt overbrengen, vult u de eigenschap van entities
het bericht in met Place-objecten .
Kanaalgegevens
De channelData
eigenschap van het object Activity kan worden gebruikt om kanaalspecifieke functionaliteit te implementeren. Zie Kanaalspecifieke functionaliteit implementeren voor meer informatie.
Tekst naar spraak
De speak
eigenschap van het object Activity kan worden gebruikt om de tekst op te geven die door uw bot moet worden gesproken in een spraakkanaal en de inputHint
eigenschap van het Activity
object kan worden gebruikt om de status van de microfoon van de client te beïnvloeden. Zie Spraak toevoegen aan berichten en Invoerhints toevoegen aan berichten voor meer informatie.
Voorgestelde acties
De suggestedActions
eigenschap van het object Activiteit kan worden gebruikt om knoppen weer te geven waarop de gebruiker kan tikken om invoer te geven. In tegenstelling tot knoppen die worden weergegeven in uitgebreide kaarten (die zichtbaar en toegankelijk blijven voor de gebruiker, zelfs nadat erop is getikt), verdwijnen knoppen die worden weergegeven in het deelvenster voorgestelde acties nadat de gebruiker een selectie heeft gemaakt. Zie Voorgestelde acties toevoegen aan berichten voor meer informatie.
Aanvullende resources
- Naslaginformatie over kanalen
- Overzicht van activiteiten
- Berichten verzenden en ontvangen
- Mediabijlagen toevoegen aan berichten
- Uitgebreide kaarten toevoegen aan berichten
- Spraak toevoegen aan berichten
- Invoerhints toevoegen aan berichten
- Voorgestelde acties toevoegen aan berichten
- Implement channel-specific functionality (Kanaalspecifieke functionaliteit implementeren)