Skip to main content

Relay.Calling.PromptAction

This object returned from one of asynchronous prompt methods that represents a prompt attempt that is currently active on a call.

Methods​

getControlId​

Return the UUID to identify the prompt attempt.

Available In:

Parameters

None

Returns

string - UUID to identify the action.

Examples

Start the attempt and print the controlId.
<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'initial_timeout' => 10,
  'text' => 'Please, enter your 3 digits PIN'
];
$call->promptTTSAsync($collect)->done(function($action) {
  echo $action->getControlId();
});

getPayload​

Return the payload sent to Relay to initiate the request. Useful to inspect what you sent to perform this action.

Available In:

Parameters

None

Returns

Object - Payload sent to Relay.

Examples

Start the attempt and print out the payload.
<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'initial_timeout' => 10,
  'text' => 'Please, enter your 3 digits PIN'
];
$call->promptTTSAsync($collect)->done(function($action) {
  print_r($action->getPayload());
});

getResult​

Returns the final result of the prompt attempt.

Available In:

Parameters

None

Returns

Relay.Calling.PromptResult - Final result of the prompt attempt.

Examples

Start the attempt and grab the result when it's completed.
<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'initial_timeout' => 10,
  'text' => 'Please, enter your 3 digits PIN'
];
$call->promptTTSAsync($collect)->done(function($action) {
  // .. later in the code since it's an async method
  if ($action->isCompleted()) {
    $result = $action->getResult();
  }
});

getState​

Return the current state of the prompt attempt.

Available In:

Parameters

None

Returns

string - Current state of the prompt attempt.

Examples

Start the attempt and print the state.
<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'initial_timeout' => 10,
  'text' => 'Please, enter your 3 digits PIN'
];
$call->promptTTSAsync($collect)->done(function($action) {
  echo $action->getState();
});

isCompleted​

Return true if the prompt attempt has finished, false otherwise.

Available In:

Parameters

None

Returns

Boolean - True/False accordingly to the state.

Examples

Start the attempt and check if it has finished.
<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'initial_timeout' => 10,
  'text' => 'Please, enter your 3 digits PIN'
];
$call->promptTTSAsync($collect)->done(function($action) {
  if ($action->isCompleted()) {

  }
});

stop​

Stop the action immediately.

Available In:

Parameters

None

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.StopResult object.

Examples

Start the attempt and then stop it.
<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'initial_timeout' => 10,
  'text' => 'Please, enter your 3 digits PIN'
];
$call->promptTTSAsync($collect)->done(function($action) {
  // For demonstration purposes only..
  $action->stop()->done(function($stopResult) {

  });
});

volume​

Control the volume of the playback.

Available In:

Parameters

volumenumberrequiredVolume value between -40dB and +40dB where 0 is unchanged.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.PromptVolumeResult object.

Examples

Start the prompt and increase the playback volume.
<?php

$collect = [
  'type' => 'digits',
  'digits_max' => 3,
  'initial_timeout' => 10,
  'text' => 'Please, enter your 3 digits PIN'
];
$call->promptTTSAsync($collect)->done(function($action) {
  // For demonstration purposes only..
  $action->volume(5.0)->done(function($volumeResult) {

  });
});