Skip to content
This repository was archived by the owner on Aug 16, 2023. It is now read-only.

SirBrucey/Zironpy

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
tests
tests
 
 
ziron
ziron
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
setup.py
setup.py
 
 

Repository files navigation

Zironpy

Contents

# TODO * Rewrite Pagination

Places currently uing pagination or will be later: * getCalls * getEndpoints * getMessages * getlookups

# Setup ## Installation ## Testing # Commands

The Ziron developer API is split into multiple sub APIs for different operational aspects.

Each sub API can be imported seperatly; or you can import all of them at once:

import ziron
 ## Accounts

The accounts API allows you to manage your individual Ziron account.

https://zironuk.atlassian.net/wiki/display/docs/Accounts+API

Import:

>>> from ziron import Accounts
>>> accounts = Accounts(sid, auth_token)
### getAccount(*key*)

The getAccount command returns currently set details about your account.

https://zironuk.atlassian.net/wiki/display/docs/Get+Account

Arguments:

  • Required: None

  • Optional:

    • key - Return corresponding value from dictionary

    If key is not specified then all results are returned as a dictionary.

Examples:

>>> print accounts.getAccount()
{u'last_name': u'xxxxx', u'notification_daily': u'0', u'auth_token': u'xxxxx', u'vat_number': u'', 
 u'postpay_billing_cycle': u'm', u'currency': u'GBP', u'postpay_payment_days': u'14', u'address_state': u'xxxxx', 
 u'timezone': u'Europe/London', u'account_name': u'Andrews & Arnold Ltd', u'rates_email': None, 
 u'address_line2': u'xxxxxx', u'first_name': u'xxxxx', u'address_line1': u'xxxxx', u'detailed_lookup': u'1', 
 u'store_content': u'1', u'notification_low_balance': u'1', u'postpay_credit_limit': u'2000.00000', 
 u'sid': u'xxxxx', u'invoice_email': None, u'postpay_invoice_type': u'e', u'email': u'xxxxx', 
 u'default_prefix': u'44', u'show_financials': u'1', u'vat_code': u'gb', u'invoice_account_email': u'1', 
 u'notification_low_balance_level': u'0.00', u'balance_threshold': u'10', u'address_zip': u'xxxxx', 
 u'address_city': u'xxxxx', u'account_ref': u'xxxxx', u'country': u'GB', u'restricted_lookup': u'1', 
 u'default_sender': u'', u'rates_account_email': u'0', u'postpay_enabled': u'1', u'balance': u'1000.00000'}

>>> print accounts.getAccount('currency')
GBP
### updateAccount(*data*)

The update command take a dictionary of the account values you wish to update.

https://zironuk.atlassian.net/wiki/display/docs/Update+Account

Arguments:

  • Required:

    • data - Dicionary of values you wish to update

  • Optional: None

Examples:

>>> account.updateAccount({'first_name': 'Foo', 'last_name': 'Bar'})

<a name"balance"/>

Balance

The balance API allows you to your current account balance.

https://zironuk.atlassian.net/wiki/display/docs/Balance+API

Import:

>>> from ziron import Balance
>>> balance = Balance(sid, auth_token)
### getBalance()

The getBalance command returns your accounts current balance and the ISO 4217 currency code.

https://zironuk.atlassian.net/wiki/display/docs/Get+Balance

Arguments:

  • Required: None
  • Optional: None

Examples:

>>> print balance.getBalance()
{u'currency': u'GBP', u'balance': u'100.00000'}
## Calls

The calls API allows you to retrieve CDRs

https://zironuk.atlassian.net/wiki/display/docs/Calls+API

Import:

>>> from ziron import Calls
>>> calls = Calls(sid, auth_token)
### getCalls(*limit*, *start*, *end*)

The getCalls command allows you to return a list of CDRs for a given number of CDRs or within a given date range.

https://zironuk.atlassian.net/wiki/display/docs/Get+Calls

Arguments:

  • Required: None
  • Optional:
    • limit - Either 1-100 or "all", limit the number number of results returned, if all return all CDRs ever.
    • start - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the start of the daterange you wish to return.
    • end - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the end of the daterange you wish to return.

Examples

