Skip to main content

API Reference Documentation

Introduction

Welcome to the FreeConferenceCall.com API Reference Documentation section.

This page summarizes the Restful terms that can be used to access the features available within a FreeConferenceCall.com account. Please note that you must have a FreeConferenceCall.com account in order to access our API Explorer. If you do not yet have an account, sign up now.

Additionally, in order to access the API itself, you will need to request a set of credentials (individual public and private API keys) if you have not yet done so. Contact us by phone or make a request here today to get setup.

Most importantly, this service is provided to you at no cost. You may use the service in accordance to our published Terms & Conditions and Privacy Policy.

If you are in need of any assistance related to your use of the API, please feel free to submit an email to: tickets@freeconferencecall.com.

Authorization

In order to make requests for a particular FreeConferenceCall subscription an API client must be authorized for that subscription. API v4 provides several ways of authorization.

For the existing subscriptions:

And one scheme for creating subscriptions:

  • Signup implicit authorization scheme (privileged clients only)

In all cases, the client must get an access_token as the result of authorization, and store it to make API requests.

OAuth2 Authorization code scheme (all clients)

This scheme is used by API clients with a server side for already existing FreeConferenceCall subscriptions.
The flow includes the following steps:

  • Authorization request

The client needs to direct the user to FreeConferenceCall at:


                  GET https://www.freeconferencecall.com/api/v4/authorize
               

With the following parameters:

Parameter Data Type Description
client_id req string Public API key for application
redirect_uri req string URI to be redirected after user’s decision
response_type req string Determines whether the OAuth 2.0 endpoint returns an authorization code or an access token. Applications need to set the parameter's value to "code"

Example:


                  https://www.freeconferencecall.com/api/v4/authorize?client_id=foo&response_type=code&redirect_uri=https://localhost/oauth_callback
               
  • User consent decision

In this step, user decides whether or not to grant your application the ability to make API requests that are authorized as the user.

  • Handle response from FreeConferenceCall

After user consents or refuses to grant access to your application, FreeConferenceCall redirects the user to the redirect_uri specified in step 1. If the user grants access to your application, FreeConferenceCall appends an authorization code in the query fragment of the redirect URI as shown in the sample URI below.


                  https://localhost/oauth_callback?code=quux
               

The client server must capture the authorization code and use it in the next step. If the user refused to grant access to your application, the access_denied error message will be included into the query fragment of the redirect_uri:


                  https://localhost/oauth_callback?error=access_denied&error_description=The+end-user+or+authorization+server+denied+the+request.
               
  • Access token request

The client makes a request to the token endpoint to get an access token and a refresh token.


                  POST https://www.freeconferencecall.com/api/v4/token
               

With the following parameters:

Parameter Data Type Description
client_id req string Public API key for application.
client_secret req string Private API key for application.
redirect_uri req string Redirect URI must be the same as the redirect URI used in the previous step.
grant_type req string Applications need to set the parameter's value to "authorization_code".
code req string Authorization code received in the previous step.

The obtained access token and the refresh token should be stored by the client and can be used for following API requests.

Example:


                  curl -X POST
                  -d 'client_id=foo’
                  -d ‘client_secret=bar’
                  -d ‘grant_type=authorization_code’
                  -d ‘redirect_uri=https://localhost/oauth_callback’
                  -d ‘code=quux'
                  https://www.freeconferencecall.com/api/v4/token

                  #=> {"access_token":"baz","refresh_token":"bat","token_type":"bearer","expires_in":2678397}
               

OAuth2 implicit authorization scheme (all clients)

This scheme is used by API clients without a server side for already existing FreeConferenceCall subscriptions. The flow consists of the following steps:

  • Authorization request
The client directs the user to FreeConferenceCall at:


                  GET https://www.freeconferencecall.com/api/v4/authorize
               

With the following parameters:

Parameter Data Type Description
client_id req string Public API key for application.
redirect_uri req string URI to be redirected after user’s decision.
response_type req string Determines whether the OAuth 2.0 endpoint returns an authorization code or an access token. Applications need to set the parameter's value to "token".

