Class: apico

apico

new apico(client_sid, client_secret)

apico
Parameters:
Name Type Description
client_sid string your Apico api login
client_secret string your Apico api password
Source:

Methods

delete_app(app_id)

Apico API/subscribers/{subscriber_id}/apps/{app_id}
Parameters:
Name Type Description
app_id string Application id.
Source:

delete_number_callforwardings()

Source:

delete_subscriber()

Apico API/subscribers
Source:

get_app()

Apico API/subscribers/{subscriber_id}/apps/{app_id}
Source:

get_app_list()

Apico API/subscribers/{subscriber_id}/apps
Source:

get_app_number(number)

Apico API/apps/{app_id}/numbers/{number}
Parameters:
Name Type Description
number string The phone number which is being rented.
Source:

get_balance()

Apico API/subscribers/{subscriber_id}/balance
Source:

get_number_callforwardings(number)

Apico API/apps/{app_id}/numbers/{number}/callforwardings
Parameters:
Name Type Description
number string The phone number.
Source:

get_numbers(typeopt, limitopt, offsetopt, limitopt)

Apico API/available-numbers
Parameters:
Name Type Attributes Default Description
type string <optional>
 SIP The type of returning phone numbers. This parameter can either be NATIONAL or SIP.
limit number <optional>
 1 limit
offset number <optional>
 0 offset
limit number <optional>
 1 limit
Source:

get_numbers_by_app()

Apico API/apps/{app_id}/numbers
Source:

get_numbers_list()

Apico API/subscribers/{subscriber_id}/numbers
Source:

get_sip_numbers(offsetopt, limitopt)

Parameters:
Name Type Attributes Default Description
offset number <optional>
 0 offset
limit number <optional>
 1 limit
Source:

get_subscriber_info()

Apico API/subscribers/{subscriber_id}
Source:

get_subscribers_list()

Apico API/subscribers
Source:

login(client_sid, client_secret, grant_typeopt)

Apico API/login
Parameters:
Name Type Attributes Default Description
client_sid string your Apico api login
client_secret string your Apico api password
grant_type string <optional>
 client_credentials your Apico api grant_type
Source:

logout()

Apico API/login
Source:

new_subscriber()

Apico API/subscribers
Source:

release_number(number)

Apico API/apps/{app_id}/numbers/{number}
Parameters:
Name Type Description
number string The phone number which is being rented.
Source:

rent_number(number, noteopt)

Apico API/apps/{app_id}/numbers
Parameters:
Name Type Attributes Default Description
number string The phone number which is being rented.
note string <optional>
 "Web SDK number" A short description of the phone number
Source:

save_app(name, description, url)

Apico API/subscribers/{subscriber_id}/apps/{app_id}
Parameters:
Name Type Description
name string Application name (255 characters max).
description string Application description (255 characters max).
url string The URL to the developer’s website or the page of the application on App Store or Google Play (255 characters max).
Source:

set_number_callforwardings(number, redirects)

Apico API/apps/{app_id}/numbers/{number}
Parameters:
Name Type Description
number string The phone number which is being rented.
redirects array An array with the redirection settings.
Properties
Name Type Description
order number A number specifying the order of priority the redirect_number is tried after another. Several redirect numbers may have the same priority order. In this case they all ring at the same time.
redirect_number string A string specifying forwarding destination in E. 164 format.
redirect_name string A string describing forwarding destination represented in symbols.
active string A string specifying if this call forwarding configuration is currently active. Either Y or N.
period string A string specifying time period in which this call forwarding configuration should be active. You can specify limitations regarding the time of day, day of the week, day of the month, or some combination of these.
period_description string A string describing time period in which this call forwarding configuration should be active.
Source:

update_app(name, descriptionopt, url, app_id)

Apico API/subscribers/{subscriber_id}/apps/{app_id}
Parameters:
Name Type Attributes Description
name string Application name (255 characters max).
description string <optional>
 Application description (255 characters max).
url string The URL to the developer’s website or the page of the application on App Store or Google Play (255 characters max).
app_id string Application id.
Source:

update_number(number, noteopt, passwordopt)

Apico API/apps/{app_id}/numbers/{number}
Parameters:
Name Type Attributes Default Description
number string The phone number which is being rented.
note string <optional>
 "Web SDK number" A short description of the phone number
password string <optional>
 Password for this number.
Source:

update_number_callforwardings()

Source:

update_subscriber()

Apico API/subscribers
Source: