API version 3

It is very easy to manage numbers and check the balance without going through the Console with our easy-to-use and intelligent API. There are no messy libraries or tons of code to manage. The API is available with Premium account only.

Endpoint

https://www.groovl.com/api/v3.php

The API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

Authentication

You will need to post user and token with each request for authentication. To obtain meant credentials, please refer to your account settings.

Legacy

The API version 2 description.

Structure

Please post your requests as JSON. API returns all data as JSON. Do not forget to transmit a resource:

search

Search for available phone numbers.

PropertyDescriptionRequestResponse
pidthe ID of this phone number +
phonean available telephone number
The '*' character will match any digits.
++
carrierthe name of network +
countrythe ISO country code of this phone number++
resourceused resource++
resolution'ok' or 'failed' with some error message  +

activate

Allocate phone number. Before trying to activate a number, use 'search' to retrieve the list of available numbers.

PropertyDescriptionRequestResponse
pidthe ID of this phone number++
phonetelephone number +
resourceused resource++
resolution'ok' or 'failed' with some error message  +

list

Search for active (live) phone numbers associated with your account.

PropertyDescriptionRequestResponse
phonetelephone number
The '*' character will match any digits.
++
statusthe status of number
'1' = Allocation, '2' = Live, '3' = Released, '4' = Storage;
++
countrythe ISO country code of this phone number++
expiresdate of auto renew or expiration (MST) +
autorenewauto-renew:
'0' = On, '1' = Off;
++
pagesa total number of pages
10 numbers per page
 +
pagecurrent page++
resourceused resource++
resolution'ok' or 'failed' with some error message  +

settings

Number settings.

PropertyDescriptionRequestResponse
phonetelephone number++
countrycountry +
namefriendly name +
expiresdate of auto renew or expiration (MST) +
feerenew fee +
autorenewauto-renew:
'0' = On, '1' = Off;
 +
toforward all inbound messages to:
'0' = Disable, '1' = E-mail, '2' = URL;
 +
addressforwarding address +
resourceused resource++
resolution'ok' or 'failed' with some error message  +

update

Update phone number properties.

PropertyDescriptionRequestResponse
phonetelephone number++
namefriendly name+ 
autorenewauto-renew:
'0' = On, '1' = Off;
+ 
toforward all inbound messages to:
'0' = Disable, '1' = E-mail, '2' = URL;
+ 
addressforwarding address+ 
resourceused resource++
resolution'ok' or 'failed' with some error message  +

restore

To restore particular number.

PropertyDescriptionRequestResponse
phonetelephone number++
resourceused resource++
resolution'ok' or 'failed' with some error message  +

cancel

To cancel the subscription for a particular number.

PropertyDescriptionRequestResponse
phonetelephone number++
resourceused resource++
resolution'ok' or 'failed' with some error message  +

balance

Allows you to request current balance.

PropertyDescriptionRequestResponse
balanceaccount current balance +
resourceused resource++
resolution'ok' or 'failed' with some error message  +

The system returns any comments and search results within response property.

Webhook

Use webhooks to be notified about events that happen with numbers under account.

Properties user and token are also included for more security.

PropertyDescription  
actionevents that happen with number:
'number setup', 'number renew', 'number release', 'number restoration';
  
phonetelephone number  
datedate and time (MST)  
resolution'pending', 'done', 'failed';