CreateSupportSession

Allows a customer support representative (CSR) to create a Support
Session.

Request

The sample XML document shows an example of a request to create a new Support Session.

<?xml version="1.0" encoding="UTF-8"?> <serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>
            <siteID>0000</siteID>
            <partnerID>9999</partnerID>
            <email>johnsmith@xyz.com</email>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type=
            "java:com.webex.service.binding.supportsession.CreateSupportSession">
            <metaData>
                <sessionType>13</sessionType>
            </metaData>
            <tracking>
                <trackingCode1>trackingCode1</trackingCode1>
                <trackingCode2>trackingCode2</trackingCode2>
                <trackingCode3>trackingCode3</trackingCode3>
                <trackingCode4>trackingCode4</trackingCode4>
                <trackingCode5>trackingCode5</trackingCode5>
                <trackingCode6>trackingCode6</trackingCode6>
                <trackingCode7>trackingCode7</trackingCode7>
                <trackingCode8>trackingCode8</trackingCode8>
                <trackingCode9>trackingCode9</trackingCode9>
                <trackingCode10>trackingCode10</trackingCode10>
            </tracking>
        </bodyContent>
    </body>
</serv:message>

The following schema diagram shows the structure of the elements in the createSupportSession request message.

Collapse Figure 8-1 • Schema diagram of `createSupportSession`
Drilldown into tracking Drilldown into metaData Drilldown into bodyContentType Drilldown into supportTypeXSD Diagram of createSupportSession

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non global elements, refer to Elements in WebEx XML Schema Definitions for the Support Session Service.

Response

The sample XML document shows an example of a possible response to the preceding request document.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xmlns:com="http://www.webex.com/schemas/2002/06/common"
    xmlns:sc="http://www.webex.com/schemas/2002/06/service/supportsession">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="sc:createSupportSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <sc:sessionKey>11916961</sc:sessionKey>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The following schema diagram shows the structure of the elements in the createSupportSessionResponse message.

Collapse Figure 8-2 • Schema diagram for `createSupportSessionResponse`
Drilldown into sessionKey Drilldown into bodyContentTypeXSD Diagram of createSupportSessionResponse

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.