Example:


                  https://www.freeconferencecall.com/api/v4/authorize?client_id=foo&response_type=token&redirect_uri=https://localhost/oauth_callback
               

  • User consent decision
In this step, the user decides whether or not to grant your application the ability to make API requests that are authorized as the user.

  • Handle response from FreeConferenceCall

After the user consents or refuses to grant access to your application, FreeConferenceCall redirects the user to the redirect_uri that you specified in step 1.

If the user granted access to your application, FreeConferenceCall appends an access token in the hash fragment of the redirect URI as shown in the sample URI below. The response also includes the expires_in and token_type parameters. These parameters describe the lifetime of the token in seconds and the kind of token that is being returned respectively. Not that the authorization server does not issue a refresh token for this type of authorization.


                  https://localhost/oauth_callback#access_token=baz&expires_in=2678399&token_type=bearer
               

JavaScript code running on your page can capture the access_token from the window.location.hash value and either store the token in a cookie or POST it to a server.

If the user refused to grant access to your application, the access_denied error message will be included in the hash fragment of the redirect_uri:


                  http://localhost/oauth2callback#error=access_denied
               

OAuth2 Resource owner password authorization scheme (privileged clients only)

The resource owner password credentials grant type is suitable for privileged clients only in cases when the resource owner has a trust relationship with the client.

  • Authorization request

The client needs to send the below request:


                  POST https://www.freeconferencecall.com/api/v4/token
               

With the following parameters:

Parameter Data Type Description
client_id req string Public API key for application
client_secret req string Private API key for application
grant_type req string Applications need to set the parameter's value to "password"
username req string FCC user login
password req string FCC user password. If not provided will be auto-generated

Example:


                  curl -X POST
                  -d 'client_id=foo’
                  -d ‘client_secret=bar’
                  -d ‘grant_type=password
                  -d ‘username=hello@company.com’
                  -d ‘password=123456'
                  https://www.freeconferencecall.com/api/v4/token

                  #=> {"access_token":"baz","refresh_token":"bat","token_type":"bearer","expires_in":2678397}
               

  • Handle response from FCC
The obtained access token and the refresh token should be stored by the client and can be used for following API requests.

Signup implicit authorization scheme (privileged clients only)

This scheme is used for creating new FreeConferenceCall subscriptions by privileged clients only in cases where the subscription owner has a trust relationship with the client. The client needs to send the signed signup request at:


                     POST https://www.freeconferencecall.com/api/v4/subscription
                  

With the following parameters:

