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 callback API

1. Log in to the Voice Service console.

2. In the left-side navigation pane, go to General Settings > Callback URLs and turn on the Intelligent Speech Interaction Callback URL switch.

3. In the Callback URL field, enter a callback URL (for example, https://push.example.com/contextpath/receive.do). The Response Info area shows the required JSON response format. This information is read-only.

   Note

   The callback URL receives real-time speech-to-text results and returns the next action.

   Important

   Before saving, ensure that the server corresponding to the receiving address is fully deployed and can return a response in the required JSON format. The response must contain the result, msg, code, and data fields, where the data field must contain the call_id, action, action_code, and extend fields. For the specific format, see the Response Example section.

4. Click Save. The system sends a one-time HTTP validation request to the callback URL to verify that the response conforms to the specified JSON format. If the callback URL is unreachable or the response format is incorrect, the settings will not be saved.

5. You can also click Test on the right to verify the configuration.

Callback interface specifications

Examples and parameters