Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Stream Resource


A Stream is a pub-sub primitive that lets you broadcast JSON messages at a high rate to an elastic group of subscribers.

  • Messages are ephemeral - they can be published (created), but they cannot be queried, updated or deleted
  • The maximum Message payload size as serialized JSON is 4KB.
  • The maximum Message publishing rate per Stream is 30 per second.
  • Message delivery to remote endpoints is not guaranteed.
  • Messages may be received by remote endpoints in a different order than they were published.

See also Stream Message for information about the messages in a stream.


Sync Stream properties

sync-stream-properties page anchor
Property nameTypePIIDescription
sidSID<TO>
Not PII

The unique string that we created to identify the Sync Stream resource.

Pattern: ^TO[0-9a-fA-F]{32}$Min length: 34Max length: 34

unique_namestring
PII MTL: 30 days

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.


account_sidSID<AC>

The SID of the Account that created the Sync Stream resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

service_sidSID<IS>

The SID of the Sync Service the resource is associated with.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

urlstring<uri>

The absolute URL of the Message Stream resource.


linksobject<uri-map>

The URLs of the Stream's nested resources.


date_expiresstring<date-time>

The date and time in GMT when the Message Stream expires and will be deleted, specified in ISO 8601(link takes you to an external page) format. If the Message Stream does not expire, this value is null. The Stream might not be deleted immediately after it expires.


date_createdstring<date-time>

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.


date_updatedstring<date-time>

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.


created_bystring

The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's identity field. If the Stream was created from the REST API, the value is 'system'.


Create a Sync Stream resource

create-a-sync-stream-resource page anchor
POST https://sync.twilio.com/v1/Services/{ServiceSid}/Streams

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
ServiceSidstringrequired

The SID of the Sync Service to create the new Stream in.

Property nameTypeRequiredPIIDescription
UniqueNamestringOptional

An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The unique_name value can be used as an alternative to the sid in the URL path to address the resource.


TtlintegerOptional

How long, in seconds, before the Stream expires and is deleted (time-to-live).

Create a Sync Stream resource

create-a-sync-stream-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_14
// Download the helper library from https://www.twilio.com/docs/node/install
_14
import twilio from "twilio";
_14
_14
// Find your Account SID and Auth Token at twilio.com/console
_14
// and set the environment variables. See http://twil.io/secure
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = twilio(accountSid, authToken);
_14
_14
const syncStream = await client.sync.v1
_14
.services("ServiceSid")
_14
.syncStreams.create();
_14
_14
console.log(syncStream.sid);

Output

_14
{
_14
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"created_by": "created_by",
_14
"date_expires": "2015-07-30T21:00:00Z",
_14
"date_created": "2015-07-30T20:00:00Z",
_14
"date_updated": "2015-07-30T20:00:00Z",
_14
"links": {
_14
"messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages"
_14
},
_14
"service_sid": "ServiceSid",
_14
"sid": "TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"unique_name": "unique_name",
_14
"url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_14
}


Fetch a Sync Stream resource

fetch-a-sync-stream-resource page anchor
GET https://sync.twilio.com/v1/Services/{ServiceSid}/Streams/{Sid}

Property nameTypeRequiredPIIDescription
ServiceSidstringrequired

The SID of the Sync Service with the Sync Stream resource to fetch.


Sidstringrequired

The SID of the Stream resource to fetch.

Fetch a Sync Stream resource

fetch-a-sync-stream-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_15
// Download the helper library from https://www.twilio.com/docs/node/install
_15
import twilio from "twilio";
_15
_15
// Find your Account SID and Auth Token at twilio.com/console
_15
// and set the environment variables. See http://twil.io/secure
_15
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_15
const authToken = process.env.TWILIO_AUTH_TOKEN;
_15
const client = twilio(accountSid, authToken);
_15
_15
const syncStream = await client.sync.v1
_15
.services("ServiceSid")
_15
.syncStreams("Sid")
_15
.fetch();
_15
_15
console.log(syncStream.sid);

Output

