Use RingOut API | RingCentral
Article |
| Summary | The RingOut API (Application Programming Interface) allows RingCentral customers to invoke the RingOut functionality from a third party application, such as a custom-built database. Follow the steps below to learn how to use the RingCentral RingOut API |
|---|
| Details |
List commandThis command 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.
|
|---|
| Success: | OK <list of phone numbers and labels separated by a semicolon> |
| Error: | all other responses which do not include OK. |
Sample command and response
Command: | https://service.ringcentral.com/ringout.asp?cmd=list&username=18889363711&ext=101&password=1234 |
| Response: | OK 6505553711;Home;6505551550;Business;6505551233;Mobile |
[Go to RingOut API commands using POST, GET, DELETE methods]
Call command
This command 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. |
Sample command and response
Command: | https://service.ringcentral.com/ringout.asp?cmd=call&username=18889363711&ext=101&password=1234& to=6505551230&from=6505551231&clid=8889363711&prompt=1 |
| Response: | OK 18 3 |
[Back to RingOut API commands using HTTP GET or HTTP POST]
[Go to RingOut API commands using POST, GET, DELETE methods]
Status command
This command 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 ';': |
1. 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
2. Destination number (the same as #1)
3. Destination status
4. Call back number
5. Call back status (the same as #1)
Sample command and response
Command: | https://service.ringcentral.com/ringout.asp?cmd=status&sessionid=18 |
| Response: | OK 18 4;6505551230;5;6505551231;5 |
[Go to RingOut API commands using POST, GET, DELETE methods]
Cancel command
This command cancels a call.PARAMETER | DESCRIPTION |
Cmd | Command identification: "cancel" |
SessionID | <Session ID> received from server |
Sample command and response
Command: | https://service.ringcentral.com/ringout.asp?cmd=cancel&sessionid=18 |
| Response: | OK 18 |
[Go to RingOut API commands using POST, GET, DELETE methods]
RingOut API commands using POST, GET, DELETE methods
The API treats a two-legged RingOut call as a resource that can be created, retrieved, or deleted via the POST, GET and DELETE methods correspondingly.Making a Call
Polling Call Status
Call Control
Caller ID
Making a Call
A RingOut call can be created using the following request:
POST /restapi/v1.0/account/~/extension/~/ringout Content-Type: application/json Authorization: Bearer <access-token> { "from": {"phoneNumber": "13443334444 "}, /* from parameter is optional if there is a default number in user's forwarding numbers */
"to": {"phoneNumber": "13453443434 "}, /* to parameter is required */
"playPrompt": true /* optional field */
} |
Where:
|
|
|
|
|
|
|
|
|
Response
The response can be as follows:
|
|
Where:
callStatus can take the following values:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Call status is generated as a combination of both call legs statuses (caller and callee):
callerStatus, calleeStatus can take the following values:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Caller or Callee statuses are separately generated for the target call party:
RingOut Flow
The statuses are changing statuses are changing during a successful call.A failed call can be illustrated as follows.
[Back to RingOut API commands using POST, GET, DELETE methods]
[Go to RingOut API commands using HTTP GET or HTTP POST]
Polling Call Status
Use polling to get the status of an ongoing outbound call.
|
GET/restapi/v1.0/account/~/extension/~/ringout/234343434 |
Response
The response is as follows:|
|
[Back to RingOut API commands using POST, GET, DELETE methods]
[Go to RingOut API commands using HTTP GET or HTTP POST]
Call Control
Currently, the RingCentral Connect Platform does not support the control of outbound calls. However, you can cancel a RingOut call while the callee party status is InProgress. You will need to make a DELETE request to ringout URI.|
|
[Back to RingOut API commands using POST, GET, DELETE methods]
[Go to RingOut API commands using HTTP GET or HTTP POST]
Caller ID
RingCentral allows Users to select a number to use for their Caller ID Name (CNAM) value when making calls. You need to set the "RingOut from Web" value as available in the RingCentral Online account. in order to set the CallerId for the RingOut API.
See Outbound Caller ID Name Overview and Frequently Asked Questions for more information.
Other RingOut Options
The RingOut feature is available on the RingCentral Online account, RingCentral Desktop app, and RingCentral Mobile app. For more information, click on the links below:
Using the RingOut from your RingCentral Online Account
Using RingOut on the RingCentral Desktop App
Enabling RingOut on your RingCentral Mobile app
See Also
Tools for DevelopersRingCentral RingOut
| Ranking |
|---|