>>> print calls.getCalls(limit=1)
[{u'src': u'44xxxxxxxxxx', u'billed_duration': u'0.2333333', u'call_duration': u'0.2333333', 
  u'ts': u'2017-02-07T12:10:57Z', u'sid': u'xxxxxxx', u'type': u'call-in', u'dst': u'44xxxxxxxxxx'}]
>>> calls.getCalls(start="2017-02-07 11:00:00", end="2017-02-07 13:00:00")
[{u'src': u'44xxxxxxxxxx', u'billed_duration': u'0.2333333', u'call_duration': u'0.2333333', 
  u'ts': u'2017-02-07T12:10:57Z', u'sid': u'xxxxxxx', u'type': u'call-in', u'dst': u'44xxxxxxxxxx'}, 
  {u'src': u'44xxxxxxxxx', u'billed_duration': u'20.4000000', u'call_duration': u'20.5333333', 
  u'ts': u'2017-02-07T11:43:04Z', u'sid': u'xxxxxxx', u'type': u'call-in', u'dst': u'44xxxxxxxxxx'}, 
  {u'src': u'44xxxxxxxxx', u'billed_duration': u'0.0000000', u'call_duration': u'0.4000000', 
  u'ts': u'2017-02-07T11:38:30Z', u'sid': u'xxxxxxx', u'type': u'call-in', u'dst': u'44xxxxxxxxxx'}, 
  {u'src': u'44xxxxxxxxx', u'billed_duration': u'0.0000000', u'call_duration': u'0.4833333', 
  u'ts': u'2017-02-07T11:34:29Z', u'sid': u'xxxxxxx', u'type': u'call-in', u'dst': u'44xxxxxxxxxx'}]
## End Points

The end points API allows you to create and manage end points for your account.

https://zironuk.atlassian.net/wiki/display/docs/Endpoints+API

Import:

>>> from ziron import EndPoints
>>> endPoints = EndPoints(sid, auth_token)
### createEndpoint(*type*, *uri*, *description*, *default*)

Create an endpoint.

https://zironuk.atlassian.net/wiki/display/docs/Create+Endpoint

Arguments:

  • Required:
    • type - Type of endpoint, valid options are returned from Get Endpoint Types
    • uri - URI for this endpoint
  • Optional:
    • description - A user defined description for this endpoint
    • default - Make this endpoint the default for all new numbers

Examples:

>>> endPoints.createEndpoint('sms','test','testing',0)
{u'description': u'testing', u'created': u'2017-02-07 16:13:10', u'uri': u'test', 
 u'modified': u'0000-00-00 00:00:00', u'is_default': u'0', u'sid': u'EPd585a551e7239c3a5fbc293b4a0fe900', 
 u'type': u'sms'}
### deleteEndpoint(*sid*)

The deleteEndpoint command deletes an endpoint from your account.

https://zironuk.atlassian.net/wiki/display/docs/Delete+Endpoint

Arguments

  • Required:
    • sid - sid of the created endpoint, use getEndpoints to find the sid.
  • Optional: None

Examples

>>> endPoints.getIndividualEnpoints('EPd585a551e7239c3a5fbc293b4a0fe900')
{u'description': u'testing', u'created': u'2017-02-07 16:13:10', u'uri': u'test', 
u'modified': u'0000-00-00 00:00:00', u'is_default': u'0', u'sid': u'EPd585a551e7239c3a5fbc293b4a0fe900', 
u'type': u'sms'}

>>> endPoints.deleteEndpoint('EPd585a551e7239c3a5fbc293b4a0fe900')
<response 204>

>>> endPoints.getIndividualEnpoints('EPd585a551e7239c3a5fbc293b4a0fe900')
<Response 404>
### getEndpoints(*limit*, *start*, *end*)

The getEnpoints commande retrieves a list of created endpoints.

https://zironuk.atlassian.net/wiki/display/docs/Get+Endpoints

Arguments

  • Required: None
  • Optional:
    • limit - Either 1 -100 or "all", limits the number of endpoints returned.
    • start - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the start of the daterange you wish to return.
    • end - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the end of the daterange you wish to return.

Examples