Parameter Data Type Description
email req string Subscription email
first_name req string First name
last_name req string Last name
password req string Password
subscriber_pin opt string Subscriber pin (1-7 digits allowed)
meeting_url opt string Meeting URL
access_code opt string Access code (6-10 digits allowed)
country_id opt integer Country id
time_zone_id opt integer Time zone id
template_id opt integer Template id. Allows to set template features to newly created subscription (rates, audio options, lobby settings, etc.)
audio_attrs opt object Subscription audio options
entry_and_exit_tone string Shows whether entry and exit tones are enabled. Possible values:
  • on
  • off
  • display_al string Shows whether attendee list is enabled. Possible values:
  • on
  • off
  • ask_job_code string Shows whether ask job code setting is enabled. Possible values:
  • on
  • off
  • announce_caller_count string Shows whether caller count announce is enabled. Possible values:
  • on
  • off
  • conference_recording string Shows whether conference recording option is enabled. Possible values:
  • on
  • off
  • wait_for_host string Shows wait for host interval to drop the conference. Possible values:
  • off
  • 1m
  • 5m
  • 10m
  • 20m
  • 30m
  • 45m
  • continue_without_host string Shows continue host interval to drop the conference. Possible values:
  • on
  • 1m
  • 5m
  • 10m
  • 20m
  • 30m
  • 45m
  • conference_maxduration string Shows conference max duration in seconds
    client_id req string Public API key for application
    client_secret req string Secret API key for application

    The access_token and the newly created subscription will be included into the response. The obtained access token and refresh token should be stored by the client. They can be used for following API request:

    Example:

    
                            curl -X POST
                            -d "email=test@test.com"
                            -d "password=123456"
                            -d "first_name=John"
                            -d "last_name=Doe"
                            -d "client_id=foo"
                            -d "client_secret=bar"
                            
    
                            #=> {"retcode":0, "access_token":"baz", "refresh_token":"bat", "token_type":"bearer", "expires_in":2678396, "subscription":{…}}
                         

    Refreshing an Access Token

    All issued access token have an expiration date. If the client wants to refresh the user access_token without going through all authorization steps again this task can be accomplished by a refresh token request. In order to do it the client must use the refresh token received during an authorization. To refresh the access token for the user the client must do the following request:

    
                      POST https://www.freeconferencecall.com/api/v4/token
                   

    With the following parameters:

    Parameter Data Type Description
    client_id req string Public API key for application
    client_secret req string Private API key for application
    grant_type req string Applications need to set the parameter's value to "refresh_token"
    refresh_token req string Refresh token received during the authorization

    The new valid access code and refresh token will be included in the response. The client must replace the old access code and the old refresh token with this values.

    Example:

    
                      curl -X POST
                      -d 'client_id=foo
                      -d ‘client_secret=bar’
                      -d ‘grant_type=refresh_token’
                      -d ‘refresh_token=bat’
                      https://www.freeconferencecall.com/api/v4/token
    
                      #=> {"access_token":"baz1","refresh_token":"bat1","token_type":"bearer","expires_in":2678600}
                   

    Using Access Token in Requests

    With the returned access token your application allows to perform API calls to FreeConferenceCall. Access token should be transferred as request parameter named access_token. Access token granting access to a single subscription resources.

    API Methods


    Subscription

    Get subscription

    Method URL
    GET /subscription

    Sample Request

    
                               curl -X GET
                               -d "access_token=7b0cba317266e81ca118856e68c246a9"
                               https://www.freeconferencecall.com/api/v4/subscription
                            

    Sample Response

    
                               {
                                 "retcode": 0,
                                 "subscription": {
                                    "id": "556982",
                                    "email": "kate.smith@aol.com",
                                    "first_name": "Kate",
                                    "last_name": "Smmith",
                                    "user_id": "88678",
                                    "meeting_url": "kate_smith4",
                                    "access_code": "350267",
                                    "conference_number": "6883419",
                                    "managed": false,
                                    "managed_settings": {},
                                    "toll_numbers": [
                                        {
                                          "country": "1",
                                          "country_code": "us",
                                          "country_name": "United States",
                                          "dial_in_number": "7753601498",
                                          "id": "2161",
                                          "in_country_format": "(775) 360-1498",
                                          "international_format": "+1 775-360-1498",
                                          "number": "(775) 360-1498",
                                          "region": "Americas",
                                          "type": "0"
                                        }
                                     ],
                                     "toll_free_numbers": [],
                                     "toll_playback_numbers": [],
                                     "one_numbers": [],
                                     "subscriber_pin": "2222",
                                     "enable_cdr_email": false,
                                     "copy_reports_to": "",
                                     "time_zone_id": "83",
                                     "credit_card": "current",
                                     "current_storage_size": "511",
                                     "max_storage_size": "11264",
                                     "audio_attrs": {
                                        "entry_and_exit_tone": "on",
                                        "announce_caller_count": "off",
                                        "display_al": "host",
                                        "ask_job_code": "off",
                                        "conference_recording": "on",
                                        "wait_for_host": "5m",
                                        "continue_without_host": "5m",
                                        "conference_maxduration": ""
                                     },
                                     "country_id": "1",
                                     "country_code": "us",
                                     "enable_sms": false
                                  }
                               }
                            

    Attributes

    Attribute Data Type Description
    id string Subscription ID
    email string Email
    first_name string First name
    last_name string Last name
    user_id string User ID
    meeting_url string Meeting URL
    access_code integer Access code
    conference_number integer Conference number
    managed boolean Shows whether or not the given subscription has a parent. Possible values:
  • true
  • false
  • toll_numbers array Array of toll numbers
    country integer Country number (as stored in the database)
    country_code string Country 2-letter code
    country_name string Country name
    dial_in_number string Number to dial the conference
    id integer Number id
    in_country_format string Phone number in a national format
    international_format string Phone number in an international format
    number string Number to dial the conference
    region string Region of the country
    type integer Flag showing whether the number is conferencing or playback. Possible values:
  • true
  • false
  • toll_playback_numbers array Array of toll playback numbers
    toll_free_numbers array Array of toll free numbers
    one_numbers array Array of one numbers
    subscriber_pin integer Subscriber pin
    enable_cdr_email boolean Shows whether conference report email is enabled. Possible values:
  • true
  • false
  • copy_reports_to string List of emails to copy reports to
    time_zone_id integer Subscription time zone id
    credit_card string Shows if subscription has an attached credit card. Possible values:
  • current
  • ""
  • current_storage_size integer Current used storage size in MB
    max_storage_size integer Current max storage size in MB
    country_id integer Subscription country id
    country_code string Subscription country code
    enable_sms boolean Shows whether sms notifications are enabled
    audio_attrs object Subscription audio options
    entry_and_exit_tone string Shows whether entry and exit tones are enabled. Possible values:
  • on
  • off
  • display_al string Shows whether attendee list is enabled. Possible values:
  • on
  • off
  • ask_job_code string Shows whether ask job code setting is enabled. Possible values:
  • on
  • off
  • announce_caller_count string Shows whether caller count announce is enabled. Possible values:
  • on
  • off
  • conference_recording string Shows whether conference recording option is enabled. Possible values:
  • on
  • off
  • auto
  • wait_for_host string Shows wait for host interval to drop the conference. Possible values:
  • off
  • 1m
  • 5m
  • 10m
  • 20m
  • 30m
  • 45m
  • continue_without_host string Shows continue host interval to drop the conference. Possible values:
  • on
  • 1m
  • 5m
  • 10m
  • 20m
  • 30m
  • 45m
  • conference_maxduration string Shows conference max duration in seconds

    Create subscription

    Please see Signup Implicit Authorization Scheme section.

    Update subscription

    This call will update information for the Subscription which id is specified.

    Method URL
    PATCH /subscription

    Sample Request

    
                            curl -X PATCH -H "Content-Type: application/json" -d '{
                               "email": "john@startmeeting.com",
                               "first_name": "Kate",
                               "last_name": "Smmith",
                               "subscriber_pin": "6666",
                               "meeting_url": "kate_smith4",
                               "country_id": "1",
                               "time_zone_id": "83",
                               "audio_attrs": {
                                  "entry_and_exit_tone": "on",
                                  "announce_caller_count": "off",
                                  "display_al": "host",
                                  "ask_job_code": "off",
                                  "conference_recording": "on",
                                  "wait_for_host": "5m",
                                  "continue_without_host": "5m",
                                  "conference_maxduration": ""
                               },
                            }' "https://www.freeconferencecall.com/api/v4/subscription?access_token=7b0cba317266e81ca118856e68c246a9"
                         

    Parameters:

    Parameter Data Type Description
    first_name opt string First name
    last_name opt string Last name
    email opt string Subscription email
    password opt string Password
    subscriber_pin opt string Subscriber pin (1-7 digits allowed)
    meeting_url opt string Meeting URL
    country_id opt integer Country id
    time_zone_id opt integer Time zone id
    audio_attrs opt object Subscription audio options
    entry_and_exit_tone string Shows whether entry and exit tones are enabled. Possible values:
  • on
  • off
  • display_al string Shows whether attendee list is enabled. Possible values:
  • on
  • off
  • ask_job_code string Shows whether ask job code setting is enabled. Possible values:
  • on
  • off
  • announce_caller_count string Shows whether caller count announce is enabled. Possible values:
  • on
  • off
  • conference_recording string Shows whether conference recording option is enabled. Possible values:
  • on
  • off
  • wait_for_host string Shows wait for host interval to drop the conference. Possible values:
  • off
  • 1m
  • 5m
  • 10m
  • 20m
  • 30m
  • 45m
  • continue_without_host string Shows continue host interval to drop the conference. Possible values:
  • on
  • 1m
  • 5m
  • 10m
  • 20m
  • 30m
  • 45m
  • conference_maxduration string Shows conference max duration in seconds

    Sample Response

    
                            {
                              "retcode": 0,
                              "subscription": {
                                 "id": "556982",
                                 "email": "kate.smith@aol.com",
                                 "first_name": "Kate",
                                 "last_name": "Smmith",
                                 "user_id": "88678",
                                 "meeting_url": "kate_smith4",
                                 "access_code": "350267",
                                 "conference_number": "6883419",
                                 "managed": false,
                                 "managed_settings": {},
                                 "toll_numbers": [
                                     {
                                       "country": "1",
                                       "country_code": "us",
                                       "country_name": "United States",
                                       "dial_in_number": "7753601498",
                                       "id": "2161",
                                       "in_country_format": "(775) 360-1498",
                                       "international_format": "+1 775-360-1498",
                                       "number": "(775) 360-1498",
                                       "region": "Americas",
                                       "type": "0"
                                     }
                                  ],
                                  "toll_free_numbers": [],
                                  "toll_playback_numbers": [],
                                  "one_numbers": [],
                                  "subscriber_pin": "2222",
                                  "enable_cdr_email": false,
                                  "copy_reports_to": "",
                                  "time_zone_id": "83",
                                  "credit_card": "current",
                                  "current_storage_size": "511",
                                  "max_storage_size": "11264",
                                  "audio_attrs": {
                                     "entry_and_exit_tone": "on",
                                     "announce_caller_count": "off",
                                     "display_al": "host",
                                     "ask_job_code": "off",
                                     "conference_recording": "on",
                                     "wait_for_host": "5m",
                                     "continue_without_host": "5m",
                                     "conference_maxduration": ""
                                  },
                                  "country_id": "1",
                                  "country_code": "us",
                                  "enable_sms": false
                               }
                            }
                         

    Attributes

    Attribute Data Type Description
    subscription object Subscription

    Generate new access code

    This call will generate new access code for the subscription. This action cannot be undone.

    Method URL
    PATCH /subscription/access_code

    Sample Request

    
                            curl -X PATCH "https://www.freeconferencecall.com/api/v4/subscription/access_code?access_token=7b0cba317266e81ca118856e68c246a9"
                         

    Sample Response

    
                            {
                              "retcode": 0,
                              "subscription": {
                                 "id": "556982",
                                 "email": "kate.smith@aol.com",
                                 "first_name": "Kate",
                                 "last_name": "Smmith",
                                 "user_id": "88678",
                                 "meeting_url": "kate_smith4",
                                 "access_code": "234523454",
                                 "conference_number": "6883419",
                                 "managed": false,
                                 "managed_settings": {},
                                 "toll_numbers": [
                                     {
                                       "country": "1",
                                       "country_code": "us",
                                       "country_name": "United States",
                                       "dial_in_number": "7753601498",
                                       "id": "2161",
                                       "in_country_format": "(775) 360-1498",
                                       "international_format": "+1 775-360-1498",
                                       "number": "(775) 360-1498",
                                       "region": "Americas",
                                       "type": "0"
                                     }
                                  ],
                                  "toll_free_numbers": [],
                                  "toll_playback_numbers": [],
                                  "one_numbers": [],
                                  "subscriber_pin": "2222",
                                  "enable_cdr_email": false,
                                  "copy_reports_to": "",
                                  "time_zone_id": "83",
                                  "credit_card": "current",
                                  "current_storage_size": "511",
                                  "max_storage_size": "11264",
                                  "audio_attrs": {
                                     "entry_and_exit_tone": "on",
                                     "announce_caller_count": "off",
                                     "display_al": "host",
                                     "ask_job_code": "off",
                                     "conference_recording": "on",
                                     "wait_for_host": "5m",
                                     "continue_without_host": "5m",
                                     "conference_maxduration": ""
                                  },
                                  "country_id": "1",
                                  "country_code": "us",
                                  "enable_sms": false
                               }
                            }
                         

    Attributes

    Attribute Data Type Description
    subscription object Subscription

    Cancel subscription (privileged clients only)

    This call will cancel the subscription. This action cannot be undone. This method is allowed for privileged clients only.

    Method URL
    DELETE /subscription

    Sample Request

    
                            curl -X DELETE "https://www.freeconferencecall.com/api/v4/subscription?access_token=7b0cba317266e81ca118856e68c246a9"
                         

    Sample Response

    
                            {
                              "retcode": 0
                            }
                         

    Conferences

    Get conferences list

    This call will return all conferences for the currently logged in subscription.

    Method URL
    GET /conferences

    Sample Request

    
                            curl -X GET
                            -d "access_token=145aebd7fc8df86afd16343c42d2dfb3"
                            -d "offset=0"
                            -d "limit=10"
                            https://www.freeconferencecall.com/api/v4/conferences
                         

    Parameters

    Parameter Data Type Description
    limit opt integer Limit of items returned. Default is 10. Max is 200
    offset opt integer Offset of items returned. Default is 0
    start_time opt integer (UTC timestamp in seconds). Filter to show conferences that started after this time
    end_time opt integer (UTC timestamp in seconds). Filter to show conferences that ended before this time
    has_recordings opt boolean Shows whether or not the conference has a recording. Possible values:
  • true
  • false
  • description opt string Filter conferences by description
    order_by opt string Conferences ordering field
    order opt string Conferences order direction. Default is DESC. Possible values:
  • DESC
  • ASC
  • Sample Response

    
                            {
                               "retcode": 0,
                               "conferences": [
                                  {
                                     "id": "14330517",
                                     "conf_number": "6883419",
                                     "subscription_id": "556982",
                                     "job_code": "",
                                     "start_time": 1456918678,
                                     "end_time": 1456918690,
                                     "duration": 12,
                                     "description": "",
                                     "password": "",
                                     "reference_number": "",
                                     "callers": "2",
                                     "recording_url": "",
                                     "is_recorded": false,
                                     "recording_duration": 0,
                                     "web_recording_status": 0,
                                     "audio": false,
                                     "screen_sharing": false,
                                     "video": false,
                                     "file_size": 0,
                                     "deleted": false,
                                     "available": true,
                                     "auto_notes_processing": false,
                                     "auto_notes_url": "",
                                     "details": {
                                        "audio_participants": 1,
                                        "screen_sharing_participants": 2,
                                        "video_participants": 2,
                                        "toll_minutes": 0,
                                        "toll_free_minutes": 0,
                                        "voip_minutes": 2,
                                        "screen_sharing_minutes": 3,
                                        "video_minutes": 3
                                     }
                                  },
                                  ...
                               ],
                               meta: {
                                  total: 7
                               }
                            }
                         

    Attributes

    Attribute Data Type Description
    conferences array Array of conferences items
    meta object Meta information
    total integer Total number of conferences for request

    Get conference

    This call will return subscription conference by id.

    Method URL
    GET /conferences/{id}

    Sample Request

    
                            curl -X GET
                            -d "access_token=145aebd7fc8df86afd16343c42d2dfb3"
                            https://www.freeconferencecall.com/api/v4/conferences/123
                         

    Parameters

    Parameter Data Type Description
    id req integer Unique ID of the conference instance

    Sample Response

    
                            {
                               "retcode": 0,
                               "conference": {
                                  "id": "14330517",
                                  "conf_number": "6883419",
                                  "subscription_id": "556982",
                                  "job_code": "",
                                  "start_time": 1456918678,
                                  "end_time": 1456918690,
                                  "duration": 12,
                                  "description": "",
                                  "password": "",
                                  "reference_number": "",
                                  "callers": "2",
                                  "recording_url": "",
                                  "is_recorded": false,
                                  "recording_duration": 0,
                                  "web_recording_status": 0,
                                  "audio": false,
                                  "screen_sharing": false,
                                  "video": false,
                                  "file_size": 0,
                                  "deleted": false,
                                  "available": true,
                                  "auto_notes_processing": false,
                                  "auto_notes_url": "",
                                  "details": {
                                     "audio_participants": 1,
                                     "screen_sharing_participants": 2,
                                     "video_participants": 2,
                                     "toll_minutes": 0,
                                     "toll_free_minutes": 0,
                                     "voip_minutes": 2,
                                     "screen_sharing_minutes": 3,
                                     "video_minutes": 3
                                  }
                               }
                            }
                         

    Attributes

    Attribute Data Type Description
    id integer Unique ID of the conference instance
    conf_number integer Conference number
    subscription_id string Subscription ID
    job_code string Job code
    start_time integer Time when the conference was started (UTC timestamp in seconds)
    end_time integer Time when the conference was finished (UTC timestamp in seconds)
    meeting_url string Meeting URL
    duration integer Duration of the conference in seconds
    description string Description of the conference
    password string Password
    reference_number integer Conference reference number for playback
    callers integer Number of the callers in the conference
    recording_url string Conference recording URL. To form download_url and download the recording please add .mp3 extension to the URL. Example:
  • recording_url: https://rs0000.freeconferencecall.com/storage/sgetFCC2/KHJds/PhjD
  • download_url: https://rs0000.freeconferencecall.com/storage/sgetFCC2/KHJds/PhjD.mp3
  • is_recorded boolean Shows whether or not the conference has a recording. Possible values:
  • true
  • false
  • recording_duration integer Duration of the recording
    web_recording_status integer Status of the web recording
    audio boolean Shows whether or not the conference has recorded audio content
    screen_sharing boolean Shows whether or not the conference has recorded screen sharing content
    video boolean Shows whether or not the conference has recorded video content
    file_size integer Size of the recorded file
    is_recorded boolean Shows whether or not the conference recording has been deleted. Possible values:
  • true
  • false
  • available boolean Shows whether or not the conference recording is available for download. Possible values:
  • true
  • false
  • auto_notes_processing boolean Auto notes processing status. Possible values:
  • true
  • false
  • auto_notes_url string Auto notes URL
    details object Conference details
    audio_participants integer Number of audio participants
    screen_sharing_participants integer Number of screen sharing participants
    video_participants integer Number of video participants
    toll_minutes integer Toll minutes
    toll_free_minutes integer Toll-free minutes
    voip_minutes integer VOIP minutes
    screen_sharing_minutes integer Screen sharing minutes
    video_minutes integer Video minutes

    Get calls list

    This call will return subscription conference calls.

    Method URL
    GET /conferences/{id}/calls

    Sample Request

    
                            curl -X GET
                            -d "access_token=145aebd7fc8df86afd16343c42d2dfb3"
                            -d "offset=0"
                            -d "limit=10"
                            https://www.freeconferencecall.com/api/v4/conferences/123/calls
                         

    Parameters

    Parameter Data Type Description
    id req integer Conference id
    limit opt integer Limit of items returned. Default is 10. Max is 200
    offset opt integer Offset of items returned. Default is 0

    Sample Response

    
                            {
                              "calls": [
                                {
                                  "id": "10224189",
                                  "custom_name": "user@freeconferencecall.com - John",
                                  "service_types": [
                                    "voip",
                                    "screen_sharing",
                                    "video"
                                  ],
                                  "called_number": "(775) 360-1426",
                                  "calling_number": "user@freeconferencecall.com",
                                  "video_duration": 81,
                                  "time_disconnected_utc": 1446468770,
                                  "time_created_utc": 1446468671,
                                  "is_host": true,
                                  "audio_duration": 93,
                                  "screen_sharing_duration": 85
                                },
                                {
                                  "id": "10224190",
                                  "custom_name": "(760) 569-2222 - 2535",
                                  "service_types": [
                                    "toll"
                                  ],
                                  "called_number": "(775) 360-1426",
                                  "calling_number": "(760) 569-2222",
                                  "video_duration": 0,
                                  "time_disconnected_utc": 1446468940,
                                  "time_created_utc": 1446468716,
                                  "is_host": false,
                                  "audio_duration": 300,
                                  "screen_sharing_duration": 0
                                }
                              ],
                              "meta": {
                                "total": 2
                              }
                            }
                         

    Attributes

    Attribute Data Type Description
    calls array Array of calls items
    id integer Call id
    custom_name string Called number or entered name of participant
    service_types array Array of services used by participant Can contain the following services:
  • voip
  • toll
  • toll_free
  • screen_sharing
  • video
  • called_number string Number called by participant
    calling_number string Number/email participant connected with
    video_duration integer Video service usage in seconds by participant
    time_disconnected_utc integer Time when participant disconnected conference (UTC timestamp in seconds)
    time_created_utc integer Time when participant joined conference (UTC timestamp in seconds)
    is_host boolean Host indicator
    audio_duration integer Audio service usage in seconds by participant
    screen_sharing_duration integer Screen sharing service usage in seconds by participant
    meta object Meta information
    total integer Total number of conferences for request

    Countries

    Get countries list

    Method URL
    GET /countries

    Sample Request

    
                               curl -X GET
                               https://www.freeconferencecall.com/api/v4/countries
                            

    Sample Response

    
                               {
                                  "retcode": 0,
                                  "countries": [
                                   {
                                     "id": 1,
                                     "name": "United States",
                                     "code": "us"
                                   },
                                   {
                                     "id": 2,
                                     "name": "United Kingdom",
                                     "code": "gb"
                                   },
                                   {
                                     "id": 3,
                                     "name": "France",
                                     "code": "fr"
                                   },
                                   ...
                                  ]
                               }
                            

    Attributes

    Attribute Data Type Description
    countries array List of countries
    id integer Country id
    name string Country name
    code string Country code

    API response codes and errors

    FreeConferenceCall API response always contains retcode, and, in case of errors, also contains error status, and may contain error_description. The API can respond to calls with the following possible codes:

    Status Retcode
    ok 0
    object_not_found 1
    server_error 2
    invalid_token 3
    token_is_expired 4
    duplicate_record 5
    incoming_parameters_validation_error 6
    conflicting_promocode 7
    client_app_not_found 8
    invalid_signature 9
    access_denied 10
    forbidden_resource 11
    request_is_too_old 12

    Example of an error response:

    
                      #=> {"retcode":6, "error":"incoming_parameters_validation_error", “error_description”: “Email max size is 100 characters”}
                   

    In case of outdated request response will also contain current server time:

    
                      #=> {"retcode":12, "error":"request_is_too_old", “_t”:1452691486}
                   

    Postman instructions

    In order to make API requests please follow these instructions:

  • Go to any request
  • Open Authorization tab
  • Choose OAuth 2.0
  • Press Get New Access Token
  • Enter
    • Token name
    • Grant Type: Authorization Code
    • Auth URL: https://www.freeconferencecall.com/api/v4/authorize
    • Access Token URL: https://www.freeconferencecall.com/api/v4/token
    • Your Client ID
    • Your Client Secret
    • Client Authentication: Send as Basic Auth header
  • Press Request Token
  • Enter your credentials and press Approve
  • Save www.freeconferencecall.com value into "host" param in your environment
  • Fill additional params for the request if needed in Pre-request Script tab
  • Press Send