Menu

Expand
Rate this page:

Stream Message Resource

A Stream Message is a JSON message tht can be sent 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.

Stream Message properties

Resource Properties in REST API format
sid
sid<TZ> Not PII

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

data

An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4KB in length.

Create a Stream Message resource

post
https://sync.twilio.com/v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages

Publishes a new message to the Stream. The message contains an arbitrary JSON object that is serialized and percent-encoded as a POST parameter.

Parameters
Parameters in REST API format
service_sid
Path
post sid_like<IS> Not PII

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

stream_sid
Path
post sid_like<TO> Not PII

The SID of the Sync Stream to create the new Stream Message resource for.

data
Required
post object PII MTL: 0 DAYS

A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4KB in length.

Example 1
        
        
        
        
        Rate this page:

        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.

              
              
              

              Thank you for your feedback!

              We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more