This documentation is archived and is not being maintained.

Create and Enable a Proxy Endpoint

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

When a PBX/PSTN telephone network is bridged into the Unified Communications network and configured to work with the Microsoft Office Communications Server system deployment, Unified Communications Client API can let users control a user's telephone represented as a proxy endpoint. Because a user may have been assigned multiple telephone numbers, a single principal endpoint can have multiple proxy endpoints added to its control. For more information about telephony, see Managing Telephone Calls.

To add a proxy endpoint to control a telephone, the client must first create an IUccEndpoint object of the UCC_ENDPOINT_TYPE.UCCET_PROXY_TELEPHONY type and then enable the proxy by calling the Enable method on the proxy endpoint. This process is similar to creating and enabling the principal endpoint under which the proxy is controlled except for following:

  • A proxy endpoint is created by calling the CreateProxyEndpoint method on a UccPlatform instance.
  • The controlling principal endpoint must be already enabled and specified in the call to create the proxy endpoint.
  • A proxy endpoint is identified by a SIP URI as well as a TEL URI that serves as the ID of the proxy endpoint.
  • A proxy endpoint will not raise any events defined in _IUccServerSignalingSettingsEvents. Advising a proxy endpoint for these events is not necessary.

The SIP URI of a proxy endpoint has the following format: "sip:<id>@<server>.<domain>", where <id> is the device identifier, which can be a telephone number assigned to the user. <server> is the name of the gateway server for the underlying PBX/PSTN network. <domain> is the network domain to which the gateway server belongs. An example of SIP URI of a proxy endpoint is "sip:+14255550100@PbxServer.contoso.com"

The TEL URI has the following formats: "tel:+<GlobalPhoneNumber>" and "tel:<extension>;phone-context=<SomeContext>", where <GlobalPhoneNumber> is a normalized global telephone number, <extension> is a local PBX extension and <SomeContext> specifies a phone context value which may be obtained from in-band provisioning from Office Communications Server. An example of the TEL URI of a proxy endpoint is "tel:+14255550100" or "tel:50100;phone-context=AB32-cdp.AB32-udp".

Once created, the proxy endpoint must be enabled after it is advised of an implementation of the _IUccEndpointEvents interface. This event handler must be equipped to handle the events raised by the proxy endpoint to notify the client of the completion of the enabling process as well as the disabling process mentioned later in this topic.

For a code example, see Code Listing: Programming Endpoint Object in C#.

Removing an enabled proxy endpoint amounts to relinquishing the control of the telephone by a Unified Communications Client API client. This involves disabling the proxy endpoint and canceling any advised event handler. The programming pattern is similar to disabling a principal endpoint. Call Disable on the proxy endpoint to disable it. For a code example, see Code Listing: Programming Endpoint Object in C#.

Show: