RingOut API



NOTICE: The RingOut.asp API is deprecated as of March 15, 2018. Existing RingOut.asp API client applications will continue to work normally until Release 10.2, targeted for August 9, 2018. Please plan to migrate to our new, more fully-featured REST API as described in our Developer Guide: https://ringcentral-api-docs.readthedocs.io/en/latest/legacy_api_upgrade/

RingOut API

The RingOut API allows RingCentral customers to invoke the RingOut functionality from a third party application, such as a custom-built database. The API includes 4 commands accessible via a standard HTTP GET or POST call.

List - Get a list of all the numbers you can use to place the call (the phone numbers in the specified users account).
Call - Place call.
Status - Get current call status.
Cancel - Cancel call.

Commands are invoked using secure ASP script located at:
https://service.ringcentral.com/ringout.asp

Important! Clients are required to store HTTP cookies returned by the API server and send them in all subsequent requests during the session.

For simplicity purposes, the examples below show how to call API commands using HTTP GET method with parameters passed in the URL query string. Also, all the commands can be called using HTTP POST method with exactly same parameters passed in the request body.

1. List

Returns a semicolon-separated list of phone numbers from which you can make outbound calls. One of these numbers should be used for the "From" parameter in the "Call" command (see the table below).

Parameter	Description
Cmd	Command identification: "list"
Username	RingCentral main phone number in full format that includes the country code
Ext	Extension number
Password	Account's password

Responses:
Success: OK <list of phone numbers and labels separated by a semicolon>
Error: all other responses which do not include OK.

Example
https://service.ringcentral.com/ringout.asp?cmd=list&username=18889363711&ext=101&password=1234

Response
OK 6505553711;Home;6505551550;Business;6505551233;Mobile

2. Call

Places a call and returns a Session ID call and WS if successful.

Parameter	Description
Cmd	Command identification: "call"
Username	RingCentral main phone number in full format that includes the country code
Ext	Extension number
Password	Account's password
To	Destination number
From	Call back number
Clid	Caller ID number
Prompt	"1" to prompt user to press "1" to connect

Responses:
Success: OK <Session ID> <WS>
Error: all other responses which do not include OK.

Example
https://service.ringcentral.com/ringout.asp?cmd=call&username=18889363711&ext=101&password=1234&
to=6505551230&from=6505551231&clid=8889363711&prompt=1

Response
OK Y3MxNzE4NDE3NzQxMTY4NzczMEAxMC42Mi4yNC4yMzg 3

3. Status

Returns current status of a call.

Parameter	Description
Cmd	Command identification: "status"
SessionID	<Session ID> received from server

Responses:
Completed calls: OK <Session ID> <space>
In other cases: OK <Session ID> followed by 5 groups separated by ';':

General call status number:
- 0 - Success
- 1 - In Progress
- 2 - Busy
- 3 - No Answer
- 4 - Rejected
- 5 - Generic Error
- 6 - Finished
- 7 - International calls disabled
- 8 - Destination number prohibited
Destination number
Destination status (the same as #1)
Call back number
Call back status (the same as #1)

Example
https://service.ringcentral.com/ringout.asp?cmd=status&sessionid=Y3MxNzE4NDE3NzQxMTY4NzczMEAxMC42Mi4yNC4yMzg

Response:
OK Y3MxNzE4NDE3NzQxMTY4NzczMEAxMC42Mi4yNC4yMzg 1;+16505551231;1
OK Y3MxNzE4NDE3NzQxMTY4NzczMEAxMC42Mi4yNC4yMzg 1;+6505551230;1;+16505551231;0

4. Cancel

Cancel a call.

Parameter	Description
Cmd	Command identification: "cancel"
SessionID	<Session ID> received from server

Example
https://service.ringcentral.com/ringout.asp?cmd=cancel&sessionid=Y3MxNzE4NDE3NzQxMTY4NzczMEAxMC42Mi4yNC4yMzg

Response:
OK Y3MxNzE4NDE3NzQxMTY4NzczMEAxMC42Mi4yNC4yMzg