API Documentation /

API Method: create_perma_class

Create a permanent class

If you’re unsure of what a particular set of values will produce, experiment using the create_perma_class method’s API Explorer.

End point URL

http://class.api.wiziq.com/?method=create_perma_class

Authentication

This method requires authentication.

Parameter Type Description Example
title Required The name (title) of the class. English Class
presenter_email Required This is the unique email of the presenter that will identify the presenter in WizIQ. Learn more. teacherinme@gmail.com
attendee_limit Optional The maximum number of attendees allowed in the class. The default is 2. 2
presenter_default_controls Optional Default controls available to the presenter in WizIQ Virtual Classroom. There are two possible values: audio and video. audio, video
attendee_default_controls Optional Default controls available to the attendee in WizIQ Virtual Classroom. There are two possible values: audio and writing. audio, writing
create_recording Optional Whether to record the class or not. Possible values: true (record) or false (don't record). Default is false. true
return_url Optional The URL users will be directed to when the class finishes. www.example.com
status_ping_url Optional The class's status. See here for parameters. www.example.com
language_culture_name Optional Language culture name for class. en-us

Response XML Example

<rsp status="ok" call_id="0ba583afe4da">
  <method>create_perma_class</method>
  <create_perma_class status="true">
    <perma_class_details>
      <class_master_id>29628</class_master_id>
      <common_perma_attendee_url><![CDATA[https://www.wiziq.com/class/launch.aspx?%2fpbeqQWORwi%2b839eB3qJlZr%2bIkG1ItLkiMQnBoyjW9i5VUY58wKSgOOk%3d]]></common_perma_attendee_url>
      <presenter>
        <presenter_email><![CDATA[teacherinme@gmail.com]]></presenter_email>
        <presenter_url><![CDATA[https://www.wiziq.com/class/launch.aspx?nVnDx7oTA%2bmTJwBNnZO9GCwZdS7yUDhmpb0twttPeyzKVEf5aK7owa6T]]></presenter_url>
      </presenter>
    </perma_class_details>
  </create_perma_class>
</rsp>

Error Codes

1001 - presenter_id parameter is missing.

1002 - presenter_name parameter is missing.

1008 - This class has been cancelled.

1014 - title parameter is missing.

1030 - presenter_email parameter is missing.

1031 - presenter_email is not valid.

1043 - The language is invalid or unsupported in the VC.

1080 - app_version parameter is empty/invalid.

1088 - class_master_id parameter is empty/invalid.

1093 - Your account is not configured to create perma class. To create perma class please contact sales@wiziq.com.

For enquiries: Call us at +1-919-647-4727 -or- Contact us

© 2017 WizIQ Inc. All rights reserved.