Ringotel Shell Admin API

About Admin API

This Admin API allows you to administer your Ringotel Shell account from your backend.

Transport

This Admin API uses JSON as its communication format.

You can use HTTP as a transport protocol.

The server is listening to the HTTP requests over the SSL/TLS protocol on the 443 port.

Authentication and Authorization

Use API Key generated in your Ringotel Shell admin portal as a Bearer token to authenticate requests on the server. Read more about Ringotel API Settings here.

All API calls should be made to the following URL:

https://shell.ringotel.co/api

Requests format

The requests format includes method and params fields.
The successful response from the server includes the result object (or array of objects in case of multiple results). In case of error, the error object will be returned.

Example

Request:

{
    “method”: “getBranch”, 
    “params”: { 
        "id":"16029679507926612345",
        "orgid":"16029670196176812345" 
    }
}

Response:

{ 
    “result”: { 
        "id": "16029679507926612345", 
        "accountid": "16029670196176812345", 
        "created": 1602967950792, 
        "provision": {...}, 
        "domain": "mydomain", 
        ...
    }
}

Last revision:

April 02, 2024.