system.twilio.getActiveCall
This function is used in Python Scripting.
Description​
Returns a list of configurations for currently active Twilio voice calls. This only applies to synchronous calls that use the reverse-proxy system to call back into Ignition for authentication and alarm acknowledgements. Since calls can last minutes and potentially be stuck ringing for some time, this function gives users a view of the current state of call notifications while they're active.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.twilio.getActiveCall(accountName)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | accountName | The Twilio account to use for the calls. |
Returns​
CallView - An array of CallView objects, including the properties listed below.
| Property | Description | Type |
|---|---|---|
| sid | The unique ID generated by Twilio representing the call. | String |
| answeredBy | Whether the call was answered by a human or a machine. | String |
| status | Current call status, options include BUSY, CANCELED, COMPLETED, FAILED, IN_PROGRESS, NO_ANSWER, QUEUED, and RINGING. | String |
| apiVersion | API version used to create the call. | String |
| callerName | The caller's name, if Caller ID is enabled. | String |
| duration | The duration of the call. | String |
| from | The phone number configured with Twilio to use for making the calls. | String |
| to | The phone number of the recipient. | String |
| queueTimeString | The call queue time. | String |
| dateCreatedString | The call creation date, formatted as a org.joda.time.DateTime object. | String |
| dateUpdatedString | The call updated date, formatted as a org.joda.time.DateTime object. | String |
| endTimeString | The call end time, formatted as a org.joda.time.DateTime object. | String |
| startTimeString | The call start time, formatted as a org.joda.time.DateTime object. | String |
| dateCreated | The call creation date. | Long |
| dateUpdated | The call updated date. | Long |
| endTime | The call end time. | Long |
| startTime | The call start time. | Long |
Scope​
Gateway, Vision Client, Perspective Session