click-to-conf API

printer-friendly format

The Orange click-to-conf API allows you to easily create a telephone conference, reachable via incoming calls (the participants call the conference) and outgoing calls (the conference calls the participants).

When you have finished with this section, go to the documentation

To try out our APIs, simply :

1. Register using the API Manager
2. Use the API explorer tool

click-to-conf API

overview
technical features
tarifs

The coverage zone for outgoing calls (ie. where the conference calls participants) is the same as that of the click-to-call API

For outgoing calls the Orange Partner account holder pays for the call at the same rate as that of the click-to-call. The account holder also pays the conference reservation cost (€0.08/min).

Incoming calls (ie. where the participants call the conference) can only be made from France.
For each call to this number we will give you 2 free credits per minute.

For incoming calls, the conference telephone number (provided by the API) is a caller-paid number, and therefore the person calling into the conference will be charged at a rate of €0.15 (15 Euro cents) per minute.

In summary, the click-to-conf API allows you to :

create a telephone conference
directly reach those invited to the conference (outgoing calls)
be contactable by people wishing to participate in the conference (incoming calls)

- The web service exposes a REST-RPC style interface.
- The requests use GET and POST methods in HTTP or HTTPS mode.

the click-to-conf API methods :

- createConference :
Creates a conference call. You can specify the conference start date, the conference duration and its access mode.

- addCaller
Allows a participant to join a conference (if the conference requires caller authentication).

This method can be used before but also during the conference.

- createCall
Allows the telephone conference to call a guest (this is the same method as that of the click-to-call API)

- incoming call
Receives an incoming call to redirect it to your conference. This parameter does not strictly belong to the API, since incoming calls are initiated by the caller.

Compatibility with the VoiceMashup API :
It is possible to join a telephone conference using our VoiceMashup API. Use the macro VXML "transfer" and specify the conference identifier instead of a phone number ( "id" parameter).

As follows:

<macro name="transfer">
<input name="to" value="conf:12a34b"/>

For more information

Presently the API is in beta mode.

This means that it is based around a commercial model allowing you to purchase credits for outgoing calls.

And you can also earn credits for incoming calls.

It will cost you credits each time you make outgoing calls. The cost is deducted from your pre-pay account. There are special offers when you top-up by a certain amount, see below:

click-to-call pricing

You can check how much credit you have left, top-up your account (using Visa or Mastercard) and view how much you've earned in the API Manager

The cost of using the click-to-conf API :

method	limitation	cost (in credits)
createConference	unlimited use	free
addCaller	unlimited use	free
incomingCall	- maximum of 2 hours (depending on the conference start time) - Only available from France	For each participant, you earn : 2 credits per minute
createCall	maximum of 2 hours (depending on the conference start time)	price of communication to participant + 8 credits per minute

access the terms & conditions of use

bookmark and share

what is social bookmarking?

del.icio.us

Digg

facebook

Google

StumbleUpon

technorati