Text-To-Speech Prompt API

You use the Text-To-Speech Prompt API to:

  • Capture - digits entered directly on the handset by the user are sent to you in the Text-To-Speech Prompt Return Parameters.
  • Confirm - check if your user has correctly entered a pin_code.

Note: remember to send 200 ok when you receive the Text-To-Speech Prompt Return Parameters.

This section briefly explains the:

Capture workflow

To create a Capture Text-To-Speech Prompt you:

  1. Create a Text-To-Speech Prompt using the request.
  2. Receive a response and check the response Codes to ensure that you sent the request to the Cloud Communications Platform correctly.
  3. If you set callback in the request, receive the Text-To-Speech Prompt Return Parameters at your Callback URL so you see:
    • If the status was successful.
    • The digits the user entered during the Text-To-Speech Prompt.
    • When and how the Text-To-Speech Prompt was made.
    • How much the Text-To-Speech Prompt cost.

Confirm workflow

To create a Confirm Text-To-Speech Prompt you:

  1. Send your user a PIN through a different media. For example, in an SMS sent using SMS API.
  2. Create a Text-To-Speech Prompt using the request.
  3. Receive a Response and check the Response Codes to ensure that you sent the request to the Cloud Communications Platform correctly.
  4. If you set callback in the request, receive the Text-To-Speech Prompt Return Parameters at your Callback URL so you see:
    • If the status was successful.
    • If your user entered the PIN:
      • Correctly - you receive pin_code in the digits return parameter.
      • Incorrectly 3 times - digits is set to undefined.
    • When and how the Text-To-Speech Prompt was made.
    • How much the Text-To-Speech Prompt cost.