Export (0) Print
Expand All
Expand Minimize

2.2.3.18 addUser Dial-in Response Document

Office

In addition to the syntax rules given in section 2.2.1 for C3P responses, the following additional rules apply.

conferenceKeys: This element MUST have the same values as those specified in the corresponding addUser request.

The following rules apply to the user element:

  • Exactly one user element MUST be present inside the addUser body.

  • The user element MUST have the same entity attribute specified in the addUser request.

  • The roles element SHOULD be populated from the corresponding request.

The following rules apply to the endpoint element:

  • Zero or one endpoint element SHOULD be present inside the user element.

  • The endpoint element MUST specify a valid entity attribute. It MUST be the same as the one present in the corresponding request.

  • The endpoint-uri attribute can be specified. If specified, it MUST be a "sip:" URI or a "tel:" URI.

  • The joining-method element MUST be populated with the value "dialed-in".

The following rules apply to the connection-info element:

  • Zero or more entry subelements SHOULD be present inside the connection-info element.

  • Each entry element specifies a key-value property pair.

The following well-known keys are defined by this protocol. Their usage is discussed in section 3. They are case-insensitive.

  • Mcu-Server-Uri: Specifies a SIP URI that can be used to send requests to this MCU. This SIP URI SHOULD be constructed in such a way that it can be used as the remote-target URI of SIP requests, as defined in [RFC3261] section 12.2.1.1.

  • Mcu-Conference-Uri: Specifies the MCU-Conference-URI defined earlier.

The following well-known keys are defined by this protocol specifically for the Web Conferencing MCU. They are case-sensitive. For additional details about Web Conferencing MCU-specific concepts, see [MS-PSOM].

  • sAuthId: An xs:string value composed of decimal digits and the letters "A", "B", "C", "D", "E", and "F". The Web Conferencing MCU MUST send this value, and it MUST be uniquely generated so that it is not duplicated in any other addUser dial-in response.

  • pwrpc.modes: An xs:string value of either "tls" or "fwdtls". The Web Conferencing MCU MUST send this value to the client.

  • pwrpc.port: An xs:string value containing a decimal string indicating the port number that the client can use to establish a PSOM connection to the Web Conferencing MCU. The Web Conferencing MCU MUST send this key to the client.

  • pwrpc.authPattern: An xs:string value that indicates the authentication mechanism supported by the Web Conferencing server. This MUST be set to the string "<sAuthId>".

  • numberOfProxies: An xs:string value containing a decimal string indicating how many proxy servers are being communicated from the Web Conferencing MCU to the client. This value is used by the client to look for specific keys of the form "proxy[N].FQDN" and proxy[N].Port. The Web Conferencing MCU MUST send this key to the client if it also sent the pwrpc.modes key with a value of "fwdtls".

  • proxy[N].FQDN: Any key with a name of the form "proxy[N].FQDN", where N is a normalized decimal string less than the value of the numberOfProxies key sent to the client, and greater than or equal to zero. Any key of this form has an xs:string value indicating the fully qualified domain name (FQDN) (1) of a proxy server capable of establishing a PSOM connection to the Web Conferencing MCU on behalf of the client. The Web Conferencing MCU MUST send a key of this form for every value of N from zero up to, but not including, the value of the numberOfProxies key.

  • proxy[N].Port: Any key with a name of the form "proxy[N].Port" where N is a normalized decimal string less than the value of the numberOfProxies key sent to the client, and greater than or equal to zero. Any key of this form has an xs:string value containing a decimal string indicating the port number of a proxy server capable of establishing a PSOM connection to the Web Conferencing MCU on behalf of the client. The Web Conferencing MCU MUST send a key of this form for every value of N from zero up to, but not including, the value of the numberOfProxies key.

  • pwrpc.pwsURI: An xs:string value containing a URI for the Web Conferencing MCU that the client can use to establish a PSOM connection. The Web Conferencing MCU MUST send this key to the client if it also sent the pwrpc.modes key with a value of "tls".

  • alternativeName: An xs:string value that can be used in place of the X.509 certificate subject for TLS negotiation. If the Web Conferencing MCU has sent the pwrpc.modes key with a value of "fwdtls", the client MUST ignore this value. Otherwise, the Web Conferencing MCU MUST send this key, and the client MUST establish TLS negotiation using this value as the certificate subject for verification.

Extensions to this specification can specify the semantics of other elements and attributes.

The following example is an addUser response document:

<addUser mcuUri="sip:alice@fabrikam.com;gruu;opaque=app:conf:chat:id:5D3747C">
  <conferenceKeys confEntity="sip:alice@fabrikam.com;gruu;opaque=app:conf:focus:id:5D3747C"/>
  <user entity="sip:cathy@fabrikam.com">
  <display-text>Cathy Baker</display-text>
    <roles>
      <entry>presenter</entry>
    </roles>
    <endpoint entity="{5CD3FC0A-05F7-4A17-A95B-430A28FC9EFA}" 
endpoint-uri="sip:cathy@fabrikam.com;opaque=user:epid:123;gruu">
      <joining-method>dialed-in</joining-method>
      <!-- other extension elements can follow -->
    </endpoint>
  </user>
  <connection-info>
    <entry>
      <key>Mcu-Server-Uri</key>
      <value>sip:mcu.domain.com:5061;transport=tls</value>
    </entry>
    <entry>
      <key>Mcu-Conference-Uri</key>
      <value> sip:alice@fabrikam.com;gruu;opaque=app:conf:chat:focus:id:5D3747C</value>
    </entry>
  </connection-info>
</addUser>
Show:
© 2014 Microsoft