2.2.2 application/msrtc-reporterror+xml Report Error Document Format

  • Article

This protocol supports reporting an error to the SIP server. The primitives are defined as an XML element that is sent to the SIP server by means of a SERVICE request. This protocol supports the following primitives:

reportError: The reportError primitive is used for reporting an error. It contains the error element.

error: Error details. This element contains the following attributes and elements:

  • fromUri: This attribute contains the From URI of the SIP request that failed; optional. If this attribute is not set, then the From URI of the service request that carrying this error report will be used.

  • toUri: This attribute contains the To URI of the SIP request that failed; optional.

  • callId: This attribute contains the Call-ID of the SIP request that failed; required.

  • fromTag: The attribute contains the From tag of the SIP request that failed; optional.

  • toTag: This attribute contains the To tag of the SIP request that failed; optional.

  • requestType: This attribute contains the Method name of the SIP request that failed; required. For example, this SIP request could be an INVITE or SERVICE. MUST NOT be longer than 33 characters.

  • contentType: This attribute contains the Content-Type header of the SIP request that failed; optional. MUST NOT be longer than 257 characters.

  • responseCode: This attribute contains the SIP response code received from the SIP server for the SIP request; required. MUST be within the unsigned integer range.

  • diagHeader: This element is the ms-diagnostics header (section 2.2.1.1) of the SIP response received from the SIP server for the SIP request; optional. MUST NOT be longer than 65,535 characters.

  • progressReports: This element is the list of progress report; required. It contains the following elements:

    • progressReport: This element is a progress report; optional. It contains the following element:

      • diagHeader: This element is an ms-diagnostics header from the SIP progress response that is sent by the SIP server while processing the original SIP request; required. MUST NOT be longer than 65,535 characters.

Total length of fromUri of the SIP request, toUri, callId, fromTag, and toTag MUST NOT be longer than 669 characters.

The following example is a report error document data.

<reportError xmlns="http://schemas.microsoft.com/2006/09/sip/error-reporting">
    <error toUri="sip:user@contoso.com"  
           callId="5ec5a21ab8bb4960b98de162f45cd204"
           fromTag="823bb11e1a"  
           toTag="4F230FC472C24AD1255468D8C334D8FE"
           contentType="application/sdp;call-type=audiovideo"
           responseCode="408"
           requestType="INVITE">
        <diagHeader>10000;reason="Gateway returned a SIP failure code"
        </diagHeader>
        <progressReports>
            <progressReport>
                <diagHeader>12006;reason="Trying next hop";appName="OutboundRouting" 
                </diagHeader>
            </progressReport>
        </progressReports>
    </error>
</reportError>