The response objects are:

conf_settings response object
conf_repetition response object
conf_participant response object
occur_settings response object
conf_dial_info response object
clash_detail response
prompt_user response object
org response object
location response object
user response object
directory_entries response object
line response object
integration response object
sites response object

Response objects for managing conferences

conf_settings response object

The structure of the response object is identical to conf_settings request object .

conf_repetition response object

The structure of the response object is identical to conf_repetition request object .

conf_participant response object

The structure of the response object is identical to conf_participant request object.

occur_settings response object

The structure of the response object is identical to occur_settings request object .

conf_dial_info response object

{ 
"dial_starleaf": <string>,
"pstn_numbers": [<conf_pstn_number object>, 
	<conf_pstn_number object: optional>, 
	...], 
"access_code_pstn": <string>, 
"dial_info_url": <string>, 
"dial_standards": <string>, 
"breeze_link": <string>, 
"lync_link": <string>, 
"webrtc_link": <string> 
"sign_up_link": <string>
"custom_invite_footer": <string>
"custom_invite_plain_text": <string>				
} 
Field Description

dial_starleaf

The string to dial to join the conference using a StarLeaf endpoint.

pstn_numbers

An array of one or more conf_pstn_number objects, each of which provides a public switched telephone network (PSTN) number for a different geographic location. Any of these numbers may be dialed to join the conference. Participants dialing in using this method will be prompted to enter an access code.

access_code_pstn

The access code required by participants that dial in from the PSTN.

dial_info_url

A URL to a web page providing all the relevant dialing information in a user readable format.

dial_standards

The sequence to dial to join the conference using a standards based (H.323 or SIP) endpoint.

breeze_link

A link for use on devices that have the StarLeaf Breeze soft client installed.

lync_link

A link for use on devices that have Microsoft Skype-for-Business installed. Note that this value will be null if Skype-for-Business is not enabled for the client in the StarLeaf Cloud.

webrtc_link

A Click-to-Call link for joining the conference using a web browser. Note that this value will be null if WebRTC is not enabled for the client in the StarLeaf Cloud.

sign_up_link A URL to a web page that allows someone to sign up to the StarLeaf Cloud service and download a software video client.
custom_invite_footer The text in a meeting invite that can be customised through the StarLeaf Portal. If no custom text has been added, the default StarLeaf footer is used.
custom_invite_plain_text The plain text version of the above (without html links).

clash_detail response

The structure of the response when the user attempts to creates or update a conference that includes a meeting room participant that is already in use by a different conference at the same time.

{
  "meetingRoom":  <string:required>,
  "ownerName":  <string:required>,
  "start":  <string:required>,
  "end":<string:required>
      
}
Field Description
meetingRoom Name of the meeting room that has a clash.
ownerName Name of the owner of the clashing conference.
start UTC time and date of the start of the clashing occurrence.
end UTC time and date of the end of the clashing occurrence.

prompt_user response object

{
  "error":  <string:required>,
  "error_code":  "need_confirmation",
  "detail": {
  "send_update_emails":<null:optional>, #present only if the user should be prompted about sending emails
  "ignore_room_clashes": <[
		<clash_detail object: optional>,
		<clash_detail object: optional>,
		...]: optional>                       # present only if user should be prompted about meeting room clashes

	}
     
}

Response objects for managing customers

location response object

The structure of the response object is identical to location request object.

org response object

{
  "id":  <string>,
  "org_name":  <string>,
  "subdomain":  <string>,
  "email_domains":  [<optional string>, <optional string>, ....]
  "location": {
  "country": <country code>,
  "state": <state code>,
  "locale": <locale code>,
  "timezone": <timezone>,
  "country_dialling_code": <country dialing code>,
  "default_dscp": <default_dscp>
     }
}

Field

Description

id The unique identifier for this organization.
org_name The organization name.
subdomain The subdomain of the organization
email domains The email domains associated with the organization.
location The location response object which is identical to the location request object

Response objects for managing users

user response object

{
  "user_id": <string>, 
  "firstname": <string>,
  "lastname": <string>,
  "email": <string>,
  "is_org_admin": <boolean>,
  "send_emails": <boolean>,
  "enable_vvm": <boolean>,
  "timezone": <string or null>,
  "locale": <string or null>,
  "org_account_type": <string>,
  "site_id": <string>, 
  "phone_home": <string or null>,
  "phone_work": <string or null>,
  "phone_mobile": <string or null>,
  "enabled": <boolean>
  "line": <line response object>,
  "breeze": <breeze response object>
}

