Conference Web Service

Owned by Former user (Deleted)
Last updated: Apr 07, 2011 by Former user (Deleted)Version comment
1 min read

This REST service is available starting with version 4.4

API

Base URL: https://{user id}:{password}@{host name}:8085/conference/{conference-name}

URL

METHOD

Description

/{command}/{arg 1}/{arg 2}...

PUT w/no body

send conference commands to freeswitch
Available FreeSWITCH commands and their arguments:

 list [delim <string>]
 xml_list
 energy <member_id|all|last> [<newval>]
 volume_in <member_id|all|last> [<newval>]
 volume_out <member_id|all|last> [<newval>]
 play <file_path> [async|<member_id>]
 say <text>
 saymember <member_id> <text>
 stop <[current|all|async|last]> [<member_id>]
 dtmf <[member_id|all|last]> <digits>
 kick <[member_id|all|last]>
 mute <[member_id|all]|last>
 unmute <[member_id|all]|last>
 deaf <[member_id|all]|last>
 undeaf <[member_id|all]|last>
 relate <member_id> <other_member_id> [nospeak|nohear|clear]
 lock
 unlock
 dial <endpoint_module_name>/<destination> <callerid number> <callerid name>
 bgdial <endpoint_module_name>/<destination> <callerid number> <callerid name>
 transfer <conference_name> <member id> [...<member id>]
 record <filename>
 norecord <[filename|all]>
 pin <pin#>
 nopin

Examples

Lock a conference with name "mirceaConf"
curl --digest -k -X PUT https://200:123@localhost:8085/conference/mirceaConf/lock