API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webrtc

WebrtcSessions

WebRTC Call Handling

Creates voice and/or video session

POST/webrtc/sessions

Get the media session information

GET/webrtc/sessions/{mediaSessionId}

Cancel or Terminate the media session

DELETE/webrtc/sessions/{mediaSessionId}

Update the status of the media session

PUT/webrtc/sessions/{mediaSessionId}/status

ModelsExpand Collapse

MediaSessionInformation object { answer, callType, locationDetails, 7 more }

answer: optional SdpDescriptor { sdp }

OFFER: An inlined session description in SDP format [RFC4566].If XML syntax is used, the content of this element SHALL be embedded in a CDATA section.

ANSWER: This type represents an answer in WebRTC Signaling. This element is not present in case there is no answer yet, or the session invitation has been declined by the Terminating Participant.This element MUST NOT be present in a request from the application to the server to create a session.

sdp: optional string

An inlined session description in SDP format [RFC4566].If XML syntax is used, the content of this element SHALL be embedded in a CDATA section

callType: optional "REGULAR" or "EMERGENCY"

Type of call. When set to EMERGENCY, the client MAY provide locationDetails. If omitted, treated as REGULAR.

One of the following:

"REGULAR"

"EMERGENCY"

locationDetails: optional WebRtcLocationDetails { confidence, coordinates, method, 2 more }

Details about the caller’s location and related information. This object adheres to 3GPP TS 24.229, RFC 4119, RFC 5139, and RFC 5491 for PIDF-LO compatibility.

confidence: optional object { pdf, value }

The confidence level of the location information.

pdf: optional "normal" or "uniform"

The probability density function (PDF) associated with the confidence value.

One of the following:

"normal"

"uniform"

value: optional number

The confidence value (percentage).

minimum0

maximum100

coordinates: optional WebRtcCircleCoordinates { latitude, longitude, radius } or WebRtcEllipsoidCoordinates { latitude, longitude, orientation, 4 more }

The coordinates of the caller’s location, specific to the chosen shape.

One of the following:

WebRtcCircleCoordinates object { latitude, longitude, radius }

latitude: number

Latitude of the center point in decimal degrees (WGS84).

formatfloat

longitude: number

Longitude of the center point in decimal degrees (WGS84).

formatfloat

radius: number

Radius of the circle in meters, indicating the uncertainty.

formatfloat

WebRtcEllipsoidCoordinates object { latitude, longitude, orientation, 4 more }

latitude: number

Latitude in the WGS 84 geocentric coordinate system.

formatfloat

longitude: number

Longitude in the WGS 84 geocentric coordinate system.

formatfloat

orientation: number

Orientation of the ellipsoid in degrees.

semiMajorAxis: number

Length of the semi-major axis of the ellipsoid in meters.

semiMinorAxis: number

Length of the semi-minor axis of the ellipsoid in meters.

verticalAxis: number

Length of the vertical axis of the ellipsoid in meters.

zAxis: number

Altitude (optional) in the WGS 84 geocentric coordinate system.

formatfloat

method: optional "GPS" or "DBH" or "DBH_HELO" or "Other"

The method used to obtain the location information.

• GPS: Global Positioning System (highly accurate)
• DBH: Device-Based Hybrid
• DBH_HELO: Device-Based Hybrid using Apple Hybridized Emergency Location
• Other: Other methods (e.g., landmarks, IP Based etc.)

One of the following:

"GPS"

"DBH"

"DBH_HELO"

"Other"

shape: optional "Circle" or "Ellipsoid"

The shape representing the caller’s location (Circle or Ellipsoid).

One of the following:

"Circle"

"Ellipsoid"

timestamp: optional string

The timestamp (in ISO 8601 format) indicating when the location information was Calculated. \nThis is crucial for emergency services to assess the timeliness of the data. if not provided current timestamp will be used by default”

formatdate-time

mediaSessionId: optional string

The media session ID created by the network. The mediaSessionId shall not be included in POST requests by the client, but must be included in the notifications from the network to the client device.

offer: optional SdpDescriptor { sdp }

OFFER: An inlined session description in SDP format [RFC4566].If XML syntax is used, the content of this element SHALL be embedded in a CDATA section.

ANSWER: This type represents an answer in WebRTC Signaling. This element is not present in case there is no answer yet, or the session invitation has been declined by the Terminating Participant.This element MUST NOT be present in a request from the application to the server to create a session.

sdp: optional string

An inlined session description in SDP format [RFC4566].If XML syntax is used, the content of this element SHALL be embedded in a CDATA section

originatorAddress: optional string

Subscriber address (Sender or Receiver)

originatorName: optional string

Friendly name of the call originator