Field

Description

user_id The unique identifier for this user within the organization.
firstname First name of the new user.
lastname Last name of the new user.
email Email address of the new user.
is_org_admin Boolean to specify if whether this user has admin privileges.
send_emails Boolean to specify whether to send account-settings emails.
enable_vvm Boolean to turn off/on video voicemail for this user.

timezone

If the user is in a different timezone to the default timezone for the organization, this is the name of the user’s time zone, as per the IANA Time Zone Database.

locale If the user uses a different language to the default language of the organization, this is the code for that language. The language will be used for emails to the user and for the user interface language for Breeze, desktop system and user Portal pages. The locale is also used to determine the format of any display of date and time. For a list of valid locale codes, refer to Locales.
site_id The identifier for the site the user is in.
phone_home The user’s home telephone number.
phone_work Another contact telephone number for the user.
phone_mobile A mobile phone number for the user.
enabled Boolean to specify whether or not the user is enabled. A client can disable or re-enable a user— refer to the relevant section in Org admin requests or Reseller requests.
line Settings for the line— refer to line response object.
breeze

Setting for the breeze software client.

Response objects for managing directory entries

directory_entries response object

{
  "id": <string>, 
  "firstname": <string>, 
  "last_name": <string>,
  "phone_work": <string>,
  "phone_home": <string>,
  "phone_mobile": <string>,
  "status": <string>
   }

Field

Description

id The unique identifier for this directory entry within the organization.
firstname First name for the directory entry.
lastname Last name for the directory entry.
phone_work A contact telephone number, extension number, IP address, or video address for the directory entry.
phone_home A home contact telephone number, extension number, IP address, or video address for the directory entry.
phone_mobile A mobile phone number for the directory entry.
status Indicates whether the directory entry was added automatically or manually

line response object

line is an object that appears in the response to a create or modify user request.

{
    "alias":<string>,
    "alias_autocomplete": <boolean>,
    "number":<string>
}
Field Description
alias

The first part of the user’s external video address. That is, the part before the @ sign. To create the full dialing URI for a user, use the format:
<alias>@<organization_subdomain>.call.sl

alias_autocomplete Whether or not this user’s external video address was automatically created by the Cloud. If false, this external video address has been created or edited through the StarLeaf Portal.

If true and you edit an existing user’s email address, the Cloud might auto-update the user’s alias. If false and you edit an existing user’s email address, the Cloud will not auto-update the user’s alias.

number The directory number of this user.

Response objects for managing integrations

integration response object

{ 
  "label": <string>,
  "type": <string>,
  "id"; <string>,
  "token_header_name": <string>,
  "access_token": <string>,
  "is_org_admin": <boolean> 
} 	

Field

Description

label

The name given to the integration.

type

The type of integration. Currently, the only supported type is “custom”.

id A unique identifier for this integration.
token_header_name The name of the HTTP header that the integration client must use for authentication.
access_token

The value of the HTTP header that the integration client must use for authentication. This is a unique token for this integration. Note, it is worth remembering that this access token provides login access to the organization. Therefore, keep it secret.

If you do want to regenerate the access token for an integration, you can do so using a PATCH request for the integration. For more information, refer to the relevant section of Org admin requests or Reseller requests.

is_org_admin Whether or not the integration has administrator access to this organization.

Response objects for sites

sites response object

{
    "id": <string: required>,
	"label": <string: required>,
	"country": <string: required>,
    "state": <string: optional, default: null>,
   	"timezone": <string: optional>,
    "locale": <string: optional>,
    "default_dscp": <string: optional, default: null>
	"pwr_line_freq" <string: optional, default: null>
}

Field

Description

id A unique identifier for the site.
label The name given to the integration
country

Two letter country code for the country of the site, according to ISO 3166 .

state

The state within the chosen country for the site.

timezone

This is the site’s time zone, as per the IANA Time Zone Database.

locale If the site uses a different language to the default language of the organization, this is the code for that language. The language is used for emails to the user and for the user interface language for StarLeaf and user Portal pages. The locale is also used to determine the format of any display of date and time. For a list of valid locale codes, refer to Locales.
default_dscp The DSCP value that is set for the site.
pwr_line_freq The power line frequency value that is set for the site.