Orange API
français
FAQ
Here you will find everything you need to know to start using the API.
previous next Can the Orange APIs be accessed in HTTPS? Yes, simply replace the HTTP with HTTPS when you use the Web service method. At what point does one know that an API has been commercially launched? The Orange API Team Orange will inform you of developments to do with the Orange APIs via the API website, and community space. I would like to use the Orange APIs. How do I go about it? To use the APIs of Orange, you must first become a member of the orange api site.This is free and there are rewards to have.Your API Access Key can be found in "my account" of your personal area. The API Access Key is a unique identifier which gives you access to your account.This code is strictly personal and confidential. What does an API in Beta mode means? This term depends on the maturity of the API. An API in Beta mode means that is free to use with daily quotas. Which programming languages can I use to access the Orange APIs? The Orange APIs are independent of any programming language and are accessible from multiple languages. We provide documentation and sample applications in languages such as PHP; however you are certainly not limited to these. I received a 999 error code when I call the API. What does this mean? As part of our ongoing effort to provide you with an excellent service when you receive this error code it means that we are carrying out maintenance work on the APIs. We apologise for any inconvenience and urge you to try again. I received the error code: 442 – unauthorised source for this destination. What does this mean? The format in which you have entered the telephone number is incorrect. The telephone number must be entered in international format. For example 33 (for France) and 44 (for the UK). Remember to omit the first 0 in the telephone number when this is used in local format i.e. 336 12 34 56 78 or 447745298673. How do I flag a bug in the Orange APIs? The best way is to contact us directly by clicking on “contact us” . Who do I contact in the event I cannot use the Orange APIs? Firstly, the product data sheets for each API in the "developer centre" section of the website with which you can familiarize yourself with the APIs. To learn more, you can post your questions in the section: "issues" that you find in the "News & community part of the website. You can also post your responses in the "support" section by clicking on "Contact Us". The Orange API team will personally reply to every posting. How do I test the Orange APIs? Use the API Explorer Tool to test your applications. This tool offers an intuitive interface that allows you to test our APIs and understand their different features. See this feature in "tools". What is the API explorer tool used for? With your Access key, you can call any API and obtain the input and output parameters of that AP. The API explorer tool also provides you with a sandbox in which you can test your application without the need to use your credits. You are also provided with the API returned codes when using the sandbox. What is the API explorer tool? Use and explore different features of our APIs in a single intuitive interface without the need of developing an application. What is a widget? It is a "shortcut" to dynamic content and responds to request for regular information such as the monetary exchange rate of different currencies or the temperature of a place. Of what use is the Tools tab? The Tools (Widget Editor and API Explorer Tool) allow you to use and explore the APIs.
For example, you can call any API and obtain its input and output parameters. This tool is also available in a sandbox that allows you to test your applications without the need to use credits. You will find "Tools" under the "support" section of the Orange API website. Can I auto top up my account? Yes, you can top up your account automatically when you balance falls below a predefined amount. This new feature available in "my account" of the personal space under "manage my account". There you can activate the automatic recharge option, and configure it to suite you. Your account will automatically recharge, so that your service continues to operate. Your payment information is securely stored and, remember that you can disable this option at any time in "my accounts". Orange is PCI-DSS compliant. Can I be alerted if my credit balance is low? Yes, you can set up an "alert" in "my account" on your personal space. This will sent you an email when you credit balance falls below a predefined amount. Can I transfer my reward credits to my API credit balance without going through my bank account? Of course, simply go to “my personal space†in the “my account†section and click on one of 5 packs of credits that we offer, then on the next page, you will be asked if you want to buy these with your credit card or using your "earned credits". Choose "earned credits". I tried to transfer credits to my bank account 15 days ago and my account has not been credited. What should I do? Requests for transfers to a bank account are taken into account at the end of the month, and this usually takes several days to be credited to an account. Can I be alerted if my credit balance is low? Yes, you can set up an "alert" in "my account" on your personal space. This will sent you an email when you credit balance falls below a predefined amount. Is it possible to exchange credits for cash? After having earned credits through income generating APIs (such as receiving SMS), you can transfer your credits of "revenue sharing" to your prepaid account or to your bank account. To do this, go to the tab "My Account" and click on "transfer credits to my bank account. Applications for the purchase of credits can be made at anytime however, the income generating aspect of these purchases will be accounted for on the 1st of the following month. The first transfer will take place on 1 June for bank accounts hosted in France. Where can I buy credits? Go to my personal space and click on "my accounts". It's your personal space. There you can buy credit packs etc. Remember that you are rewarded for total credits purchased. Where can I look up my balance? Go to "my personal space" account and click on "my accounts ". It's your personal space; you can buy, win and easily transfer your credits. What can I see in my Personal Space? Find it: your current credits, your credits earned. You can also buy credits, be alerted by email when you have more credits, and transfer your credits earned to your bank account and then view your transaction history. I have an advertising message on my voicemail and I would like to distribute it to my contacts. What do I do? Use the method "receive voicemashupCall," which lets you receive and then distribute a specific dialogue. Remember that you must distribute a PIN to your contacts so they can listen to your message. This code is provided in your personal space, "my APIs" then click "configure my APIsâ€. Where can I consult sample code for the SMS API? Go to the section “Sample Code†on the product sheet for the SMS API Can I specify an audio to play while the calling is being connected? Indeed, the parameter audioURL allows you to play the audio file of your choice during this wait. What is the purpose of the parameter: CallConfirmation? This parameter is used to request confirmation before placing the call. You can also specify the language of callConfirmation (French or English) by setting the parameter "Lang". I want to make a call, but would like to set a time limit. What should I do? The parameter: “maxduration†allows you to set a time limit (in seconds) on the telephone call. How much does it cost to use the Orange APIs? Everything depends on the API and its "mode". Mode "beta", the APIs is free with restrictions on use, while the APIs launched commercially require the purchase of credits. Rates also vary from one category to another. See the "price" section of the API in question for more information. What are the limitations of the Orange APIs? Currently, the APIs in mode 'alpha' are free, but there are few restrictions on use. For example, a limit of 10 MMS per day. APIs in mode "beta" have certain coverage limits, where only some countries are covered. We are continuously trying to improve our coverage area. Can the APIs be used in any country? Some APIs provide international coverage while others are only available in certain countries. We are continuously improving our coverage so check regularly for updates. For more information on coverage, see the API in question and feel free to browse our blog or our news pages. How do the Orange APIs work? Simply by an http request. For example to use the “sendSMS†method of the SMS API. Simply execute an http request to the method passing the input parameters. http://sms.beta.orange-api.net/sms/sendSMS.xml?id=[your API access key]&from [SMS short code]&to=[telephone number]&content=[text message] Who can use the Orange APIs? Everyone! The Orange APIs have been developed with the professional and amateur developers and small, large and medium size business in mind. What can I do with the Orange APIs? The Orange APIs consist of our proprietary programming interface which can be used to easily build applications that can connect to the Orange network and its platforms. What are the Orange APIs? The Orange APIs (Application Programming Interfaces) are a set of APIs specially designed for use by anyone who wants to use the platforms and services offered by the Orange network in their tailored made applications. My API access key was stolen. What should I do? Your Access Key can be regenerated. Click on "my account" then "Change Access Key. Contact support if you encounter a problem. I have lost my API access key. What should I do? Your Access Key can be regenerated. Click on "my account" then "Change Access Key. Contact support if you encounter a problem. Can I personalise my API access key? No. The key is generated automatically. Should I disclose my API access key on the “question†section when I have an enquiry? No. Never disclose you API access key. How far back does this historic information go? Information on you last 10 calls are stored. What is the "my activity" section of the website used for? There you can access historic information on all the call you have made to the Orange APIs. What is "my personal space"? This space allows you to control and configure everything to do with your APIs via your account (Access Key, prepaid account, revenue sharing, usage history, etc). What is the "Activate" button in the product sheet used for? It allows the configuring of each API:
Can one send an SMS with the short code 51244? No, the only short codes used to send SMS messages are: 20345, 38100, 967482 and 447797805210. Is there a short code reserved for making calls to the UK? No. Although this number is a British one, it is the short code used for international coverage. It can be used to send and receive SMS. We have chosen this number in order that our service has the best international coverage (600 operators to this day). I already use the SMS API. Do I have to create new key words? No. The SMS and MMS API keywords are shared. A keyword added to the SMS API will also work with MMS API and vice versa. How can 1000 or more messages be sent using the SMS API? In a file "directory.txt" input all the telephone numbers of the recipients (unlimited numbers) with a line break between each, like this: 33612345678 33612345678 33612345678Is it possible to put a line break in my message rather than a space? Yes a recently implemented patch allows the inclusion of a line break instead of a space after the keywords in the SMS. You can insert a line break instead of a space after your keyword. Can I change the SMS format? The SMS API uses the GSM 7bit encoding that only supports the Latin alphabet. What is the maximum number of key word can I have for the SMS API? 5 key words. Where can I consult sample code for the SMS API? Go to the section “Sample Code†on the product sheet for the SMS API What is the SMS API? The SMS API allows you to send and receive SMS anywhere in the world. Can I withhold my telephone number when using the click-to-call API? Yes, by using the setting "private". You can either hide the callee’s number, the caller’s or both simultaneously. Where can I see examples of the click-to-call API? Go to the section: “Code Samples†of the click-to-call API product sheet. What is the click-to-call API? The click-to-call API is used to establish telephone calls. How can I get the coordinate when using the location API? Once the authorization has been granted, use the "getLocation" method to access the position of the mobile. The location data will be transmitted in GPS format (i.e. they indicate the latitude and longitude). I did a createAuthorization using a foreign telephone number. Why doesn’t this work? Currently, the service is available for the Orange France mobile network (carrier partners included). A future release will provide multi-operator availability. We can unable to give you a precise date for this, because each country has its own constraints around regulation on privacy and no one broker offers a viable worldwide solution. We must therefore negotiate separately with each country.How long is the authorisation valid for? It is valid until the owner of the mobile unsubscribe to your service by sending an SMS to 20345 with the following message: "no" followed by the service name. What are the steps to geolocate a mobile phone? The end user must send two SMS to confirm his wishes to be geolocated. The process is done in 2 SMS: 1. First you answer "yes" with the service name to 20345 which gives the mobile access to the service and 2. Secondly, you answer "yes locate" to 20633 which gives the mobile access to the orange platform.Can I geolocate a telephone by simply knowing its telephone number? Partly true. You will however, need prior authorisation by the telephone owner to do so. Where can I see example of the location API? Go to the "code sample†section of the fact or product sheet of the location API. What is the location API? The location API allows you to geolocate a mobile. Can I add sound and video to my image? Yes, it is possible; the MMS can contain an image (JPG or GIF), sound (in WAV, MP3 and AMR) and video (in AVI and 3GP). Where can I see and example of the MMS API? Go to the section “code sample†in the MMS API product sheet. What is the MMS Beta API? The MMS API allows multimedia files to be sent and received on mobile, free but with restrictions. Can I send attachments when using the email API? No, the email API does not support attachments. We however appreciate the value of attachments and are working on getting this included in future releases. Where can I see example of the email API? Go to the "code sample†section of the fact or product sheet of the email API. What is the Beta email API? Use the email API to send and receive emails via your website or application. |
Close
You did not find your answer?
You would like more information?
You would like to contact our sales team?
contact us, we will answer on your email address.
Loading...