How to Use Marketplace Listings

Installing a No-code Partner Listing makes it available to configure and use on the Listing publisher's platform. To install, follow these steps:

1. Navigate to the Marketplace Catalog in Twilio Console and choose a No-code Partner Listing.
2. Select the Install button on the Listing details page.
3. Accept the Listing publisher's Terms of Service and Privacy Policy.

After installation, the Configure tab becomes selectable from the Listing details page. To access the Listing details, visit the Installed Modules page in Console and select the Listing.

The Configure tab details what next step you'll need to take with the Listing publisher. Select the button under the tab to complete the onboarding process on the publisher's platform.

Installing an Add-on Listing makes it available to configure and use on your Twilio Account. To install, follow these steps:

1. Navigate to the Marketplace Catalog in Twilio Console and choose an Add-on Listing.
2. Select the Install button on the Listing details page.
3. Accept the Listing publisher's Terms of Service and Privacy Policy.

After installation, the Configure tab becomes selectable from the Listing details page. To access the Listing details, visit the Installed Modules page in Console and select the Listing.

In the Configure tab, you can set up the Listing for integration with your Twilio products. This involves selecting the appropriate usage points and providing any additional configuration details required by the Listing. The table below details some of the configuration fields you can expect to see:

The Configure tab also includes an Add Another Instance button. This feature allows you to add more instances of the same Add-on Listing, each with different configuration parameters. This can be useful in scenarios where you need different configurations of the same Listing, such as text analysis in various languages.

For more information about the supported Twilio Products and configuration parameters of a specific Listing, please refer to the Documentation tab on its Listing details page.

Once you've installed and set up your Listing, its invocation depends on the Twilio product you're integrating it with. The following table outlines how the usage of an Add-on Listing is triggered based on the specific Twilio product its being used in:

The results from an Add-on Listing are delivered as a JSON object through the API of the Twilio product that the Listing is integrated with.

Listings that return results synchronously have the following development considerations:

• SLA/Latency: Requests taking longer than 2000 ms are failed by Twilio and an error payload is sent. The developer is not billed.
• Size limit: Listing result responses larger than 64 KB are failed by Twilio and an error payload is sent. The developer is not billed.

Synchronous results are returned immediately as a JSON object by the relevant Twilio API.

1
{
2
  "status": "successful",
3
  "message": null,
4
  "code": null,
5
  "results": {
6
    "provider1_phone_reputation": {
7
      "request_sid": "XRc1479687aadf64c62e6ab2b6e0077a1a",
8
      "status": "successful",
9
      "message": null,
10
      "code": null,
11
      "result": {
12
        ...
13
      }
14
    }, 
15
    "provider6_sentiment": {
16
      "request_sid": "XRb32a3b72dde3bb78af4d34416d4f14dc",
17
      "status": "successful",
18
      "message": null,
19
      "code": null,
20
      "result": {
21
        ...
22
        }
23
      }
24
    }
25
  }

The following tables detail the JSON object structure of the synchronous results response.

Add-ons that return results asynchronously have the following development considerations:

• SLA/Latency: Results should be returned in a median time of three times of the audio duration and 99% under five times of the duration. Any request taking longer than ten times of the duration is failed by Twilio and an error payload is sent. The developer is not billed.
• Size limit: Result responses larger than 100 MB are failed by Twilio and an error payload is sent. The developer is not billed.
• Retention period: Results are only available to retrieve for 30 days. They can be accessed using the Add-on Results API.

When an Add-on Listing's results are ready, they are sent as a JSON object to the callback URL that was specified during the Listing's setup. The example below illustrates the structure of the nested JSON object that is included within the AddOns key of the callback.

1
{
2
    "status": "successful",
3
    "message": null,
4
    "code": null,
5
    "results": {
6
      "speech_to_text_addon": {
7
        "request_sid": "XR7b57f17eeae56053f034a8a819577e89",
8
        "status": "successful",
9
        "message": null,
10
        "code": null,
11
        "payload": [ 
12
          {
13
            "content_type":"application/json", 
14
            "url":"https://api.twilio.com/2010-04-01/Accounts/AC05bxxx/Recordings/RE557cxxx/AddOnResults/XR7b57f17eeae56053f034a8a819577e89/Payloads/XH000001/Data"
15
          },
16
          {
17
            "content_type":"audio/wav", 
18
            "url":"https://api.twilio.com/2010-04-01/Accounts/AC05bxxx/Recordings/RE557cxxx/AddOnResults/XR7b57f17eeae56053f034a8a819577e89/Payloads/XH000002/Data"
19
          } 
20
        ],
21
        "links": {
22
          "add_on_result": "https://api.twilio.com/2010-04-01/Accounts/AC05bxxx/Recordings/RE557cxxx/AddOnResults/XR7b57f17eeae56053f034a8a819577e89",
23
          "payloads": "https://api.twilio.com/2010-04-01/Accounts/AC05bxxx/Recordings/RE557cxxx/AddOnResults/XR7b57f17eeae56053f034a8a819577e89/Payloads",
24
          "recording": "https://api.twilio.com/2010-04-01/Accounts/AC05bxxx/Recordings/RE557cxxx"
25
        }
26
      }
27
    }
28
}

The following tables detail the JSON object structure of the asynchronous results response.