Add-on Results API
Add-on Results API allows you to list and retrieve Add-on results.
Currently, the API only provides results for Recording Analysis Add-ons and the data is persisted for 30 days.
Recording Analysis Add-on Results
Add-on results live as a subresource under the integration point that the Add-on was configured with. For Recordings, this is under the Recording resource.
/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/AddOnResults/
These sub-resources require HTTP basic auth to access using your AccountSid and Authentication 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 Sub-Resource
The Add-on Result instance sub-resource 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:
| Names in PHP format | |
|---|---|
sid
|
The unique string that that we created to identify the Recording AddOnResult resource. |
accountSid
|
The SID of the Account that created the Recording AddOnResult resource. |
status
|
The status of the result. Can be: |
addOnSid
|
The SID of the Add-on to which the result belongs. |
addOnConfigurationSid
|
The SID of the Add-on configuration. |
dateCreated
|
The date and time in GMT that the resource was created specified in RFC 2822 format. |
dateUpdated
|
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
dateCompleted
|
The date and time in GMT that the result was completed specified in RFC 2822 format. |
referenceSid
|
The SID of the recording to which the AddOnResult resource belongs. |
subresourceUris
|
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 at the Add-on Result resource will delete the result record and purge all associated Payloads. Successful responses will return no content.
Add-on Results List Sub-resource
The Add-on Results list sub-resource represents the set of results from Add-ons invoked on a specific Recording.
Sub-Resource URI
/AddOnResults/
Resource Properties
The Add-on Results list sub-resource 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 in included in an Add-on Result.
Sub-Resource URI
/AddOnResults/{RequestSid}/Payloads/{PayloadSid}
Resource Properties
An Add-on Results Payload resource is represented by the following properties:
| Names in PHP format | |
|---|---|
sid
|
The unique string that that we created to identify the Recording AddOnResult Payload resource. |
addOnResultSid
|
The SID of the AddOnResult to which the payload belongs. |
accountSid
|
The SID of the Account that created the Recording AddOnResult Payload resource. |
label
|
The string provided by the vendor that describes the payload. |
addOnSid
|
The SID of the Add-on to which the result belongs. |
addOnConfigurationSid
|
The SID of the Add-on configuration. |
contentType
|
The MIME type of the payload. |
dateCreated
|
The date and time in GMT that the resource was created specified in RFC 2822 format. |
dateUpdated
|
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
referenceSid
|
The SID of the recording to which the AddOnResult resource that contains the payload belongs. |
subresourceUris
|
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.
Sub-Resource URI
/AddOnResults/{RequestSid}/Payloads
Resource Properties
The Add-on Result Payloads list sub-resource 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. GETs 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.
Sub-Resource 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 browsing the Twilio tag on Stack Overflow.