Edit

Share via

segment resource type

  • Article

Namespace: microsoft.graph.callRecords

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a portion of a User-User communication or a User-Meeting communication in the case of a Conference call. A typical VOIP call has one segment per session. In certain scenarios, such as PSTN calls, there are multiple segments per session due to additional server-to-server communication required to connect the call.

Methods

No methods exist to directly access segments. Use the Get callRecord API with $expand=sessions($expand=segments) or the List session API with $expand=segments to get the segments for a callRecord.

Properties

Property Type Description
id String Unique identifier for the segment. Read-only.
caller microsoft.graph.callRecords.endpoint Endpoint that initiated this segment.
callee microsoft.graph.callRecords.endpoint Endpoint that answered this segment.
failureInfo microsoft.graph.callRecords.failureInfo Failure information associated with the segment if it failed.
media microsoft.graph.callRecords.media collection Media associated with this segment.
startDateTime DateTimeOffset UTC time when the segment started. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
endDateTime DateTimeOffset UTC time when the segment ended. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Relationships

None

JSON representation

The following JSON representation shows the resource type.

{
  "id": "String (identifier)",
  "caller": {"@odata.type": "microsoft.graph.callRecords.endpoint"},
  "callee": {"@odata.type": "microsoft.graph.callRecords.endpoint"},
  "failureInfo": {"@odata.type": "microsoft.graph.callRecords.failureInfo"},
  "media": [{"@odata.type": "microsoft.graph.callRecords.media"}],
  "startDateTime": "String (timestamp)",
  "endDateTime": "String (timestamp)"
}