Moving to Proxy Beta from Developer Preview

(new)

Public Beta

Twilio's Proxy API is currently available as a Public Beta product. Some features are not yet implemented and others may be changed before the product is declared as Generally Available.

Public Beta products are not covered by a Twilio SLA.

Proxy is available in beta. If you previously used the developer preview version of Proxy, you need to update your code to use the beta version.

There is no data migration between the preview version and the beta version. All objects must be created anew.

Changes from preview to beta

The largest sticking points to keep in mind when moving your application from developer preview to beta are the changed API base URL, SDK namespace, and the rename of friendly_name to unique_name.

Create a new Service using Proxy public beta

Via the API, the URL for Proxy changes.

Beta version

https://proxy.twilio.com/v1/Services

Preview version (old)

https://preview.twilio.com/Proxy/Services

In the SDKs, the pattern is to drop the preview reference in your code.

For example, in Node.js, the code for creating a Service changes from:

Node.js beta example

Create a Service (Node.js beta)

1client.proxy.services
2  .create({
3    uniqueName: 'My Awesome Service',
4    callbackUrl: 'https://www.example.com/',
5  })
6  .then(response => {
7    console.log(response);
8  })
9  .catch(err => {
10    console.log(err);
11  });

Node.js preview code (old)

Create a Service (Node.js preview)

1client.preview.proxy.services.create(
2
3   friendly_name: 'My Awesome Service',
4
5   callback_url: 'https://www.example.com/'
6
7)

NOTE: friendly_name is now unique_name. This is a required change in Proxy beta!
For examples in all six supported languages and cURL on how to make this change, refer to the quickstart guide.

Phone number migration

To add phone numbers to your new service, follow the steps in the updated quickstart guide. If you add phone numbers to the beta service currently attached to your developer preview service, they will move to be associated with the newly created service.

Proxy beta resource specific changes

The following tables list the resource-specific field changes you need to make when moving to beta.

Service

See the REST resource page for Proxy Service for descriptions of the new parameter features.

Old field	New field	Notes
FriendlyName	UniqueName	Must be a unique name per service.
	OutOfSessionCallbackUrl
	InterceptCallbackUrl
	GeoMatchLevel
	NumberSelectionBehavior
	DefaultTtl

Session

See the REST resource page for Proxy Session for descriptions of the new parameter features.

Old field	New field	Notes
StartTime	DateStarted
EndTime	DateEnded
	Mode
	DateLastInteraction
	ClosedReason

Interaction

See the REST resource page for Proxy Interaction for a description of Data.

Old field	New field	Notes
Description	Data

Participant

See the REST resource page for Proxy Participant for a description of DateDeleted.

Old field	New field	Notes
	DateDeleted