Schedule conferences

A conference is a call room hosted by an account for a set time. addConference books it and returns the access code that participants enter; deleteConference cancels it. This is the same as Schedule a Conference in the account’s portal.

Conferencing must be enabled in the account class of the hosting account and in the permissions of the customer that owns the account. Otherwise addConference fails.

Both methods support trusted mode with i_customer.

Dates are strings in UTC in the format HH:MM:SS.000 GMT Ddd Mmm DD YYYY, for example 09:57:29.000 GMT Wed Nov 18 2026. In Python: time.strftime("%H:%M:%S.000 GMT %a %b %d %Y", time.gmtime(ts)).

addConference

Schedules a conference.

Parameters

Name	Type	Required	Description
i_account	int	yes	ID of the account that hosts the conference
start_time	string	yes	When the conference starts, in the date format above
expire	string	no	When the conference ends. Default: start_time plus 2 hours
subject	string	no	Subject of the conference, up to 100 characters
confno_len	int	no	Number of digits of the generated access code. Default: 9

Returns

Name	Type	Description
result	string	OK
i_conference	int	ID of the conference
confno	string	Access code of the conference

Example

request

call("addConference", {
    "i_account": 3092,
    "subject": "Weekly sales call",
    "start_time": "14:00:00.000 GMT Mon Jan 19 2026",
    "expire": "15:00:00.000 GMT Mon Jan 19 2026",
})

response

{"result": "OK", "i_conference": 118, "confno": "508211947"}

deleteConference

Cancels a conference.

Parameters

Name	Type	Required	Description
i_account	int	yes	ID of the account that hosts the conference
i_conference	int	yes	ID of the conference

Returns

Name	Type	Description
result	string	OK

Example

request

call("deleteConference", {"i_account": 3092, "i_conference": 118})

response

{"result": "OK"}

Related

• Account classes
• IVR applications: the Conference application
• Create a customer: conferencing_enabled