>>> endPoints.getEndpoints()
[{u'description': u'VOICE', u'created': u'2016-07-27 10:15:13', u'uri': u'xxxxxxx', 
  u'modified': u'2016-07-27 18:40:01', u'is_default': u'1', u'sid': u'xxxxxxx', u'type': u'voice'}, 
  {u'description': u'SMS', u'created': u'2016-07-27 10:16:12', u'uri': u'xxxxxxx', 
  u'modified': u'2016-07-27 11:01:01', u'is_default': u'1', u'sid': u'xxxxxxxxx', u'type': u'sms'}]

>>> print endPoints.getEndpoints(start="2016-07-27 10:00:00", end="2016-07-27 11:00:00
[{u'description': u'VOICE', u'created': u'2016-07-27 10:15:13', u'uri': u'xxxxxxx', 
  u'modified': u'2016-07-27 18:40:01', u'is_default': u'1', u'sid': u'xxxxxxx', u'type': u'voice'}]
### getEnpointTypes()

The getEndpointTypes command returns a list of valid endpoints.

https://zironuk.atlassian.net/wiki/display/docs/Get+Endpoint+Types

Arguments

  • Required: None
  • Optional: None

Examples:

>>> endPoints.getEndpointTypes()
[{u'type': u'voice', u'description': u'Voice'}, {u'type': u'sms', u'description': u'SMS'}, 
 {u'type': u'mms', u'description': u'MMS'}, {u'type': u'fax', u'description': u'Fax'}]
### getIndividualEndpoints(*sid*)

The getIndividualEndpoint command returns information on a single endpoint.

https://zironuk.atlassian.net/wiki/display/docs/Get+Individual+Endpoint

Arguments:

  • Required:
    • sid - The unique sid for the endpoint you wish to retrieve information for.
  • Optional:
    • key - Individual value from dictionary.

Examples:

>>> endPoints.getIndividualEnpoints('EPd585a551e7239c3a5fbc293b4a0fe900')
{u'description': u'testing', u'created': u'2017-02-07 16:13:10', u'uri': u'test',
u'modified': u'0000-00-00 00:00:00', u'is_default': u'0', u'sid': u'EPd585a551e7239c3a5fbc293b4a0fe900',
u'type': u'sms'}

>>> endPoints..getIndividualEndpoint('EPd585a551e7239c3a5fbc293b4a0fe900', 'description')
u'testing'
### updateIndividualEndpoint(*sid*, *type*, *uri*, *description*, *default*)

The updateIndividualEndpoint command lets you update individual fields for an endpoint.

https://zironuk.atlassian.net/wiki/display/docs/Update+Individual+Endpoint

Arguments:

  • Required:
    • sid - The unique sid for the endpoint you wish to edit.
  • Optional:
    • type - Change Endpoint type
    • uri - Change URI of endpoint
    • description - Change description of endpoint
    • default - Change whether the endpoint is the default

Examples:

>>> endPoints.getIndividualEnpoints('EPd585a551e7239c3a5fbc293b4a0fe900')
{u'description': u'testing', u'created': u'2017-02-07 16:13:10', u'uri': u'test',
u'modified': u'0000-00-00 00:00:00', u'is_default': u'0', u'sid': u'EPd585a551e7239c3a5fbc293b4a0fe900',
u'type': u'sms'}

>>> endPoints.updateIndividualEndpoints('EPd585a551e7239c3a5fbc293b4a0fe900', description="A different description")
{u'description': u'A different description', u'created': u'2017-02-07 16:13:10', u'uri': u'test', 
u'modified': u'2017-02-07 17:03:30', u'is_default': u'0', u'sid': u'EPd585a551e7239c3a5fbc293b4a0fe900', 
u'type': u'sms'}
## Messages

The Messages API allows you to send messages and retrieve details of existing messages, including delivery reports.

https://zironuk.atlassian.net/wiki/display/docs/Messages+API

Import:

>>> from ziron import Messages
>>> messages = Messages(sid, auth_token)
### sendMessage(*src*, *dest*, *data*, *message_type*, *mclass*, *mwi*, *callback_url*)

Send a message to one or more recipients. Returns an unpaginated list of message details.

https://zironuk.atlassian.net/wiki/display/docs/Send+a+Message

Arguments:

  • Required:
    • src - Source number or name.
    • dest - Destination number.
    • data - Message body.
  • Optional:
    • message_type - Type of message, defaults to 'sms'
    • mclass - Sets the message class in the DCS field (SMS only), 0-3, i.e. 0 (flash SMS), 1 (mobile), 2 (SIM), 3 (SIM toolkit).
    • mwi - Activate/deactivate the message waiting indicator (SMS only), 0-7, i.e. 0 (activate voicemail), 1 (activate fax), 2 (activate email), 3 (activate other), 4 (deactivate voicemail), 5 (deactivate fax), 6 (deactivate email), 7 (deactivate other).
    • callback_url - URL to receive message status callbacks.

Examples:

>>> messages.sendMessage("44xxxxxxxxxx", "44xxxxxxxxxx", "Testing")
[{u'status': u'queued', u'src': u'44xxxxxxxxxx', u'data': u'Testing', 
  u'dst': u'44xxxxxxxxxx', u'charset': None, u'ts': u'2017-02-08T10:50:32Z', 
  u'parts': u'1', u'sid': u'SMb2887b44ddda90ebdfb51e6331435abf', u'type': u'sms-out'}]
### getMessages(*limit*, *start*, *end*)

Needs redoing

The getMessages command returns a list of messages.

https://zironuk.atlassian.net/wiki/display/docs/Get+Messages

Arguments:

  • Required: None
  • Optional:
    • limit - Either 1-100 or "all", limit the number number of results returned, if all return all CDRs ever.
    • start - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the start of the daterange you wish to return.
    • end - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the end of the daterange you wish to return.

Examples:



### getIndividualMessage(*sid*, *key*)

Return information on an individual message.




https://zironuk.atlassian.net/wiki/display/docs/Get+an+Individual+Message




Arguments:


    

  • Required:

      

    • sid - Unique ID for the message you wish to retrieve the information on.
      • 

    

    • 

  • Optional:

      

    • key - Return an individual value from the dictionary.
      • 

    

    • 



Examples:


>>> messages.getIndividualMessage("SMb2887b44ddda90ebdfb51e6331435abf")
{u'status': u'delivered', u'src': u'447599440428', u'data': u'Testing', u'dst': u'447599440428', u'charset': None, u'ts': u'2017-02-08T10:50:32Z', u'parts': u'1', u'sid': u'SMb2887b44ddda90ebdfb51e6331435abf', u'type': u'sms-out'}

>>> messages.getIndividualMessage("SMb2887b44ddda90ebdfb51e6331435abf", "data")
u'Testing'


### getMessageHistory(*sid*)

Return a list of message statuses. SMS only.




https://zironuk.atlassian.net/wiki/display/docs/Get+Message+History




Arguments:


    

  • Required:

      

    • sid - Unique ID for the message you wish to retrieve the message history for.
      • 

    

    • 

  • Optional: None
    • 



Examples:


>>> messages.getMessageHistory("SMb2887b44ddda90ebdfb51e6331435abf")
[{u'status': u'submitted', u'ts': u'2017-02-08T10:50:32Z'}, {u'status': u'delivered', u'ts': u'2017-02-08T10:50:33Z'}]


### messageDeliveryStats()

Get a list of message statistics for the last 24 hours.




https://zironuk.atlassian.net/wiki/display/docs/Message+Delivery+Statistics




Arguments:


    

  • Required: None
    • 

  • Optional: None
    • 



Examples:


>>> messages.messageDeliveryStats()
[{u'status': u'delivered', u'count': u'6', u'percent': u'6.8182'}]




## Number Range Lookups

The Lookups API allows you to use a range of Number Lookup services.




https://zironuk.atlassian.net/wiki/display/docs/Lookups+API




Import:


>>> from ziron import NumberRangeLookups
>>> nrl = NumberRangeLookups(sid, auth_token)


### HLRLookup(*lookup_type*, *number*)

The HLR Lookup service allows you to query the mobile network for a range of subscriber

information, and can be used for mobile number validation, porting  check, and

roaming status.




https://zironuk.atlassian.net/wiki/display/docs/HLR+Lookup




Arguments:


    

  • Required:

      

    • lookup_type - Type of lookup to perform.
      
Valid values: get_country, hashed_imsi, home_network.
      • 

    • number - The number to lookup. E164 format.
      • 

    

    • 

  • Optional: None
    • 



Note: get_country and hashed_imsi are restricted by default


Examples:


>>> nlr.HLRLookup('home_network','44xxxxxxxxxx')
{u'status': u'success', u'network': u'Foo 3G', 
 u'sid': u'NLeaf71cd334b586f9cbc2d769165402e6', u'mcc': u'234', 
 u'number': u'44xxxxxxxxxx', u'mccmnc': u'234xx', u'country_iso': u'gb', u'mnc': u'xx'}


### numberPortabilityLookup(*number*)

BETA


Performs a Number Portability lookup on a number.




https://zironuk.atlassian.net/wiki/display/docs/Number+Portability+Lookup




Arguments:


    

  • Required:

      

    • number - The number to lookup. E164 format.
      • 

    

    • 

  • Optional: None
    • 



Examples:


>>> nlr..numberPortabilityLookup('44xxxxxxxxxx')
{u'status': u'NO_DATA', u'number': u'44xxxxxxxxxx', 
 u'sid': u'NLd705ce91ca65055384fb820c643b7045'}


Note: In testing I have been unable to get a sucessful response for this command.


All tests have returned as "NO_DATA"


### getLookups()

Note: Complete command once pagination is redone.


The getLookups command returns a list of all lookups.




https://zironuk.atlassian.net/wiki/display/docs/Get+Lookups




Arguments:


Examples:


### getIndividualLookup(*sid*)

Return information on an individual lookup.






Arguments:


    

  • Required:

      

    • sid - Unique ID for the lookup you wish to retrieve the information on.
      • 

    

    • 

  • Optional:

      

    • key - Return an individual value from the dictionary.
      • 

    

    • 



Examples:


>>> nlr.getIndividualLookup('NLeaf71cd334b586f9cbc2d769165402e6')
{u'status': u'success', u'network': u'Foo 3G',
 u'sid': u'NLeaf71cd334b586f9cbc2d769165402e6', u'mcc': u'234',
 u'number': u'44xxxxxxxxxx', u'mccmnc': u'234xx', u'country_iso': u'gb', u'mnc': u'xx'}

>>> nlr.getIndividualLookup('NLeaf71cd334b586f9cbc2d769165402e6','country_iso')
u'gb'




## Numbering

The numbering API allows for purchasing and managing number.








https://zironuk.atlassian.net/wiki/display/docs/Numbering+API








Import:


>>> from ziron import Numbering
>>> numbering = numbering(sid, auth_token)


### getCountries()

Retrieve a list of countries.




https://zironuk.atlassian.net/wiki/display/docs/Get+Countries




Arguments:


    

  • Required: None
    • 

  • Optional: None
    • 



Example:


>>> numbering.getCountries()
[{u'restrictions': u'1', u'has_states': u'0', u'is_onnet': u'0', u'country_code': u'54',
u'country_iso': u'AR', u'country_name': u'Argentina'}, {u'restrictions': u'0', 
u'has_states': u'0', u'is_onnet': u'1', u'country_code': u'61', u'country_iso': u'AU', 
u'country_name': u'Australia'}, {u'restrictions': u'0', u'has_states': u'0', 
u'is_onnet': u'0', u'country_code': u'43', u'country_iso': u'AT', 
u'country_name': u'Austria'}, ...


### getStates(*country_iso*)

Retrieve a list of states within a country that have available numbers.




https://zironuk.atlassian.net/wiki/display/docs/Get+States




Arguments:


    

  • Required:

      

    • country_iso - Country in ISO 3166-1 alpha-2 format (e.g. GB)
      • 

    

    • 

  • Optional: None
    • 



Examples:


>>> numbering.getStates('GB')
[{u'state_name': u'Alabama', u'state_abbr': u'AL', u'country_iso': u'US'}, 
{u'state_name': u'Alaska', u'state_abbr': u'AK', u'country_iso': u'US'}, 
{u'state_name': u'Arizona', u'state_abbr': u'AZ', u'country_iso': u'US'}, 
{u'state_name': u'Arkansas', u'state_abbr': u'AR', u'country_iso': u'US'}, 
{u'state_name': u'California', u'state_abbr': u'CA', u'country_iso': u'US'}, 
{u'state_name': u'Colorado', u'state_abbr': u'CO', u'country_iso': u'US'}, 
{u'state_name': u'Connecticut', u'state_abbr': u'CT', u'country_iso': u'US'}, 
...


### getAreas(*country_iso*, *state*, *number_type*)

Returns a list of numbering areas




https://zironuk.atlassian.net/wiki/display/docs/Get+Areas




Arguments:


    

  • Required:

      

    • country_iso -  Country in ISO 3166-1 alpha-2 format (e.g. GB)
      • 

    

    • 

  • Optional:

      

    • state - ID of state, if the country has states
      • 

    • number_typer - Type of number. Options: local, national, tollfree or mobile.
      • 

    

    • 



Examples:






## Payments
---

## Porting

The Porting API allows you to interact with the Number Porting system to check
portability coverage, create porting requests and letters of authority (LOAs).




https://zironuk.atlassian.net/wiki/display/docs/Porting+API




Import:


>>> from ziron import Porting
>>> porting = porting(sid, auth_token)


### getIndividualPortingCountry(*country_iso*)

Retrieve details of an individual country where numbers can be ported




https://zironuk.atlassian.net/wiki/display/docs/Get+Individual+Porting+Country




Arguments


    

  • Required:

      

    • country_iso - Country in ISO 3166-1 alpha-2 format (e.g. GB)
      • 

    

    • 

  • Optional: None
    • 



Examples:


>>> porting.getIndividualPortingCountry("GB")
[{u'require_authorisation_code': u'0', u'require_loa': u'1', 
  u'require_account_number': u'0', u'require_address': u'1', 
  u'lead_time': u'21', u'port_type': u'multi', u'number_type': u'local'}, 
 {u'require_authorisation_code': u'0', u'require_loa': u'1', 
  u'require_account_number': u'0', u'require_address': u'1', 
  u'lead_time': u'4', u'port_type': u'single', u'number_type': u'local'}, 
 {u'require_authorisation_code': u'1', u'require_loa': u'0', 
  u'require_account_number': u'0', u'require_address': u'0', 
  u'lead_time': u'2', u'port_type': u'consumer', u'number_type': u'mobile'}]


### getPortingCountries()

Retrieve a list of countries where numbers can be ported




https://zironuk.atlassian.net/wiki/display/docs/Get+Porting+Countries




Arguments:


    

  • Required: None
    • 

  • Optional: None
    • 



Examples:


>>> porting.getPortingCountries()
[{u'country_name': u'United Kingdom', u'country_iso': u'GB'}]


### getPortingOperators(*country_iso*, *number_type*)

Returns a list of operators that numbers can be ported from.




https://zironuk.atlassian.net/wiki/display/docs/Get+Porting+Operators




Arguments


    

  • Required:

      

    • country_iso -  Country in ISO 3166-1 alpha-2 format (e.g. GB)
      • 

    

    • 

  • Optional:

      

    • number_typer - Type of number. Options: local, national, tollfree or mobile
      • 

    

    • 



Examples:


>>> porting.getPortingOperators("GB", "local")
[{u'restrictions': None, u'sid': u'POd7a13bbc6255356dc5a0223a4feed4eb', 
  u'operator_name': u'(aq) Limited trading as aql', u'number_type': u'local', 
  u'country_iso': u'gb', u'operator_aliases': None}, 
 {u'restrictions': None, u'sid': u'PO507c40de904498be83e975988e603018', 
  u'operator_name': u'Affiniti Integrated Solutions Ltd', u'number_type': 
  u'local', u'country_iso': u'gb', u'operator_aliases': None}, 
 {u'restrictions': None, u'sid': u'PO3468637336fdd961be86908508846ed3', 
  u'operator_name': u'aql Wholesale Limited', u'number_type': u'local', 
  u'country_iso': u'gb', u'operator_aliases': None}, 
 {u'restrictions': None, u'sid': u'POe6c9a98c6e55d431f97968bed72aaa11', 
  u'operator_name': u'BT', u'number_type': u'local', u'country_iso': u'gb', 
  u'operator_aliases': None}, 
 ...
]


### createPortingRequest()

### getIndividualPortingRequest(*porting_sid*)

Returns an individual porting request




https://zironuk.atlassian.net/wiki/display/docs/Get+Individual+Porting+Request




Arguments:


    

  • Required:

      

    • porting_sid - sid for the port you wish to return details on.
      • 

    

    • 

  • Optional: None
    • 



Examples:


>>> porting.getIndividualPortingRequest('xxxxxx')
{u'status': u'completed', u'ticket_id': u'4021', 
 u'porting_operator_sid': u'xxxxxx', u'ts_modified': u'2016-11-29T13:43:03Z', 
 u'description': u'UK Mobile', u'port_date': u'2016-11-29', 
 u'billing_number': u'44xxxxxxxxxx', u'loa_sid': None, 
 u'sid': u'xxxxx', u'can_cancel': u'0', u'account_number': None, 
 u'port_type': u'consumer', u'address_sid': None, u'country_iso': u'gb', 
 u'number_sid': None, u'ts_created': u'2016-11-28T16:44:00Z', u'email': None, 
 u'number_type': u'mobile'}


### getPortingRequestEvents()

Returns an unpaginated list of porting request events.




https://zironuk.atlassian.net/wiki/display/docs/Get+Porting+Request+Events




Arguments:


    

  • Required:

      

    • porting_sid - sid for the port you wish to return details on.
      • 

    

    • 

  • Optional: None
    • 



Examples:


porting.getPortingRequestEvents('xxxxx')
[{u'status': u'received', u'reason': None, u'reason_code': None, 
  u'ts': u'2016-11-28T16:44:00Z'}, 
 {u'status': u'submitted', u'reason': None, u'reason_code': None, 
  u'ts': u'2016-11-28T16:51:00Z'}, 
 {u'status': u'accepted', u'reason': None, u'reason_code': None, 
  u'ts': u'2016-11-28T21:09:17Z'}, 
 {u'status': u'accepted', u'reason': None, u'reason_code': None, 
  u'ts': u'2016-11-28T23:28:50Z'}, 
 {u'status': u'accepted', u'reason': None, u'reason_code': None, 
  u'ts': u'2016-11-28T23:57:29Z'}, 
 {u'status': u'completed', u'reason': None, u'reason_code': None, 
  u'ts': u'2016-11-29T13:43:03Z'}]


### getPortingRequests()

Returns a paginated list of porting requests




https://zironuk.atlassian.net/wiki/display/docs/Get+Porting+Requests




Arguments:


    

  • Required: None
    • 

  • Optional:

      

    • limit - Either 1-100 or "all", limit the number number of results returned.
      • 

    • start - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the start of the daterange you wish to return.
      • 

    • end - Datetime in the form YYYY-MM-DD HH-MM-SS to signify the end of the daterange you wish to return.
      • 

    

    • 



Examples:


>>> porting.getPortingRequests(limit=1)
[{u'status': u'submitted', u'ticket_id': u'4690', 
  u'porting_operator_sid': u'xxxxx', u'ts_modified': u'2017-04-19T20:56:16Z', 
  u'description': u'xxxxx', u'port_date': u'2017-04-21', 
  u'billing_number': u'xxxxxxxxxxxx', u'loa_sid': None, 
  u'sid': u'xxxxx', u'can_cancel': u'0', u'account_number': None, 
  u'port_type': u'consumer', u'address_sid': None, u'country_iso': u'gb', 
  u'number_sid': None, u'ts_created': u'2017-04-19T20:52:32Z', 
  u'email': u'user@domain', u'number_type': u'mobile'}]


### submitPortingRequest()



## Pricing
---

## Resources
---

## Transactions
---

## Trunks
---





  

    

      

  
About


      

        No description, website, or topics provided.
      



    
Resources

    

      
        
        Readme
    


  





  
  

  

    

      
        Activity    



    
Stars

    

        
          
            0
            stars
        
    


    
Watchers

    

        
          
            1
            watching
        
    


    
Forks

    

      
        0
        forks    



    

      
          Report repository
    




    

  


  
      

        

          

  Releases


    
No releases published


        

      


  
  
  
      

        

          

  
  

  Packages
      



      

        

        
 

      

      

        

        
 

      

      

        

        
 

      




  

        

      


  
  
    

      

        
  
  

    Contributors  


  
    
      
  • 
        
    
      
    • 
      
  • 
        
    
      
    • 
      
  • 
        
    
      
    • 
  


  

      

    


  
      

        

          
Languages