Zip Conferencing

Client Provision

Create the Company, Client and Reservation on the PGi side. Provisioning the same client multiple times will not result in duplicate entries.

company.externalId - customer.id on our end.
client.externalId - user_plan.id on our end (not user.id).
client.password - usually left blank to be created on the PGi side.
contact.state - cannot be null for USA customers.

        POST https://api.zipconferencing.com/provisioning/client/provision

        X-AUTH-TOKEN your-api-key
    
{
    "company": {
        "externalId": 50,
        "enterpriseId": 799,
        "name": "Company Name",
        "isGlobalMeetEnabled": true,
        "isWebConfEnabled": false
    },
    "client": {
        "externalId": 100,
        "password": "",
        "first": "First",
        "last": "Last",
        "email": "me@example.com"
    },
    "contact": {
        "address": "123 Street",
        "city": "Montreal",
        "state": "Quebec",
        "country": "Canada",
        "postalCode": "H1H1H1"
    }
}

        RESPONSE
    
{
    "status": "success",
    "data": {
        "companyId": 123456,
        "clientId": 12345678,
        "password": "abc123",
        "passCodes": {
            "moderatorPassCode": "1234567890",
            "participantPassCode": "1234567890"
        },
        "hub": {
            "hubId": 123456,
            "hubUrl": "company.example.com"
        }
    }
}

Client Deactivate

Client must exist and be provisioned on the PGi side. Deactivating an already inactive client will still result in a success, enabling the caller to update their record.

clientId - the PGi ClientId.

        POST https://api.zipconferencing.com/provisioning/client/deactivate

        X-AUTH-TOKEN your-api-key
    
{
    "clientId": 10863894
}

        RESPONSE
    
{
    "status": "success"
}

Client Reactivate

Client must exist and be provisioned on the PGi side. Reactivating an already active client will sill result in a success, enabling the caller to update their record.

clientId - the PGi ClientId.

        POST https://api.zipconferencing.com/provisioning/client/reactivate

        X-AUTH-TOKEN your-api-key
    
{
    "clientId": 10863894
}

        RESPONSE
    
{
    "status": "success"
}

Client Get

Client must exist and be provisioned on the PGi side.

clientId - the PGi ClientId.

        POST https://api.zipconferencing.com/client/get

        X-AUTH-TOKEN your-api-key
    
{
    "clientId": 12345678
}

        RESPONSE
    
{
    "clientId": 12345678,
    "hub": {
        "hubId": 123456,
        "hubUrl": "company.example.com"
    }
}

My Conferene Application SignOn

This endpoint signs in the client and provides a URL to the conferencing application. The UI should redirect the user to that URL. Client must exist and be provisioned on the PGi side to call this endpoint.

clientId - the PGi ClientId.

        POST https://api.zipconferencing.com/myconfapp/sso

        X-AUTH-TOKEN your-api-key
    
{
    "clientId": 10863894,
    "password": "client_web_password"
}

        RESPONSE
    
{
    "redirectUrl": "https://company.example.com?token=abc123"
}

Table of Contents

Client Provision

Client Deactivate

Client Reactivate

Client Get

My Conferene Application SignOn