Intelligent Speech Interaction inbound callback HTTP interface

Updated at:

This topic describes how to configure inbound calls and callback interfaces for the Intelligent Speech Interaction inbound callback HTTP interface.

Business flow

For more information about the business flow, see Intelligent Speech Interaction inbound business flow.

Add an inbound configuration for a specific number

  1. Log on to the Voice Service console.

  2. In the navigation pane on the left, choose General Settings.

  3. On the Service Activation tab, enable the Intelligent Speech Interaction feature. If it is already enabled, skip to the next step.

  4. On the Call Settings tab, click General Inbound Configuration > Add Inbound Configuration for Specific Number to open the Inbound Configuration for Specific Number page.

  5. Set Configuration Type to Intelligent Speech Interaction Inbound. Then, select a Company, Called Number, and Configuration Description as prompted.

  6. Click Add.

Configure the webhook interface

  1. Log on to the Voice Service console.

  2. In the navigation pane on the left, choose General Settings > Webhook Address. Turn on the Intelligent Speech Interaction Webhook Address switch.

  3. Set the response information and receiving address as prompted.

    Note

    The receiving address accepts real-time speech-to-text results and returns the next action to perform.

  4. Click Save.

  5. Click Test on the right to test the configuration.

Callback interface specifications

Specification

Description

Interface protocol

HTTP

Method

POST

Character encoding format

UTF-8

Examples and parameters

For request examples, response examples, and their parameters for the Intelligent Speech Interaction inbound callback HTTP interface, see:

Note
  • For the initial inbound call, the 'content_type' request parameter is 'callin'. This indicates that a user initiated the call by dialing the specified number.

  • For subsequent inbound calls, the 'content_type' value depends on the message type. For example, 'mute' indicates a mute message.