_14
{
_14
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"created_by": "created_by",
_14
"date_expires": "2015-07-30T21:00:00Z",
_14
"date_created": "2015-07-30T20:00:00Z",
_14
"date_updated": "2015-07-30T20:00:00Z",
_14
"links": {
_14
"messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages"
_14
},
_14
"service_sid": "ServiceSid",
_14
"sid": "Sid",
_14
"unique_name": "unique_name",
_14
"url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_14
}


Read multiple Sync Stream resources

read-multiple-sync-stream-resources page anchor
GET https://sync.twilio.com/v1/Services/{ServiceSid}/Streams

Note: Without a PageSize query parameter, this will return only the first 50 Message Streams. Add a PageSize query parameter to fetch up to 100 items at once. The example has a PageSize value of 20.

See paging for more information.

Property nameTypeRequiredPIIDescription
ServiceSidstringrequired

The SID of the Sync Service with the Stream resources to read.

Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read multiple Sync Stream resources

read-multiple-sync-stream-resources-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_14
// Download the helper library from https://www.twilio.com/docs/node/install
_14
import twilio from "twilio";
_14
_14
// Find your Account SID and Auth Token at twilio.com/console
_14
// and set the environment variables. See http://twil.io/secure
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = twilio(accountSid, authToken);
_14
_14
const syncStreams = await client.sync.v1
_14
.services("ServiceSid")
_14
.syncStreams.list({ limit: 20 });
_14
_14
syncStreams.forEach((s) => console.log(s.sid));

Output

_12
{
_12
"streams": [],
_12
"meta": {
_12
"first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0",
_12
"key": "streams",
_12
"next_page_url": null,
_12
"page": 0,
_12
"page_size": 50,
_12
"previous_page_url": null,
_12
"url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams?PageSize=50&Page=0"
_12
}
_12
}


Update a Sync Stream resource

update-a-sync-stream-resource page anchor
POST https://sync.twilio.com/v1/Services/{ServiceSid}/Streams/{Sid}

Property nameTypeRequiredPIIDescription
ServiceSidstringrequired

The SID of the Sync Service with the Sync Stream resource to update.


Sidstringrequired

The SID of the Stream resource to update.

Property nameTypeRequiredPIIDescription
TtlintegerOptional

How long, in seconds, before the Stream expires and is deleted (time-to-live).

Update a Sync Stream resource

update-a-sync-stream-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_15
// Download the helper library from https://www.twilio.com/docs/node/install
_15
import twilio from "twilio";
_15
_15
// Find your Account SID and Auth Token at twilio.com/console
_15
// and set the environment variables. See http://twil.io/secure
_15
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_15
const authToken = process.env.TWILIO_AUTH_TOKEN;
_15
const client = twilio(accountSid, authToken);
_15
_15
const syncStream = await client.sync.v1
_15
.services("ServiceSid")
_15
.syncStreams("Sid")
_15
.update({ ttl: 600 });
_15
_15
console.log(syncStream.sid);

Output

_14
{
_14
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"created_by": "created_by",
_14
"date_expires": "2015-07-30T21:00:00Z",
_14
"date_created": "2015-07-30T20:00:00Z",
_14
"date_updated": "2015-07-30T20:00:00Z",
_14
"links": {
_14
"messages": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages"
_14
},
_14
"service_sid": "ServiceSid",
_14
"sid": "Sid",
_14
"unique_name": "unique_name",
_14
"url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams/TOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_14
}


Delete a Sync Stream resource

delete-a-sync-stream-resource page anchor
DELETE https://sync.twilio.com/v1/Services/{ServiceSid}/Streams/{Sid}

Property nameTypeRequiredPIIDescription
ServiceSidstringrequired

The SID of the Sync Service with the Sync Stream resource to delete.


Sidstringrequired

The SID of the Stream resource to delete.

Delete a Sync Stream resource

delete-a-sync-stream-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
import twilio from "twilio";
_10
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = twilio(accountSid, authToken);
_10
_10
await client.sync.v1.services("ServiceSid").syncStreams("Sid").remove();


Rate this page: