Add-on Results API
The Add-on Results API allows you to list and retrieve Add-on results.
Currently, the API only provides results for Recording Analysis Add-onsm and the data is persisted for no more than 30 days.
Recording analysis Add-on results
Add-on results exist as a subresource under the integration point with which the Add-on was configured. For Recordings, this is the Recording resource.
/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/AddOnResults/
These subresources require HTTP basic authentication to access using your Account SIS and Auth Token.
GET requests on Recording Add-on Results subresources can return one of the following representations with the appropriate extensions:
| Extension | Representation |
|---|---|
.xml or none |
XML |
.json |
JSON |
.csv |
CSV |
Add-on Result instance subresource
The Add-on Result instance subresource represents the result from an Add-on invoked on a specific Recording.
Sub-Resource URI
/AddOnResults/{RequestSid}
Resource properties
An Add-on Result resource is represented by the following properties:
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that that we created to identify the Recording AddOnResult resource. |
account_sid
|
The SID of the Account that created the Recording AddOnResult resource. |
status
|
The status of the result. Can be: |
add_on_sid
|
The SID of the Add-on to which the result belongs. |
add_on_configuration_sid
|
The SID of the Add-on configuration. |
date_created
|
The date and time in GMT that the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
date_completed
|
The date and time in GMT that the result was completed specified in RFC 2822 format. |
reference_sid
|
The SID of the recording to which the AddOnResult resource belongs. |
subresource_uris
|
A list of related resources identified by their relative URIs. |
subresource_uris contains the following properties :
| Property | Description |
|---|---|
| payloads | URL pointing to the Payload sub-resource |
HTTP GET
Returns a single instance of an Add-on Result associated with the given parent resource.
HTTP POST
Unsupported.
HTTP DELETE
Deleting the Add-on Result will delete the result record and purge all associated Payloads. Successful responses will return no content.
Add-on Results List subresource
The Add-on Results list subresource represents the set of results from Add-ons invoked on a specific recording.
Subresource URI
/AddOnResults/
Resource properties
The Add-on Results list subresource is represented by the following properties:
| Property | Description |
|---|---|
| add_on_results | List of Add-on Result Instances |
HTTP GET
Returns a list of Add-on Result instances associated with the given parent resource.
HTTP POST
Unsupported.
HTTP DELETE
Unsupported.
Add-on Result Payload instance subresource
The Add-on Results Payload subresource exposes the multiple types of Payloads that may be included in an Add-on Result.
Subresource URI
/AddOnResults/{RequestSid}/Payloads/{PayloadSid}
Resource properties
An Add-on Results Payload resource is represented by the following properties:
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that that we created to identify the Recording AddOnResult Payload resource. |
add_on_result_sid
|
The SID of the AddOnResult to which the payload belongs. |
account_sid
|
The SID of the Account that created the Recording AddOnResult Payload resource. |
label
|
The string provided by the vendor that describes the payload. |
add_on_sid
|
The SID of the Add-on to which the result belongs. |
add_on_configuration_sid
|
The SID of the Add-on configuration. |
content_type
|
The MIME type of the payload. |
date_created
|
The date and time in GMT that the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
reference_sid
|
The SID of the recording to which the AddOnResult resource that contains the payload belongs. |
subresource_uris
|
A list of related resources identified by their relative URIs. |
subresource_uris contains the following properties :
| Property | Description |
|---|---|
| data | URL pointing to the Data sub-resource |
HTTP GET
Returns a single instance of a Payload associated with the given Add-on Result.
Add-on Result Payloads List subresource
The Add-on Results Payload List subresource exposes the multiple types of Payloads that may be in included in an Add-on Result.
Subresource URI
/AddOnResults/{RequestSid}/Payloads
Resource properties
The Add-on Result Payloads list subresource is represented by the following properties:
| Property | Description |
|---|---|
| payloads | List of Add-on Result Payload Instances |
HTTP GET
Returns a list of Payload resource instances describing the data returned by Vendors as part of the Add-on Result.
Add-on Result Payload Data subresource
The Payload Data subresource hosts the actual data returned by the Add-on. GET requests issued to this subresource will receive a 307 redirect to a signed URL to the Payload. Clients will need to follow the redirect to receive the data associated with a Payload resource.
Subresource URI
/AddOnResults/{RequestSid}/Payloads/{PayloadSid}/Data
HTTP GET
Returns a 307 redirect to a signed URL to the Payload.
Example
GET /2010-04-01/Accounts/AC...../Recordings/RE.../AddOnResults/XR000.../Payloads/XH000.../Data
HTTP/1.1 307
Server: nginx
Date: Tue, 08 Nov 2016 22:43:19 GMT
Location: {SignedUrl}
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
