Skip to main content

Media Stream Started

This event may be sent to the url specified when sending a <StartStream> verb.

Request Parameters

accountIdThe user account associated with the call.
answerTimeTime the call was answered, in ISO 8601 format.
applicationIdThe id of the application associated with the call.
callIdThe call id associated with the event.
callUrlThe URL of the call associated with the event.
directionThe direction of the call. Either inbound or outbound. The direction of a call never changes.
enqueuedTime(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
eventTimeThe approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
eventTypeThe event type, value is mediaStreamStarted
fromThe provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
mediaStreamDetails about the stream that was started
mediaStream.destinationThe destination URL to which the stream is sending media
mediaStream.idThe unique id of the stream
mediaStream.nameThe name of this stream. If the name attribute was specified in the StartStream verb, then this will be the value of that attribute, otherwise it will default to the stream id.
mediaStream.startTimeThe approximate UTC date and time the stream was started
mediaStream.tracksThe segments of the call that are being sent in the stream, values will be one or both of inbound and outbound
mediaStream.typeThe type of stream being sent. Currently the only supported type is WebSocket
startTimeTime the call was started, in ISO 8601 format.
toThe phone number that received the call, in E.164 format (e.g. +15555555555).
tag(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.

Expected Response

HTTP/1.1 204


Media Stream Started Event with Enqueued Time

POST http://myapp.example/mediaStreamEvents
Content-Type: application/json

"accountId" : "55555555",
"answerTime" : "2022-06-30T18:55:02.080Z",
"applicationId" : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
"callId" : "c-95ac912f-68aacdd7-4a8e-4223-a7fd-020e02fa6bf2",
"callUrl" : "",
"direction" : "outbound",
"enqueuedTime" : "2022-06-30T18:54:59.172Z",
"eventTime" : "2022-06-30T18:55:02.489Z",
"eventType" : "mediaStreamStarted",
"from" : "+15551112222",
"mediaStream" : {
"destination" : "wss://websocket.myapp.example",
"id" : "s-95ac90b3-bfc81595-35fc-4b64-8265-fab6855b74a2",
"name" : "example_stream",
"startTime" : "2022-06-30T18:55:02.489Z",
"tracks" : ["inbound", "outbound"],
"type" : "WebSocket"
"startTime" : "2022-06-30T18:54:59.175Z",
"to" : "+15553334444"