receiverAddress: optional string

Subscriber address (Sender or Receiver)

receiverName: optional string

Friendly name of the call terminator

status: optional "Initial" or "InProgress" or "Ringing" or 12 more

Provides the status of the media session. During the session creation, this attribute SHALL NOT be included in the request.

One of the following:

"Initial"

"InProgress"

"Ringing"

"Proceeding"

"Connected"

"Terminated"

"Hold"

"Resume"

"SessionCancelled"

"Declined"

"Failed"

"Waiting"

"NoAnswer"

"NotReachable"

"Busy"

SdpDescriptor object { sdp }

OFFER: An inlined session description in SDP format [RFC4566].If XML syntax is used, the content of this element SHALL be embedded in a CDATA section.

ANSWER: This type represents an answer in WebRTC Signaling. This element is not present in case there is no answer yet, or the session invitation has been declined by the Terminating Participant.This element MUST NOT be present in a request from the application to the server to create a session.

sdp: optional string

An inlined session description in SDP format [RFC4566].If XML syntax is used, the content of this element SHALL be embedded in a CDATA section

WebRtcCircleCoordinates object { latitude, longitude, radius }

latitude: number

Latitude of the center point in decimal degrees (WGS84).

formatfloat

longitude: number

Longitude of the center point in decimal degrees (WGS84).

formatfloat

radius: number

Radius of the circle in meters, indicating the uncertainty.

formatfloat

WebRtcEllipsoidCoordinates object { latitude, longitude, orientation, 4 more }

latitude: number

Latitude in the WGS 84 geocentric coordinate system.

formatfloat

longitude: number

Longitude in the WGS 84 geocentric coordinate system.

formatfloat

orientation: number

Orientation of the ellipsoid in degrees.

semiMajorAxis: number

Length of the semi-major axis of the ellipsoid in meters.

semiMinorAxis: number

Length of the semi-minor axis of the ellipsoid in meters.

verticalAxis: number

Length of the vertical axis of the ellipsoid in meters.

zAxis: number

Altitude (optional) in the WGS 84 geocentric coordinate system.

formatfloat

WebRtcLocationDetails object { confidence, coordinates, method, 2 more }

Details about the caller’s location and related information. This object adheres to 3GPP TS 24.229, RFC 4119, RFC 5139, and RFC 5491 for PIDF-LO compatibility.

confidence: optional object { pdf, value }

The confidence level of the location information.

pdf: optional "normal" or "uniform"

The probability density function (PDF) associated with the confidence value.

One of the following:

"normal"

"uniform"

value: optional number

The confidence value (percentage).

minimum0

maximum100

coordinates: optional WebRtcCircleCoordinates { latitude, longitude, radius } or WebRtcEllipsoidCoordinates { latitude, longitude, orientation, 4 more }

The coordinates of the caller’s location, specific to the chosen shape.

One of the following:

WebRtcCircleCoordinates object { latitude, longitude, radius }

latitude: number

Latitude of the center point in decimal degrees (WGS84).

formatfloat

longitude: number

Longitude of the center point in decimal degrees (WGS84).

formatfloat

radius: number

Radius of the circle in meters, indicating the uncertainty.

formatfloat

WebRtcEllipsoidCoordinates object { latitude, longitude, orientation, 4 more }

latitude: number

Latitude in the WGS 84 geocentric coordinate system.

formatfloat

longitude: number

Longitude in the WGS 84 geocentric coordinate system.

formatfloat

orientation: number

Orientation of the ellipsoid in degrees.

semiMajorAxis: number

Length of the semi-major axis of the ellipsoid in meters.

semiMinorAxis: number

Length of the semi-minor axis of the ellipsoid in meters.

verticalAxis: number

Length of the vertical axis of the ellipsoid in meters.

zAxis: number

Altitude (optional) in the WGS 84 geocentric coordinate system.

formatfloat

method: optional "GPS" or "DBH" or "DBH_HELO" or "Other"

The method used to obtain the location information.

• GPS: Global Positioning System (highly accurate)
• DBH: Device-Based Hybrid
• DBH_HELO: Device-Based Hybrid using Apple Hybridized Emergency Location
• Other: Other methods (e.g., landmarks, IP Based etc.)

One of the following:

"GPS"

"DBH"

"DBH_HELO"

"Other"

shape: optional "Circle" or "Ellipsoid"

The shape representing the caller’s location (Circle or Ellipsoid).

One of the following:

"Circle"

"Ellipsoid"

timestamp: optional string

The timestamp (in ISO 8601 format) indicating when the location information was Calculated. \nThis is crucial for emergency services to assess the timeliness of the data. if not provided current timestamp will be used by default”

formatdate-time