Tropo is part of CiscoLearn More

Signals

The Signals API allows you to use HTTP calls to control a running Tropo application. When a Signal is sent to a session, Tropo checks the signal name agains the allowedSignals parameter of the currently running Tropo function for that session. If there is a match, Tropo forces that function to exit.

Resource URL

https://api.tropo.com/v1/sessions/:id/signals

The :id in the URL is the Tropo Session ID GUID. This is returned in the Session API response, or is available in your application as currentCall.sessionId.

Fields

signal
The name is the signal used to interrupt the function. This field is required.
status
This identifies whether the interrupt was successful or not. Possible values are:

QUEUED - the event delivered successfully to the event queue of the target session
NOTFOUND - the target session could not be found
FAILED - some other failure occurred.

This is a read-only field returned in the response.