v4

TeleCloud.app is the fourth and latest update to the premium telecom billing and provisioning system previously known as TeleKloud. In this version (v4), we've completely rebuilt the API from the ground up. The latest API rebuild comes with major speed enhancements, new features, and continues to maintain the original vision of the telecom platform.

Learn : Authentication


In order to utilize the TeleCloud.app API you’ll need an API key, you can generate the key in the TeleCloud.app web interface by clicking your profile icon in the upper right corner and choosing the "API Credentials" option. In addition to your API key you'll' need your API_ID_KEY, this is identifies your user name on the TeleCloud.app system but is different from your user name.

API_ID_KEY : Specific to your TeleCloud.app user name, found in the interface on the "Profile" screen.
API_KEY : An API key specific to your account and account type.

Both the API_ID_KEY and the API_KEY are required for all request and are passed as part of the request (GET,POST,PATCH,DELETE, etc).


Learn : Errors & Exceptions


All errors are returned in the name-space accompanied by a description of the error. Errors on all API's except "Search" methods are recorded for future reference.

        <telecloud trans_id="3123860">
        <error>
        A full dollar amount must be supplied for the discount price.
        </error>
        </telecloud> 
      
The 'trans_id' is returned on all successful transactions and errors, use it to access the transactions details later using the 'Transaction/Search' service.


Learn : Code Examples


All API methods now include example code in the popular PHP programming language, just click the "Code Example" tab on any API. To utilize the provided example code you'll need the TeleCloud.app PHP class, you can download it below.

Download TeleCloud PHP Class



Changelog : What's new?


Initial V4 Development

- The system is undergoing a name change from TeleKloud to TeleCloud.app, as a result the API endpoint has changed to https://telecloud.app/API/. The secureaccesspoint.com domain will no longer be utilized for TeleCloud.
- All API request (excluding Search services) now return a 'trans_id'. The 'Transaction/Search' method can be used to review the transaction at a later date.
- The authentication method has changed, each cloud user now has a API_ID_KEY. The API_ID_KEY is used in conjunction with the cloud accounts API_KEY to access API functions.
- TeleCloud users will no longer authenticate with their email address, each user now has a unique user name. This allows the same email to be utilized across different brands hosted on the TeleCloud platform.
- The 'Customer/Estimate' service now gives the option of specifying if the estimate is for new orders or replenishments, therefore providing a more accurate estimate.
- Promo codes (ie. coupons) have been implemented for new orders and can be passed as 'promo_code' on 'Order/Create' and 'Customer/Estimate' methods. Promo codes can be managed with the 'Promo/' group of methods.
- Customer accounts now support 'credit' allowing VAR's to issue and deduct credit to/from customer accounts using the 'Customer/Credit' service. Available credit is utilized on new orders or replenishments as a discount.
- Support tickets now support image attachments. Attachments are passed as 'attachments' on 'Ticket/Create' and 'Ticket/Reply' services.
- Support tickets have new status descriptions, they are OPEN, ANSWERED, and CLOSED. Answered tickets automatically close in 72 hours, any reply will set the ticket as "OPEN" again.
- Guest (non-customer and non-staff) can now open and reply to external tickets, this allows the ticketing system to be used for potential customers (ie. sales) as well as current customers.
- Orders can now be moved from one customer account to another using the 'Order/Move' method.
- Credit or debits on a cloud account can now be reversed by the controlling cloud account using the 'Billing/Reverse' method.
- Prepaid cloud accounts (PARTNER, VAR, or AFFILIATE) can now add funds with credit card using the 'Billing/AddFunds' method.
- The 'PaymentMethod' service now handles the management of customer and cloud account payment methods. Providing 'account_number' indicates a payment method connected to a customer account.
- Payment method verification for cloud accounts has been simplified and now utilizes "micro debits". When a user adds a new credit card (PaymentMethod/Create) two small micro debits will be charged to the card, the micro debits can then be verified using the 'PaymentMethod/Verify' method making the card available for use.
- Payment history is now logged for customer payments using a credit card, history can be obtained using the 'PaymentMethod/Search' method and passing an 'account_number' and 'payment_method_id'.
- Customer accounts can now be deleted using the 'Customer/Delete' method.
- VAR rate plans can now be deleted using the 'Plan/Delete' method. Customers on the plan will need to select a new plan during replenishment.
- All minimum character limits (Example: Ticket subject, names, etc) have been evaluated and improved.
- Customer accounts now have referral codes, these referral codes can be passed with new orders (Order/Create) as the 'referral_code" parameter.

-- RESTful API Documentation --


Customer


Customer/Search

Search for a customer account or multiple customer accounts using a variety of different criteria. When account_number is provided customer notes and notifications are returned. NOTE: Although you can search for customers by order criteria, this service will not show orders.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Customer/Search
Parameters
Variable Required Description
account_number
Provide the account number to load one specific account.
company
Company name as listed on the account.
first_name
First name as listed on the account.
last_name
Last name as listed on the account.
address
Street address as listed on the account.
unit_type
Unit type as listed on the account.
unit_number
Unit number as listed on the account.
zip_code
Zip code as listed on the account.
email
E-Mail address as listed on the account.
phone
Phone number as listed on the account.
password
Account password
DL
Drivers license as listed on the account.
SSN
Social secutity number as listed on the account.
customfield_1
The value (if any) of the custom field.
order_number
[Orders] Provide when searching for a specific customer by order number.
service_status
[Orders] The service staus if order_number is provided
productid
[Orders] The product ID associated with a specific order on a customer account.
productid_var
[Orders] The VAR product ID associated with a specific order on a customer account.
VAR1
[Orders] VAR1 as listed on an order belonging to the customer account.
VAR2
[Orders] VAR2 as listed on an order belonging to the customer account.
VAR3
[Orders] VAR3 as listed on an order belonging to the customer account.
VAR4
[Orders] VAR4 as listed on an order belonging to the customer account.
VAR5
[Orders] VAR5 as listed on an order belonging to the customer account.
VAR6
[Orders] VAR6 as listed on an order belonging to the customer account.
VAR7
[Orders] VAR7 as listed on an order belonging to the customer account.
VAR8
[Orders] VAR8 as listed on an order belonging to the customer account.
VAR9
[Orders] VAR9 as listed on an order belonging to the customer account.
VAR10
[Orders] VAR10 as listed on an order belonging to the customer account.
VAR11
[Orders] VAR11 as listed on an order belonging to the customer account.
VAR12
[Orders] VAR12 as listed on an order belonging to the customer account.
VAR13
[Orders] VAR13 as listed on an order belonging to the customer account.
VAR14
[Orders] VAR14 as listed on an order belonging to the customer account.
VAR15
[Orders] VAR15 as listed on an order belonging to the customer account.
VAR16
[Orders] VAR16 as listed on an order belonging to the customer account.
VAR17
[Orders] VAR17 as listed on an order belonging to the customer account.
VAR18
[Orders] VAR18 as listed on an order belonging to the customer account.
VAR19
[Orders] VAR19 as listed on an order belonging to the customer account.
VAR20
[Orders] VAR20 as listed on an order belonging to the customer account.
Successful Response

      {
    "customer": {
        "@attributes": {
            "account_number": "7104734"
        },
        "COREID": "9987418300",
        "VARID": "1141482592",
        "PARTNERID": {},
        "AFFILIATEID": {},
        "CREATION_DATE": "2018-05-15",
        "CREATION_USER": "some_username1",
        "COMPANY": {},
        "FIRST_NAME": "Gina",
        "LAST_NAME": "Hammond",
        "ADDRESS": "3132 Main St",
        "UNIT_TYPE": {},
        "UNIT_NUMBER": {},
        "CITY": "HARRISBURG",
        "STATE": "PA",
        "ZIP_CODE": "17109",
        "COUNTRY": "United States",
        "EMAIL": "customer@gmail.com",
        "PHONE": "2145551212",
        "PASSWORD": "88888811",
        "DL": {},
        "SSN": {},
        "CUSTOM_FIELD_1": {},
        "CUSTOM_FIELD_2": {},
        "PAYMENT_METHOD_TYPE": {},
        "PAYMENT_METHOD_ID": {},
        "LOCATION_TYPE": "Residential",
        "ACCOUNT_CREDIT": "65.00",
        "STATUS": "1"
    }
}
      

<telecloud>
  <customer account_number="7104734">
    <COREID>9987418300</COREID>
    <VARID>1141482592</VARID>
    <PARTNERID />
    <AFFILIATEID />
    <CREATION_DATE>2018-05-15</CREATION_DATE>
    <CREATION_USER>some_username1</CREATION_USER>
    <COMPANY />
    <FIRST_NAME>Gina</FIRST_NAME>
    <LAST_NAME>Hammond</LAST_NAME>
    <ADDRESS>3132 Main St</ADDRESS>
    <UNIT_TYPE />
    <UNIT_NUMBER />
    <CITY>HARRISBURG</CITY>
    <STATE>PA</STATE>
    <ZIP_CODE>17109</ZIP_CODE>
    <COUNTRY>United States</COUNTRY>
    <EMAIL>customer@gmail.com</EMAIL>
    <PHONE>2145551212</PHONE>
    <PASSWORD>88888811</PASSWORD>
    <DL />
    <SSN />
    <CUSTOM_FIELD_1 />
    <CUSTOM_FIELD_2 />
    <PAYMENT_METHOD_TYPE />
    <PAYMENT_METHOD_ID />
    <LOCATION_TYPE>Residential</LOCATION_TYPE>
    <ACCOUNT_CREDIT>65.00</ACCOUNT_CREDIT>
    <STATUS>1</STATUS>
  </customer>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'company' => "",'first_name' => "",'last_name' => "",'address' => "",'unit_type' => "",'unit_number' => "",'zip_code' => "",'email' => "",'phone' => "",'password' => "",'DL' => "",'SSN' => "",'customfield_1' => "",'order_number' => "",'service_status' => "",'productid' => "",'productid_var' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "");

try { $responce = $tc->request('Customer/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Search service using the API simulator.


Customer/Create

Create a new customer account.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Customer/Create
Parameters
Variable Required Description
company
first_name
last_name
address
unit_type
Required if providing a unit_number. Examples include APT or SUITE. unit_number
zip_code
email
phone
password
Eight numeric digits
DL
SSN
country
Leave blank to default to United States
CITY
Required for international addresses only.
STATE
Required for international addresses only.
customfield_1
Optional custom value for your records.
customfield_2
Optional custom value for your records.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123489"
    },
    "customer": {
        "account_number": "88515144"
    }
}
      

<telecloud trans_id="3123489">
  <customer>
    <account_number>88515144</account_number>
  </customer>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('company' => "",'first_name' => "",'last_name' => "",'address' => "",'unit_type' => "",'zip_code' => "",'email' => "",'phone' => "",'password' => "",'DL' => "",'SSN' => "",'country' => "",'CITY' => "",'STATE' => "",'customfield_1' => "",'customfield_2' => "");

try { $responce = $tc->request('Customer/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Create service using the API simulator.


Customer/Edit

Edit an existing customer account.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Customer/Edit
Parameters
Variable Required Description
account_number
The account number you wish to edit.
company
first_name
last_name
address
unit_type
Required if providing a unit_number. Examples include APT or SUITE. unit_number
zip_code
email
phone
password
Eight numeric digits
DL
SSN
country
Leave blank to default to United States
CITY
Required for international addresses only.
STATE
Required for international addresses only.
customfield_1
Optional custom value for your records.
customfield_2
Optional custom value for your records.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123489"
    },
    "customer": {
        "account_number": "88515144"
    }
}
      

<telecloud trans_id="3123489">
  <customer>
    <account_number>88515144</account_number>
  </customer>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'company' => "",'first_name' => "",'last_name' => "",'address' => "",'unit_type' => "",'zip_code' => "",'email' => "",'phone' => "",'password' => "",'DL' => "",'SSN' => "",'country' => "",'CITY' => "",'STATE' => "",'customfield_1' => "",'customfield_2' => "");

try { $responce = $tc->request('Customer/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Edit service using the API simulator.


Customer/Delete

Delete an existing customer account. Accounts with orders can't be deleted.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/Customer/Delete
Parameters
Variable Required Description
account_number
The account number you wish to delete.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123489"
    },
    "account_number": "8565441",
    "status": "2"
}
      

<telecloud trans_id="3123489">
  <account_number>8565441</account_number>
  <status>2</status>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "");

try { $responce = $tc->request('Customer/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Delete service using the API simulator.


Customer/Qualify

Used to determine which services are available for provisioning on a specific customer account. For certain services this API "qualifies" based on the address on the account (such as wireless or cable internet). The returned results can then be used to place an order using the Customer/Order service.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Customer/Qualify
Parameters
Variable Required Description
account_number
The customer account number.
ORDER_NUMBER
Required when qualify_type is REPLENISH or product_type is ADD-ON
qualify_type
Either 'NEW' for new orders or 'REPLENISH' (shows products only from the product group of the order)
product_type
The type of products you wish to show. Empty shows all. Options are TRADITIONAL and ADD-ON.
VAR1
Provide the value of VAR1 to post it to any real-time option URL's
VAR2
Provide the value of VAR2 to post it to any real-time option URL's
VAR3
Provide the value of VAR3 to post it to any real-time option URL's
VAR4
Provide the value of VAR4 to post it to any real-time option URL's
VAR5
Provide the value of VAR5 to post it to any real-time option URL's
VAR6
Provide the value of VAR6 to post it to any real-time option URL's
VAR7
Provide the value of VAR7 to post it to any real-time option URL's
VAR8
Provide the value of VAR8 to post it to any real-time option URL's
VAR9
Provide the value of VAR9 to post it to any real-time option URL's
VAR10
Provide the value of VAR10 to post it to any real-time option URL's
VAR11
Provide the value of VAR11 to post it to any real-time option URL's
VAR12
Provide the value of VAR12 to post it to any real-time option URL's
VAR13
Provide the value of VAR13 to post it to any real-time option URL's
VAR14
Provide the value of VAR14 to post it to any real-time option URL's
VAR15
Provide the value of VAR15 to post it to any real-time option URL's
VAR16
Provide the value of VAR16 to post it to any real-time option URL's
VAR17
Provide the value of VAR17 to post it to any real-time option URL's
VAR18
Provide the value of VAR18 to post it to any real-time option URL's
VAR19
Provide the value of VAR19 to post it to any real-time option URL's
VAR20
Provide the value of VAR20 to post it to any real-time option URL's
Successful Response

      {
    "customer": {
        "@attributes": {
            "account_number": "9105012"
        },
        "qualify": {
            "COREProduct": {
                "@attributes": {
                    "id": "337"
                },
                "REPLENISH_GROUP": "73",
                "NAME": "POWER PACK - 1GB OF DATA",
                "TYPE": "ADD-ON",
                "DESCRIPTION": "\nUse this add-on to add 1GB of data ($8 cash value) to the cash balance for subscribers on the By the Gig plan.\n",
                "SETUP_PRICE": "0.00",
                "PRICE": "8.00",
                "EXPIRATION_DAYS": "WITH PLAN",
                "STATUS": "1",
                "GROUP": "GSMA Network",
                "PROMPT_FOR_VARIABLES": "N",
                "REPLENISH_WITH_PLAN": "N",
                "VAR1": "IMEI",
                "VAR2": "ICCID",
                "VAR3": "MDN",
                "VAR4": "Number_Port",
                "VAR5": "Account_Number",
                "VAR6": "PIN_or_Password",
                "VAR7": "SSN_or_Tax_ID",
                "VAR8": "Number_to_Port",
                "VAR9": "MINUTES_USAGE",
                "VAR10": "SMS_USAGE",
                "VAR11": "DATA_USAGE",
                "VAR12": "CASH_BALANCE",
                "VAR13": "ACTIVATION_ID",
                "VAR14": "SUBSCRIBER_ID",
                "VAR15": "PORT_STATUS",
                "VARProduct": {
                    "@attributes": {
                        "id": "52808"
                    },
                    "STATUS": "1",
                    "SETUP_PRICE": "0.00",
                    "PRICE": "8.00",
                    "DESCRIPTION": "$8 of cash value or 1GB of data.",
                    "NAME": "YourBrand PowerPack",
                    "VARID": "1992093776",
                    "PRODUCTID": "337"
                }
            }
        }
    }
}
      

<telecloud>
  <customer account_number="9105012">
    <qualify>
      <COREProduct id="337">
        <REPLENISH_GROUP>73</REPLENISH_GROUP>
        <NAME>POWER PACK - 1GB OF DATA</NAME>
        <TYPE>ADD-ON</TYPE>
        <DESCRIPTION>Use this add-on to add 1GB of data ($8 cash value) to the cash balance for subscribers on the By the Gig plan.</DESCRIPTION>
        <SETUP_PRICE>0.00</SETUP_PRICE>
        <PRICE>8.00</PRICE>
        <EXPIRATION_DAYS>WITH PLAN</EXPIRATION_DAYS>
        <STATUS>1</STATUS>
        <GROUP id="73">GSMA Network</GROUP>
        <PROMPT_FOR_VARIABLES>N</PROMPT_FOR_VARIABLES>
        <REPLENISH_WITH_PLAN>N</REPLENISH_WITH_PLAN>
        <VAR1 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the IMEI from the GSM device." SWAPABLE="Y" PROMPT="Y" CATEGORY="Device Information">IMEI</VAR1>
        <VAR2 TYPE="TEXT" OPTIONS="" DESCRIPTION="The ICCID or number from the SIM card." SWAPABLE="Y" PROMPT="Y" CATEGORY="Device Information">ICCID</VAR2>
        <VAR3 TYPE="TEXT" OPTIONS="" DESCRIPTION="The subscribers mobile device number." SWAPABLE="N" PROMPT="N" CATEGORY="Mobile Number">MDN</VAR3>
        <VAR4 TYPE="OPTIONS" OPTIONS="YES,NO" DESCRIPTION="Select YES if porting an existing number." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Number_Port</VAR4>
        <VAR5 TYPE="TEXT" OPTIONS="" DESCRIPTION="The customers account number with the previous provider." SWAPABLE="Y" PROMPT="Y" CATEGORY="Porting Information">Account_Number</VAR5>
        <VAR6 TYPE="TEXT" OPTIONS="" DESCRIPTION="The PIN or password with the previous provider." SWAPABLE="Y" PROMPT="Y" CATEGORY="Porting Information">PIN_or_Password</VAR6>
        <VAR7 TYPE="TEXT" OPTIONS="" DESCRIPTION="Required when porting from a postpaid accounts only." SWAPABLE="Y" PROMPT="Y" CATEGORY="Porting Information">SSN_or_Tax_ID</VAR7>
        <VAR8 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the 10 digit mobile number you wish to port." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Number_to_Port</VAR8>
        <VAR9 TYPE="TEXT" OPTIONS="" DESCRIPTION="Minutes utilized on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">MINUTES_USAGE</VAR9>
        <VAR10 TYPE="TEXT" OPTIONS="" DESCRIPTION="SMS utilized on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">SMS_USAGE</VAR10>
        <VAR11 TYPE="TEXT" OPTIONS="" DESCRIPTION="Data utilized on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">DATA_USAGE</VAR11>
        <VAR12 TYPE="TEXT" OPTIONS="" DESCRIPTION="Cash remaining on the account for extra services." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">CASH_BALANCE</VAR12>
        <VAR13 TYPE="TEXT" OPTIONS="" DESCRIPTION="Activation ID from the HEG wireless API" SWAPABLE="N" PROMPT="N" CATEGORY="Account Information">ACTIVATION_ID</VAR13>
        <VAR14 TYPE="TEXT" OPTIONS="" DESCRIPTION="The HEG subscriber ID" SWAPABLE="N" PROMPT="N" CATEGORY="Account Information">SUBSCRIBER_ID</VAR14>
        <VAR15 TYPE="TEXT" OPTIONS="" DESCRIPTION="The status code of the number port." SWAPABLE="N" PROMPT="N" CATEGORY="Porting Information">PORT_STATUS</VAR15>
        <VARProduct id="52808">
          <STATUS>1</STATUS>
          <SETUP_PRICE>0.00</SETUP_PRICE>
          <PRICE>8.00</PRICE>
          <DESCRIPTION>$8 of cash value or 1GB of data.</DESCRIPTION>
          <NAME>YourBrand PowerPack</NAME>
          <VARID>1992093776</VARID>
          <PRODUCTID>337</PRODUCTID>
        </VARProduct>
      </COREProduct>
    </qualify>
  </customer>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'ORDER_NUMBER' => "",'qualify_type' => "",'product_type' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "");

try { $responce = $tc->request('Customer/Qualify','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Qualify service using the API simulator.


Customer/Estimate

Returns a billing estimate when provided a specific customer account number and VAR service plan ID. Information returned includes estimated balance and the orders expiration date.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Customer/Estimate
Parameters
Variable Required Description
estimate_type
Options are 'NEW' for new orders or 'REPLENISH' for replinishments.
account_number
The customers account number
rate_plan_id
The VAR rate_plan_id
promo_code
To include a promotional code in the estimate provide the promo_code value.
Successful Response

      {
    "customer": {
        "@attributes": {
            "account_number": "7105045"
        },
        "estimate": {
            "plan": {
                "@attributes": {
                    "rate_plan_id": "52747",
                    "product_id": "330"
                }
            },
            "customer": {
                "setup_price": "0.00",
                "recurring_price": "25.00",
                "promo": "12.35",
                "total": "12.65",
                "cycle_length": "30",
                "expiration_date": "8\/15\/2019"
            },
            "client": {
                "setup_price": "0.00",
                "recurring_price": "20.00",
                "total": "20.00",
                "balance": "657.00",
                "end_balance": "637.00"
            }
        }
    }
}
      

<telecloud>
  <customer account_number="7105045">
    <estimate>
      <plan rate_plan_id="52747" product_id="330" />
      <customer>
        <setup_price>0.00</setup_price>
        <recurring_price>25.00</recurring_price>
        <promo promo_code="20off">12.35</promo>
        <total>12.65</total>
        <cycle_length>30</cycle_length>
        <expiration_date>8/15/2019</expiration_date>
      </customer>
      <client>
        <setup_price>0.00</setup_price>
        <recurring_price>20.00</recurring_price>
        <total>20.00</total>
        <balance>657.00</balance>
        <end_balance>637.00</end_balance>
      </client>
    </estimate>
  </customer>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('estimate_type' => "",'account_number' => "",'rate_plan_id' => "",'promo_code' => "");

try { $responce = $tc->request('Customer/Estimate','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Estimate service using the API simulator.


Customer/Notation

Enter a new notation on a customer account.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Customer/Notation
Parameters
Variable Required Description
account_number
order_number
subject
content
Successful Response

      {
    "@attributes": {
        "trans_id": "3123489"
    },
    "customer": {
        "@attributes": {
            "account_number": "7105045"
        },
        "notation": {
            "@attributes": {
                "id": "152"
            },
            "subject": "Checking New API",
            "content": {}
        }
    }
}
      

<telecloud trans_id="3123489">
  <customer account_number="7105045">
    <notation id="152">
      <subject>Checking New API</subject>
      <content>
<![CDATA[Does the new API work?]]>
      </content>
    </notation>
  </customer>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "",'subject' => "",'content' => "");

try { $responce = $tc->request('Customer/Notation','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Notation service using the API simulator.


Customer/Credit

Issue or deduct a credit to/from a customer account. Credits are automatically utilized on the the next transaction, such as a new order or replenishent. NOTE: Credit will only be deducted when using a payment method on the customers account.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Customer/Credit
Parameters
Variable Required Description
account_number
The customers account number you wish to credit or debit from the credit.
type
'DEBIT' and 'CREDIT' are valid options
amount
The amount you wish to debit or credit in full dollar format; such as 10.50
Successful Response

      {
    "@attributes": {
        "trans_id": "3123832"
    },
    "customer": {
        "@attributes": {
            "account_number": "41055910"
        },
        "credit": {
            "type": "CREDIT",
            "amount": "$10.00",
            "credit_available": "$10.00"
        }
    }
}
      

<telecloud trans_id="3123832">
  <customer account_number="41055910">
    <credit>
      <type>CREDIT</type>
      <amount>$10.00</amount>
      <credit_available>$10.00</credit_available>
    </credit>
  </customer>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'type' => "",'amount' => "");

try { $responce = $tc->request('Customer/Credit','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Customer/Credit service using the API simulator.

PaymentMethod


PaymentMethod/Create

Add a new payment method either to a customer account or a VAR, PARTNER, AFFILIATE, or CORE account. To add a payment method to a customer account provide the 'account_number' parameter. Payment methods added to cloud accounts will require verification and two micro debits will be attempted, use 'PaymentMethod/Verify' to verify the debit amounts.

NOTE: Bank accounts must be added from the TeleCloud.app portal using the instant verification system.

CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/PaymentMethod/Create
Parameters
Variable Required Description
account_number
Provide only if adding a payment method to a customer account.
type
Options are CC for credit card and BA for bank account.
payment_account_number
The credit card or bank account number.
routing_number
When type is BA provide the bank routing number.
account_type
For BA only. Personal Checking: Personal Savings: Business Checking: and Business Savings are options.
expiration_month
When type is CC provide the card expiration month with leading zero. For example: 02
expiration_year
When type is CC provide the card two digit expiration year.
card_security_code
When type is CC provide the three or four digit card security code or CVV default
plaid_account_id
The account_id as provided by Plaid for bank accounts only.
plaid_access_token
The access_tokeb as provided by Plaid for bank accounts only.
plaid_item_id
The item_id as provided by Plaid for bank accounts only.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123489"
    },
    "paymentmethod": {
        "@attributes": {
            "id": "120"
        }
    }
}
      

<telecloud trans_id="3123489">
  <paymentmethod id="120" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'type' => "",'payment_account_number' => "",'routing_number' => "",'account_type' => "",'expiration_month' => "",'expiration_year' => "",'card_security_code' => "",'plaid_account_id' => "",'plaid_access_token' => "",'plaid_item_id' => "");

try { $responce = $tc->request('PaymentMethod/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the PaymentMethod/Create service using the API simulator.


PaymentMethod/Edit

Toggle a payment method between default and not default. Default payment methods are used for recurring billing when setup in the superior cloud account.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/PaymentMethod/Edit
Parameters
Variable Required Description
payment_method_id
The ID of the payment method; returned as the 'id' attribute from PaymentMethod/Create
account_number
If setting default payment method for a customer account provide account_number
type
Either CC for credit card or BA for bank account.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123506"
    },
    "account_number": "7105045",
    "paymentmethod": {
        "@attributes": {
            "id": "481",
            "default": "Y"
        }
    }
}
      

<telecloud trans_id="3123506">
  <account_number>7105045</account_number>
  <paymentmethod id="481" default="Y" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('payment_method_id' => "",'account_number' => "",'type' => "");

try { $responce = $tc->request('PaymentMethod/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the PaymentMethod/Edit service using the API simulator.


PaymentMethod/Delete

Delete a payment method connected to a customer account. NOTE: Cloud account payment methods can not be deleted at this time.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/PaymentMethod/Delete
Parameters
Variable Required Description
payment_method_id
The ID of the payment method; returned as the 'id' attribute from PaymentMethod/Create
account_number
The account number for which the payment method is connected.
type
Either CC for credit card or BA for bank account.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123509"
    },
    "account_number": "7105045",
    "paymentmethod": {
        "@attributes": {
            "id": "481"
        }
    }
}
      

<telecloud trans_id="3123509">
  <account_number>7105045</account_number>
  <paymentmethod id="481" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('payment_method_id' => "",'account_number' => "",'type' => "");

try { $responce = $tc->request('PaymentMethod/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the PaymentMethod/Delete service using the API simulator.


PaymentMethod/Verify

Verify the micro debit amounts associated with a payment method. Micro debits are only submitted and verification is only required for payment methods connected to a Cloud account, customer accounts have no verification flow. Note that the micro debit amounts may be entered in any order. The payment method will automatically be set as the default for the associated cloud account.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/PaymentMethod/Verify
Parameters
Variable Required Description
payment_method_id
The ID of the payment method; returned as 'id' in PaymentMethod/Create
type
Either CC for credit card or BA for bank account
micro_amount_1
The amount of the first micro debit
micro_amount_2
The amount of the second micro debit
Successful Response

      {
    "@attributes": {
        "trans_id": "2384387"
    },
    "paymentmethod": {
        "@attributes": {
            "id": "34"
        }
    }
}
      

<telecloud trans_id="2384387">
  <paymentmethod id="34" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('payment_method_id' => "",'type' => "",'micro_amount_1' => "",'micro_amount_2' => "");

try { $responce = $tc->request('PaymentMethod/Verify','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the PaymentMethod/Verify service using the API simulator.


PaymentMethod/Search

Search and get a list of payment methods. Provide account_number to get a list of payment methods for a specific customer account.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/PaymentMethod/Search
Parameters
Variable Required Description
account_number
Provide a customer account number to view payment methods connected to the account.
payment_method_id
Provide a payment_method_id to view a specific payment method and it's associated transactions.
Successful Response

      {
    "paymentmethod": [
        {
            "@attributes": {
                "id": "95",
                "type": "CC"
            },
            "payment_account_number": "5348-XXXX-XXXX-8307",
            "expiration_month": "05",
            "expiration_year": "21",
            "card_type": "Master Card",
            "status": "UNVERIFIED"
        },
        {
            "@attributes": {
                "id": "94",
                "type": "CC"
            },
            "payment_account_number": "5348-XXXX-XXXX-8307",
            "expiration_month": "03",
            "expiration_year": "20",
            "card_type": "Master Card",
            "status": "UNVERIFIED"
        },
        {
            "@attributes": {
                "id": "79",
                "type": "CC"
            },
            "payment_account_number": "5348-XXXX-XXXX-8307",
            "expiration_month": "07",
            "expiration_year": "20",
            "card_type": "Master Card",
            "status": "PENDING"
        },
        {
            "@attributes": {
                "id": "72",
                "type": "CC"
            },
            "payment_account_number": "5412-XXXX-XXXX-5874",
            "expiration_month": "03",
            "expiration_year": "20",
            "card_type": "Master Card",
            "status": "VERIFIED"
        }
    ]
}
      

<telecloud>
  <paymentmethod id="95" type="CC">
    <payment_account_number>5348-XXXX-XXXX-8307</payment_account_number>
    <expiration_month>05</expiration_month>
    <expiration_year>21</expiration_year>
    <card_type>Master Card</card_type>
    <status>UNVERIFIED</status>
  </paymentmethod>
  <paymentmethod id="94" type="CC">
    <payment_account_number>5348-XXXX-XXXX-8307</payment_account_number>
    <expiration_month>03</expiration_month>
    <expiration_year>20</expiration_year>
    <card_type>Master Card</card_type>
    <status>UNVERIFIED</status>
  </paymentmethod>
  <paymentmethod id="79" type="CC">
    <payment_account_number>5348-XXXX-XXXX-8307</payment_account_number>
    <expiration_month>07</expiration_month>
    <expiration_year>20</expiration_year>
    <card_type>Master Card</card_type>
    <status>PENDING</status>
  </paymentmethod>
  <paymentmethod id="72" type="CC">
    <payment_account_number>5412-XXXX-XXXX-5874</payment_account_number>
    <expiration_month>03</expiration_month>
    <expiration_year>20</expiration_year>
    <card_type>Master Card</card_type>
    <status>VERIFIED</status>
  </paymentmethod>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'payment_method_id' => "");

try { $responce = $tc->request('PaymentMethod/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the PaymentMethod/Search service using the API simulator.

Transaction


Transaction/Search

Search for a transaction using one of the search criteria. For new orders use this method to check the status of the order. If no search parameter is provided the last 350 transactions are shown.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Transaction/Search
Parameters
Variable Required Description
trans_id
The trans_id returned from any service.
account_number
Provide a customer account number to search for transactions relating to a specific customer
order_number
Provide a order_number to search for transactions relating to a specific order.
service_type
Provide a specific service type; for example 'PaymentMethod/Create'.
status
Search for a transaction with a specific status; options are PENDING; SUCCESS; and FAILURE.
Successful Response

      {
    "transactions": {
        "transaction": {
            "@attributes": {
                "trans_id": "3123534"
            },
            "service": "PaymentMethod\/Create",
            "user": "user_name455",
            "full_request": "\n{\"format\":\"xml\",\"service\":\"PaymentMethod\",\"method\":\"Create\",\"API_USER_ID\":\"test@telecloud.app\",\"account_number\":\"\"}\n",
            "requesting_ip": "95.162.36.222",
            "status": "FAILED"
        }
    }
}
      

<telecloud>
  <transactions>
    <transaction trans_id="3123534">
      <service>PaymentMethod/Create</service>
      <user>user_name455</user>
      <full_request>{"format":"xml","service":"PaymentMethod","method":"Create","API_USER_ID":"test@telecloud.app","account_number":""}</full_request>
      <requesting_ip>95.162.36.222</requesting_ip>
      <status>FAILED</status>
    </transaction>
  </transactions>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('trans_id' => "",'account_number' => "",'order_number' => "",'service_type' => "",'status' => "");

try { $responce = $tc->request('Transaction/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Transaction/Search service using the API simulator.

Order


Order/Search

Search for a order using one of the search criteria. If no search parameters are provided the last 50 orders are shown.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Order/Search
Parameters
Variable Required Description
account_number
Provide a customer account number to show connected orders.
order_number
Provide to search for a specific order.
hide_cancelled
Provide a 'Y' to hide cancelled orders
service_status
Search for orders with a specific status. To return all orders except cancelled provide 'ALL BUT CANCELLED'.
productid
Search for orders with rate plans of a specific CORE productid.
productid_var
Search for orders with a rate plans of a specific VAR productid.
VAR1
VAR1 as listed on an order.
VAR2
VAR2 as listed on an order.
VAR3
VAR3 as listed on an order.
VAR4
VAR4 as listed on an order.
VAR5
VAR5 as listed on an order.
VAR6
VAR6 as listed on an order.
VAR7
VAR7 as listed on an order.
VAR8
VAR8 as listed on an order.
VAR9
VAR9 as listed on an order.
VAR10
VAR10 as listed on an order.
VAR11
VAR11 as listed on an order.
VAR12
VAR12 as listed on an order.
VAR13
VAR13 as listed on an order.
VAR14
VAR14 as listed on an order.
VAR15
VAR15 as listed on an order.
VAR16
VAR16 as listed on an order.
VAR17
VAR17 as listed on an order.
VAR18
VAR18 as listed on an order.
VAR19
VAR19 as listed on an order.
VAR20
VAR20 as listed on an order.
Successful Response

      {
    "Orders": {
        "order": {
            "@attributes": {
                "order_number": "Z8111Z"
            },
            "account_number": "7105045",
            "activation_date": "2019-03-28",
            "type": "TRADITIONAL",
            "submitted_by": "syour_brand12",
            "last_update": "2019-03-28 00:00:00",
            "status": "CANCELLED",
            "product": {
                "@attributes": {
                    "product_id": "330",
                    "product_group_id": "73",
                    "product_group_name": "GSMA Network"
                },
                "name": "[Smartphone] By The Gig",
                "cycle_length": "30",
                "plan": {
                    "@attributes": {
                        "rate_plan_id": "52747"
                    },
                    "name": "Pay By The Gig",
                    "recurring_price": "25.00",
                    "expiration_date": "4\/27\/2019"
                }
            },
            "variables": {
                "VAR1": "3531454180705",
                "VAR2": "8901410327181008559",
                "VAR3": "469314399",
                "VAR4": "YES",
                "VAR5": "414792399",
                "VAR6": "6109",
                "VAR7": {
                    "@attributes": {
                        "NAME": "SSN_or_Tax_ID",
                        "SWAPABLE": "Y",
                        "TYPE": "TEXT",
                        "OPTIONS": "",
                        "DESCRIPTION": "Required when porting from a postpaid accounts only."
                    }
                },
                "VAR8": "4693792399",
                "VAR9": "0",
                "VAR10": "0",
                "VAR11": "0.007",
                "VAR12": "0.00",
                "VAR13": "5c9d890c7b415d62f4e1e59d",
                "VAR14": "511404",
                "VAR15": "CF"
            }
        }
    }
}
      

<telecloud>
  <Orders>
    <order order_number="Z8111Z">
      <account_number>7105045</account_number>
      <activation_date>2019-03-28</activation_date>
      <type>TRADITIONAL</type>
      <submitted_by>syour_brand12</submitted_by>
      <last_update>2019-03-28 00:00:00</last_update>
      <status>CANCELLED</status>
      <product product_id="330" product_group_id="73" product_group_name="GSMA Network">
        <name>[Smartphone] By The Gig</name>
        <cycle_length>30</cycle_length>
        <plan rate_plan_id="52747">
          <name>Pay By The Gig</name>
          <recurring_price>25.00</recurring_price>
          <expiration_date>4/27/2019</expiration_date>
        </plan>
      </product>
      <variables>
        <VAR1 NAME="IMEI" SWAPABLE="Y" TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the IMEI from the GSM device.">3531454180705</VAR1>
        <VAR2 NAME="ICCID" SWAPABLE="Y" TYPE="TEXT" OPTIONS="" DESCRIPTION="The ICCID or number from the SIM card.">8901410327181008559</VAR2>
        <VAR3 NAME="MDN" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="The subscribers mobile device number.">469314399</VAR3>
        <VAR4 NAME="Number_Port" SWAPABLE="N" TYPE="OPTIONS" OPTIONS="YES,NO" DESCRIPTION="Select YES if porting an existing number, select NO if not.">YES</VAR4>
        <VAR5 NAME="Account_Number" SWAPABLE="Y" TYPE="TEXT" OPTIONS="" DESCRIPTION="The customers account number with the previous provider.">414792399</VAR5>
        <VAR6 NAME="PIN_or_Password" SWAPABLE="Y" TYPE="TEXT" OPTIONS="" DESCRIPTION="The PIN or password on the customers account with the previous provider.">6109</VAR6>
        <VAR7 NAME="SSN_or_Tax_ID" SWAPABLE="Y" TYPE="TEXT" OPTIONS="" DESCRIPTION="Required when porting from a postpaid accounts only." />
        <VAR8 NAME="Number_to_Port" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the 10 digit mobile number you wish to port.">4693792399</VAR8>
        <VAR9 NAME="MINUTES_USAGE" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="Minutes utilized on the current plan.">0</VAR9>
        <VAR10 NAME="SMS_USAGE" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="SMS utilized on the current plan.">0</VAR10>
        <VAR11 NAME="DATA_USAGE" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="Data utilized on the current plan.">0.007</VAR11>
        <VAR12 NAME="CASH_BALANCE" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="Cash remaining on the account for extra services.">0.00</VAR12>
        <VAR13 NAME="ACTIVATION_ID" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="Activation ID from the HEG wireless API">5c9d890c7b415d62f4e1e59d</VAR13>
        <VAR14 NAME="SUBSCRIBER_ID" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="The HEG subscriber ID">511404</VAR14>
        <VAR15 NAME="PORT_STATUS" SWAPABLE="N" TYPE="TEXT" OPTIONS="" DESCRIPTION="The status code of the number port.">CF</VAR15>
      </variables>
    </order>
  </Orders>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "",'hide_cancelled' => "",'service_status' => "",'productid' => "",'productid_var' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "");

try { $responce = $tc->request('Order/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Search service using the API simulator.


Order/Create

Create and provision a new order on a customer account. Depending on the module the order status may return as ACTIVE or PENDING. You can use the trans_id or the order_number to check the status of the order.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Order/Create
Parameters
Variable Required Description
account_number
The customer account number for which you are placing the order
productid_var
The VAR rate plan ID
payment_method_id
To charge the customers credit card for this order provide the payment_method_id
parent_order_number
Required when placing an order for a add-on product only.
referral_code
The referral code of the refferring customer if supplied.
promo_code
Provide a promotional code to give the customer a discount on the order.
VAR1
The value of VAR1 if any.
VAR2
The value of VAR2 if any.
VAR3
The value of VAR3 if any.
VAR4
The value of VAR4 if any.
VAR5
The value of VAR5 if any.
VAR6
The value of VAR6 if any.
VAR7
The value of VAR7 if any.
VAR8
The value of VAR8 if any.
VAR9
The value of VAR9 if any.
VAR10
The value of VAR10 if any.
VAR11
The value of VAR11 if any.
VAR12
The value of VAR12 if any.
VAR13
The value of VAR13 if any.
VAR14
The value of VAR14 if any.
VAR15
The value of VAR15 if any.
VAR16
The value of VAR16 if any.
VAR17
The value of VAR17 if any.
VAR18
The value of VAR18 if any.
VAR19
The value of VAR19 if any.
VAR20
The value of VAR20 if any.
Successful Response

      {
    "order": {
        "@attributes": {
            "order_number": "4617ZU4617"
        },
        "status": "PENDING"
    }
}
      

<telecloud>
  <order order_number="4617ZU4617">
    <status>PENDING</status>
  </order>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'productid_var' => "",'payment_method_id' => "",'parent_order_number' => "",'referral_code' => "",'promo_code' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "");

try { $responce = $tc->request('Order/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Create service using the API simulator.


Order/Status

Toggle the service status of an existing order. Orders in ACTIVE status will be SUSPENDED and orders in SUSPENDED status will be made ACTIVE.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Order/Status
Parameters
Variable Required Description
account_number
The customer account number.
order_number
The order number you wish to toggle the service status of.
Successful Response

      {
    "@attributes": {
        "trans_id": "5472"
    },
    "order": {
        "@attributes": {
            "order_number": "GBT83432HH"
        },
        "status": "SUSPENDED"
    }
}
      

<telecloud trans_id="5472">
  <order order_number="GBT83432HH">
    <status>SUSPENDED</status>
  </order>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "");

try { $responce = $tc->request('Order/Status','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Status service using the API simulator.


Order/Move

Move an existing order to the specified customer account.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Order/Move
Parameters
Variable Required Description
order_number
The order number you wish to move
account_number
The account number where the order you wish to move exist.
new_account_number
The account number where you wish to move the order.
Successful Response

      {
    "@attributes": {
        "trans_id": "5472"
    },
    "order": {
        "@attributes": {
            "order_number": "GBT83432HH"
        },
        "new_account_number": "9505011"
    }
}
      

<telecloud trans_id="5472">
  <order order_number="GBT83432HH">
    <new_account_number>9505011</new_account_number>
  </order>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('order_number' => "",'account_number' => "",'new_account_number' => "");

try { $responce = $tc->request('Order/Move','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Move service using the API simulator.


Order/Cancel

Cancel an existing order. NOTE: This action can only be reversed by a CORE and could possibly cancel services that can't be un-cancelled.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Order/Cancel
Parameters
Variable Required Description
account_number
The account number of the order you wish to cancel.
order_number
The order number you wish to cancel.
Successful Response

      {
    "@attributes": {
        "trans_id": "5472"
    },
    "order": {
        "@attributes": {
            "order_number": "GBT83432HH"
        },
        "status": "CANCELLED"
    }
}
      

<telecloud trans_id="5472">
  <order order_number="GBT83432HH">
    <status>CANCELLED</status>
  </order>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "");

try { $responce = $tc->request('Order/Cancel','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Cancel service using the API simulator.


Order/Swap

Change or swap the value of one or more swappable variables on an order.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Order/Swap
Parameters
Variable Required Description
account_number
The account number where the order is located.
order_number
The order number.
VAR1
The value of VAR1
VAR2
The value of VAR2
VAR3
The value of VAR3
VAR4
The value of VAR4
VAR5
The value of VAR5
VAR6
The value of VAR6
VAR7
The value of VAR7
VAR8
The value of VAR8
VAR9
The value of VAR9
VAR10
The value of VAR10
VAR11
The value of VAR11
VAR12
The value of VAR12
VAR13
The value of VAR13
VAR14
The value of VAR14
VAR15
The value of VAR15
VAR16
The value of VAR16
VAR17
The value of VAR17
VAR18
The value of VAR18
VAR19
The value of VAR19
VAR20
The value of VAR20
Successful Response

      {
    "@attributes": {
        "trans_id": "5472"
    },
    "order": {
        "@attributes": {
            "order_number": "GBT83432HH"
        },
        "0": "\n  "
    }
}
      

<telecloud trans_id="5472">
  <order order_number="GBT83432HH"></order>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "");

try { $responce = $tc->request('Order/Swap','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Swap service using the API simulator.


Order/Replenish

Add an additional billing cycle to an active order.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Order/Replenish
Parameters
Variable Required Description
account_number
The customers account number where the order is located.
order_number
The order number you wish to replenish.
productid_var
The VAR rate plan ID.
payment_method_id
To charge the customers credit card for this replenishment provide the paymentmethod_id.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123677"
    },
    "order": {
        "@attributes": {
            "order_number": "GBTU732673F"
        },
        "expiration_date": "6\/11\/2019"
    }
}
      

<telecloud trans_id="3123677">
  <order order_number="GBTU732673F">
    <expiration_date>6/11/2019</expiration_date>
  </order>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "",'productid_var' => "",'payment_method_id' => "");

try { $responce = $tc->request('Order/Replenish','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Replenish service using the API simulator.


Order/Update

Update the status, exipration date, and variables on an order. Orders in "PENDING" status that are changed to "CANCELLED" will result in a refund of all charges. Only passed variables are updated.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Order/Update
Parameters
Variable Required Description
account_number
The customers account number where the order is located.
order_number
The order number you wish to update.
service_status
Can be either ACTIVE; SUSPENDED; NON-PAY; FAILED; or CANCELLED. Pending orders marked as Failed will automatically be refunded.
cycle_end_date
The new cycle end date if you wish to update it. Proper format is M/D/YYYY
error_text
If setting a PENDING order as FAILED the error returned can be stored here and will be shown on the original 'Order/Create' transaction.
VAR1
The value of VAR1
VAR2
The value of VAR2
VAR3
The value of VAR3
VAR4
The value of VAR4
VAR5
The value of VAR5
VAR6
The value of VAR6
VAR7
The value of VAR7
VAR8
The value of VAR8
VAR9
The value of VAR9
VAR10
The value of VAR10
VAR11
The value of VAR11
VAR12
The value of VAR12
VAR13
The value of VAR13
VAR14
The value of VAR14
VAR15
The value of VAR15
VAR16
The value of VAR16
VAR17
The value of VAR17
VAR18
The value of VAR18
VAR19
The value of VAR19
VAR20
The value of VAR20
Successful Response

      {
    "@attributes": {
        "trans_id": "3123688"
    },
    "order": {
        "@attributes": {
            "order_number": "GBT8214789"
        }
    }
}
      

<telecloud trans_id="3123688">
  <order order_number="GBT8214789" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "",'service_status' => "",'cycle_end_date' => "",'error_text' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "");

try { $responce = $tc->request('Order/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Update service using the API simulator.


Order/Unstack

Instantly apply a stacked plan and make it active.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Order/Unstack
Parameters
Variable Required Description
account_number
The account number the order is on.
order_number
The order number you wish to unstack a plan on.
stacked_plan_id
The ID of the stacked plan you wish to unstack.
Successful Response

      
      



<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'order_number' => "",'stacked_plan_id' => "");

try { $responce = $tc->request('Order/Unstack','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Order/Unstack service using the API simulator.

CloudAccount


CloudAccount/Search

Returns information about TeleCloud.app accounts under your control, including cloud users associated with the TeleCloud.app accocunt. To return a full list of all TeleCloud.app accounts under your control omit account_number and type. Orders, transactions, and discounts will only be shown when a specific cloud_account_number is specified.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/CloudAccount/Search
Parameters
Variable Required Description
cloud_account_number
The TeleCloud.app account ID number (usually 10 digits)
cloud_account_type
The type of TeleCloud.app account (can be either VAR; PARTNER; or AFFILIATE).
show_orders
Provide a Y to return the last 50 service orders connected to the TeleKloud.app account.
show_billing
Provide a Y to return the last 100 billing transactions connected to the TeleKloud.app account
show_discounts
Provide a Y to return the product discounts set for this TeleCloud.app account
dashboard
Dashboard mode. Provide a Y to prevent the loading of all connected accounts and load only the TeleCloud.app account making the call.
Successful Response

      {
    "cloud_account": {
        "@attributes": {
            "id": "2900",
            "cloud_account_number": "181818872",
            "account_type": "PARTNER"
        },
        "COREID": "8187871817",
        "VARID": "1912093447",
        "PARTNERID": "181818872",
        "ACCOUNT_TYPE": "PARTNER",
        "COMPANY_NAME": "Test Dealer",
        "FIRST_NAME": "Test",
        "LAST_NAME": "Dealer",
        "ADDRESS1": "1710 S First St",
        "CITY": "GARLAND",
        "STATE": "TX",
        "ZIP_CODE": "75040",
        "COUNTRY": "United States",
        "CONTACT_PHONE": "8885551212",
        "NOTIFICATION_EMAIL": "test@telecloud.app",
        "MAINTENANCE_FEE": "0.00",
        "MAINTENANCE_FEE_DAY": "1",
        "MAINTENANCE_FEE_TYPE": "Yearly",
        "MAINTENANCE_FEE_MONTH": "January",
        "SPENDING_LIMIT": "1000.00",
        "STATUS": "1",
        "FUNDING_TYPE": "PREPAID",
        "SINCE": "2016-10-18",
        "TICKET_PIPE_EMAIL": "testdealer290b4S4mW@secureaccesspoint.com"
    }
}
      

<telecloud>
  <cloud_account id="2900" cloud_account_number="181818872" account_type="PARTNER">
    <COREID>8187871817</COREID>
    <VARID>1912093447</VARID>
    <PARTNERID>181818872</PARTNERID>
    <ACCOUNT_TYPE>PARTNER</ACCOUNT_TYPE>
    <COMPANY_NAME>Test Dealer</COMPANY_NAME>
    <FIRST_NAME>Test</FIRST_NAME>
    <LAST_NAME>Dealer</LAST_NAME>
    <ADDRESS1>1710 S First St</ADDRESS1>
    <CITY>GARLAND</CITY>
    <STATE>TX</STATE>
    <ZIP_CODE>75040</ZIP_CODE>
    <COUNTRY>United States</COUNTRY>
    <CONTACT_PHONE>8885551212</CONTACT_PHONE>
    <NOTIFICATION_EMAIL>test@telecloud.app</NOTIFICATION_EMAIL>
    <MAINTENANCE_FEE>0.00</MAINTENANCE_FEE>
    <MAINTENANCE_FEE_DAY>1</MAINTENANCE_FEE_DAY>
    <MAINTENANCE_FEE_TYPE>Yearly</MAINTENANCE_FEE_TYPE>
    <MAINTENANCE_FEE_MONTH>January</MAINTENANCE_FEE_MONTH>
    <SPENDING_LIMIT>1000.00</SPENDING_LIMIT>
    <STATUS>1</STATUS>
    <FUNDING_TYPE>PREPAID</FUNDING_TYPE>
    <SINCE>2016-10-18</SINCE>
    <TICKET_PIPE_EMAIL>testdealer290b4S4mW@secureaccesspoint.com</TICKET_PIPE_EMAIL>
  </cloud_account>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_number' => "",'cloud_account_type' => "",'show_orders' => "",'show_billing' => "",'show_discounts' => "",'dashboard' => "");

try { $responce = $tc->request('CloudAccount/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the CloudAccount/Search service using the API simulator.


CloudAccount/Create

Create oa TeleCloud.app account under your control, this can either be a VAR, PARTNER, or AFFILIATE account depending on the level of the user calling the service.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/CloudAccount/Create
Parameters
Variable Required Description
cloud_account_type
The type of account you wish to create (CORE; VAR; PARTNER; AFFILIATE).
company_name
The name of the compamy.
first_name
The first name of the account holder.
last_name
The last name of the account holder.
address1
The first line of the street address.
address2
The second line of the street address including unit type and number.
city
The city corresponding to the address.
state_or_province
The state or province corresponding to the address.
zip_code
The postal code corresponding to the street address.
country
The country of the account holder; for example "United States".
email
The email address of the account holder; will be used to create the initial login.
phone
The contact telephone number of the company
spending_limit
The daily spending limit (applies to postpaid accounts only).
funding_type
Options are "POSTPAID" or "PREPAID".
maintenance_fee_frequency
The frequency of the maintenance fee (valid options are "Monthly" and "Yearly").
maintenance_fee_amount
The amount of the maintenance fee in full dollar amounts. For example 0.00 or 50.00.
maintenance_fee_day
The day of the month the maintenance fee should be charged; for Monthly only.
maintenance_fee_month
The month of the year the maintenance fee should be charged; for Yearly only.
restricted_access
Either Y or N. If set to Y this account will only be able to view customers accounts they created.
reload_via_card
Provide a 'Y' if this account can reload via credit card (prepaid accounts only).
Successful Response

      {
    "@attributes": {
        "trans_id": "3123704"
    },
    "cloud_account": {
        "@attributes": {
            "id": "474",
            "cloud_account_number": "1819543527",
            "account_type": "VAR"
        }
    }
}
      

<telecloud trans_id="3123704">
  <cloud_account id="474" cloud_account_number="1819543527" account_type="VAR" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'company_name' => "",'first_name' => "",'last_name' => "",'address1' => "",'address2' => "",'city' => "",'state_or_province' => "",'zip_code' => "",'country' => "",'email' => "",'phone' => "",'spending_limit' => "",'funding_type' => "",'maintenance_fee_frequency' => "",'maintenance_fee_amount' => "",'maintenance_fee_day' => "",'maintenance_fee_month' => "",'restricted_access' => "",'reload_via_card' => "");

try { $responce = $tc->request('CloudAccount/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the CloudAccount/Create service using the API simulator.


CloudAccount/Edit

Edit a TeleCloud.app account under your control.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/CloudAccount/Edit
Parameters
Variable Required Description
cloud_account_number
The 10 digit account number of the cloud account your editing.
cloud_account_type
The type of account you wish to create (CORE; VAR; PARTNER; AFFILIATE).
company_name
The name of the compamy.
first_name
The first name of the account holder.
last_name
The last name of the account holder.
address1
The first line of the street address.
address2
The second line of the street address including unit type and number.
city
The city corresponding to the address.
state_or_province
The state or province corresponding to the address.
zip_code
The postal code corresponding to the street address.
country
The country of the account holder; for example "United States".
email
The email address of the account holder; will be used to create the initial login.
phone
The contact telephone number of the company
spending_limit
The daily spending limit (applies to postpaid accounts only).
funding_type
Options are "POSTPAID" or "PREPAID".
maintenance_fee_frequency
The frequency of the maintenance fee (valid options are "Monthly" and "Yearly").
maintenance_fee_amount
The amount of the maintenance fee in full dollar amounts. For example 0.00 or 50.00.
maintenance_fee_day
The day of the month the maintenance fee should be charged; for Monthly only.
maintenance_fee_month
The month of the year the maintenance fee should be charged; for Yearly only.
restricted_access
Either Y or N. If set to Y this account will only be able to view customers accounts they created.
reload_via_card
Provide a 'Y' if this account can reload via credit card (prepaid accounts only).
status
1 for active; 2 for suspended.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123723"
    },
    "cloud_account": {
        "@attributes": {
            "id": "474",
            "cloud_account_number": "1819543527",
            "account_type": "VAR"
        }
    }
}
      

<telecloud trans_id="3123723">
  <cloud_account id="474" cloud_account_number="1819543527" account_type="VAR" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_number' => "",'cloud_account_type' => "",'company_name' => "",'first_name' => "",'last_name' => "",'address1' => "",'address2' => "",'city' => "",'state_or_province' => "",'zip_code' => "",'country' => "",'email' => "",'phone' => "",'spending_limit' => "",'funding_type' => "",'maintenance_fee_frequency' => "",'maintenance_fee_amount' => "",'maintenance_fee_day' => "",'maintenance_fee_month' => "",'restricted_access' => "",'reload_via_card' => "",'status' => "");

try { $responce = $tc->request('CloudAccount/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the CloudAccount/Edit service using the API simulator.


CloudAccount/Delete

Delete a TeleCloud.app account under your control. This operation is not reversable.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/CloudAccount/Delete
Parameters
Variable Required Description
cloud_account_type
The type of account you wish to delete (CORE; VAR; PARTNER; AFFILIATE).
cloud_account_number
The 10 digit account number of the cloud account your deleting.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123724"
    },
    "cloud_account": {
        "@attributes": {
            "id": "473",
            "cloud_account_number": "9261376490",
            "account_type": "VAR"
        }
    }
}
      

<telecloud trans_id="3123724">
  <cloud_account id="473" cloud_account_number="9261376490" account_type="VAR" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "");

try { $responce = $tc->request('CloudAccount/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the CloudAccount/Delete service using the API simulator.

Discount


Discount/Search

Load product discounts for a Cloud account under your control. NOTE: You can also view discounts using the Cloud/Search service, this service returns additional information including the associated VAR rate plan for Partner and Affiliate accounts.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Discount/Search
Parameters
Variable Required Description
cloud_account_type
The type of account you wish to create discounts for (CORE; VAR; PARTNER; AFFILIATE).
cloud_account_number
The 10 digit account number of the cloud account your editing
product_group_id
Provide the product_group_id to show discounts only from this product group.
Successful Response

      {
    "discounts": {
        "@attributes": {
            "limit": "50000"
        },
        "discount": [
            {
                "@attributes": {
                    "id": "30567"
                },
                "product_id": "330",
                "core_product_name": "[Smartphone] By The Gig",
                "core_product_description": "\nAllow your customers to pay by the GB. 2GB and unlimited talk and text included. Additional data is available for only $8 per GB. Add additional lines at $8 each and share the data (coming soon).\n",
                "discount_setup_price": "5.00",
                "discount_price": "25.00",
                "var_plans": {
                    "plan": [
                        {
                            "@attributes": {
                                "id": "52747"
                            },
                            "name": "Pay By The Gig",
                            "setup_price": "0.00",
                            "price": "25.00"
                        },
                        {
                            "@attributes": {
                                "id": "52746"
                            },
                            "name": "Personal Unlimited",
                            "setup_price": "15.00",
                            "price": "45.00"
                        }
                    ]
                }
            },
            {
                "@attributes": {
                    "id": "30568"
                },
                "product_id": "331",
                "core_product_name": "[Smartphone] Personal Unlimited",
                "core_product_description": "\nUnlimited talk, text, and data. NO HOTSPOT. For personal use only, reasonable usage policy applies. Video streams at 480p. After 22GB data MAY be slowed in times of heavy network congestion.\n",
                "discount_setup_price": "15.00",
                "discount_price": "35.00",
                "var_plans": {
                    "plan": {
                        "@attributes": {
                            "id": "52746"
                        },
                        "name": "Personal Unlimited",
                        "setup_price": "15.00",
                        "price": "45.00"
                    }
                }
            }
        ]
    }
}
      

<telecloud>
  <discounts limit="50000">
    <discount id="30567">
      <product_id>330</product_id>
      <core_product_name>[Smartphone] By The Gig</core_product_name>
      <core_product_description>Allow your customers to pay by the GB. 2GB and unlimited talk and text included. Additional data is available for only $8 per GB. Add additional lines at $8 each and share the data (coming soon).</core_product_description>
      <discount_setup_price>5.00</discount_setup_price>
      <discount_price>25.00</discount_price>
      <var_plans>
        <plan id="52747">
          <name>Pay By The Gig</name>
          <setup_price>0.00</setup_price>
          <price>25.00</price>
        </plan>
        <plan id="52746">
          <name>Personal Unlimited</name>
          <setup_price>15.00</setup_price>
          <price>45.00</price>
        </plan>
      </var_plans>
    </discount>
    <discount id="30568">
      <product_id>331</product_id>
      <core_product_name>[Smartphone] Personal Unlimited</core_product_name>
      <core_product_description>Unlimited talk, text, and data. NO HOTSPOT. For personal use only, reasonable usage policy applies. Video streams at 480p. After 22GB data MAY be slowed in times of heavy network congestion.</core_product_description>
      <discount_setup_price>15.00</discount_setup_price>
      <discount_price>35.00</discount_price>
      <var_plans>
        <plan id="52746">
          <name>Personal Unlimited</name>
          <setup_price>15.00</setup_price>
          <price>45.00</price>
        </plan>
      </var_plans>
    </discount>
  </discounts>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "",'product_group_id' => "");

try { $responce = $tc->request('Discount/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Discount/Search service using the API simulator.


Discount/Create

Assign product discounts to a Cloud account under your control.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Discount/Create
Parameters
Variable Required Description
cloud_account_type
The type of account you wish to create discounts for (CORE; VAR; PARTNER; AFFILIATE).
cloud_account_number
The 10 digit account number of the cloud account your editing
product_id
The core product_id or the VAR rate plan ID; can be optained using the Product/Search service.
discount_setup_price
The discount setup price you would like this Cloud account to pay. Should be full dollar formatted; for example; 1.00
discount_price
The discount recurring price you would like this Cloud account to pay. Should be full dollar formatted; for example; 1.00.
Successful Response

      {
    "discount": {
        "@attributes": {
            "id": "30574"
        },
        "product_id": "311",
        "discount_setup_price": "30.00",
        "discount_price": "2.00"
    }
}
      

<telecloud>
  <discount id="30574">
    <product_id>311</product_id>
    <discount_setup_price>30.00</discount_setup_price>
    <discount_price>2.00</discount_price>
  </discount>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "",'product_id' => "",'discount_setup_price' => "",'discount_price' => "");

try { $responce = $tc->request('Discount/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Discount/Create service using the API simulator.


Discount/Copy

Assign product discounts to a Cloud account under your control by copying the discounts from another Cloud account under your control.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Discount/Copy
Parameters
Variable Required Description
cloud_account_type
The type of account you wish to create discounts for (CORE; VAR; PARTNER; AFFILIATE).
cloud_account_number
The 10 digit account number of the cloud account your editing
from_cloud_account_type
The type of account you wish to copy discounts from (CORE; VAR; PARTNER; AFFILIATE).
from_cloud_account_number
The 10 digit account number of the cloud account your copying the discounts from.
replace
Provide a "Y" to delete all existing discounts and replace them.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123763"
    }
}
      

<telecloud trans_id="3123763" />

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "",'from_cloud_account_type' => "",'from_cloud_account_number' => "",'replace' => "");

try { $responce = $tc->request('Discount/Copy','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Discount/Copy service using the API simulator.


Discount/Delete

Delete all product discounts associated with a Cloud account under your control.
CORE VAR PARTNER AFFILIATE
DELTE https://telecloud.app/API/{format}/Discount/Delete
Parameters
Variable Required Description
cloud_account_type
The type of account you wish to create discounts for (CORE; VAR; PARTNER; AFFILIATE).
cloud_account_number
The 10 digit account number of the cloud account your editing.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123778"
    }
}
      

<telecloud trans_id="3123778" />

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "");

try { $responce = $tc->request('Discount/Delete','DELTE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Discount/Delete service using the API simulator.

Billing


Billing/Search

Search for billing transactions or billing history.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Billing/Search
Parameters
Variable Required Description
trans_id
Provide a specific billing transaction ID
account_number
Provide a customer account number to search for billing transactions relating to a specific customer
order_number
Provide an order number to search for billing transactions relating to a specific order number
cloud_account_type
The Cloud account type you wish to search billing transactions for. To view your own account's transactions leave this blank
cloud_account_number
The Cloud account number you wish to search billing transactions for. To view your own account's transactions leave this blank.
start_date
The start date in the YYYY-MM-DD format.
end_date
The ending date in the YYYY-MM-DD format.
billed
Provide an 'N' to show unbilled transactions (postpaid cloud accounts only).
Successful Response

      {
    "cloud_account_type": "PARTNER",
    "cloud_account_number": "5881761312",
    "billing": {
        "transaction": {
            "@attributes": {
                "trans_id": "43329"
            },
            "date": "2019-06-01 13:10:01",
            "type": "MONTHLY MAINTENANCE FEE",
            "descriptor": {},
            "details": "\nMonthly maintenance fee for system access and hosting.\n",
            "user": "AUTO",
            "amount": "0.00",
            "billed": "Y",
            "end_balance": "385.22",
            "status": "COMPLETED"
        }
    }
}
      

<telecloud>
  <cloud_account_type>PARTNER</cloud_account_type>
  <cloud_account_number>5881761312</cloud_account_number>
  <billing>
    <transaction trans_id="43329">
      <date>2019-06-01 13:10:01</date>
      <type>MONTHLY MAINTENANCE FEE</type>
      <descriptor />
      <details>Monthly maintenance fee for system access and hosting.</details>
      <user>AUTO</user>
      <amount>0.00</amount>
      <billed>Y</billed>
      <end_balance>385.22</end_balance>
      <status>COMPLETED</status>
    </transaction>
  </billing>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('trans_id' => "",'account_number' => "",'order_number' => "",'cloud_account_type' => "",'cloud_account_number' => "",'start_date' => "",'end_date' => "",'billed' => "");

try { $responce = $tc->request('Billing/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Billing/Search service using the API simulator.


Billing/Create

Creates a manual debit or credit to a Cloud account under your control.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Billing/Create
Parameters
Variable Required Description
cloud_account_type
The Cloud account type you wish to create billing transactions for.
cloud_account_number
The Cloud account number you wish to create billing transactions for.
type
Either 'DEBIT' or 'CREDIT'
amount
The amount of your debit or credit in full dollar form; for example 10.00.
notes
Provide a more detailed description of the transaction.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123792"
    },
    "billing": {
        "@attributes": {
            "billing_trans_id": "43982",
            "cloud_account_number": "2502093947",
            "cloud_account_type": "VAR"
        },
        "type": "CREDIT",
        "amount": "100.00",
        "notes": "Test credit",
        "ending_balance": "251.00"
    }
}
      

<telecloud trans_id="3123792">
  <billing billing_trans_id="43982" cloud_account_number="2502093947" cloud_account_type="VAR">
    <type>CREDIT</type>
    <amount>100.00</amount>
    <notes>Test credit</notes>
    <ending_balance>251.00</ending_balance>
  </billing>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "",'type' => "",'amount' => "",'notes' => "");

try { $responce = $tc->request('Billing/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Billing/Create service using the API simulator.


Billing/Reverse

Reverse a billing transaction on a Cloud account under your control.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Billing/Reverse
Parameters
Variable Required Description
cloud_account_type
The Cloud account type you wish to search billing transactions for. To view your own account's transactions leave this blank
cloud_account_number
The Cloud account number you wish to search billing transactions for. To view your own account's transactions leave this blank.
billing_trans_id
The billing history transaction ID you wish to reverse.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123793"
    },
    "billing": {
        "@attributes": {
            "billing_trans_id": "43982",
            "cloud_account_number": "2502093947",
            "cloud_account_type": "VAR"
        },
        "type": "CREDIT",
        "amount": "100.00",
        "notes": "\nManual CREDIT issued by COREID 554777700.\n",
        "ending_balance": "151.00"
    }
}
      

<telecloud trans_id="3123793">
  <billing billing_trans_id="43982" cloud_account_number="2502093947" cloud_account_type="VAR">
    <type>CREDIT</type>
    <amount>100.00</amount>
    <notes>Manual CREDIT issued by COREID 554777700.</notes>
    <ending_balance>151.00</ending_balance>
  </billing>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "",'billing_trans_id' => "");

try { $responce = $tc->request('Billing/Reverse','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Billing/Reverse service using the API simulator.


Billing/AddFunds

Allows a VAR, PARTNER, or AFFILIATE to add funds to their account using the controlling accounts default payment gateway.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Billing/AddFunds
Parameters
Variable Required Description
payment_method_id
The payment method you wish to use to reload the account.
payment_method_type
Either 'CC' for credit card or 'BA' for bank account.
amount
The amount you wish to reload in full dollar format.
cvv
The cvv or card security code from the credit or debit card.
Successful Response

      {
    "@attributes": {
        "trans_id": "3124063"
    },
    "billing": {
        "@attributes": {
            "billing_trans_id": "44425"
        },
        "type": "CREDIT",
        "amount": "5.00",
        "ending_balance": "657.00"
    }
}
      

<telecloud trans_id="3124063">
  <billing billing_trans_id="44425">
    <type>CREDIT</type>
    <amount>5.00</amount>
    <ending_balance>657.00</ending_balance>
  </billing>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('payment_method_id' => "",'payment_method_type' => "",'amount' => "",'cvv' => "");

try { $responce = $tc->request('Billing/AddFunds','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Billing/AddFunds service using the API simulator.

Plan


Plan/Search

Get a list of all rate plans connected to your Cloud account or a Cloud account you control.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Plan/Search
Parameters
Variable Required Description
cloud_account_type
The Cloud account type you wish to view rate plans for. To view your own account's plans leave this blank
cloud_account_number
The Cloud account number you wish to view rate plans for for. To view your own account's plans leave this blank.
product_group_id
To show rate plans from a specific product group provide that product group ID.
Successful Response

      {
    "Plans": {
        "@attributes": {
            "cloud_account_number": "1992093958",
            "cloud_account_type": "VAR"
        },
        "product": [
            {
                "@attributes": {
                    "product_id": "338",
                    "product_group_id": "73",
                    "product_type": "ADD-ON"
                },
                "name": "POWER PACK - 2GB OF DATA",
                "description": "\nUse this add-on to add 2GB of data ($16 cash value) to the cash balance for subscribers on the By the Gig plan.\n",
                "discount_recurring_price": "18.00",
                "discount_setup_price": "0.00",
                "cycle_length": "WITH PLAN",
                "prompt_for_variables": "N",
                "replenish_with_plan": "N",
                "status": "1",
                "plan": {
                    "@attributes": {
                        "rate_plan_id": "52873"
                    },
                    "name": "Zilla PowerPack 16",
                    "description": "$16 of cash value or 2GB of data.",
                    "recurring_price": "16.00",
                    "setup_price": "0.00",
                    "autopay_discount": {},
                    "status": "1"
                }
            },
            {
                "@attributes": {
                    "product_id": "337",
                    "product_group_id": "73",
                    "product_type": "ADD-ON"
                },
                "name": "POWER PACK - 1GB OF DATA",
                "description": "\nUse this add-on to add 1GB of data ($8 cash value) to the cash balance for subscribers on the By the Gig plan.\n",
                "discount_recurring_price": "8.00",
                "discount_setup_price": "0.00",
                "cycle_length": "WITH PLAN",
                "prompt_for_variables": "N",
                "replenish_with_plan": "N",
                "status": "1",
                "plan": {
                    "@attributes": {
                        "rate_plan_id": "52808"
                    },
                    "name": "Zilla PowerPack",
                    "description": "$8 of cash value or 1GB of data.",
                    "recurring_price": "8.00",
                    "setup_price": "0.00",
                    "autopay_discount": {},
                    "status": "1"
                }
            }
        ]
    }
}
      

<telecloud>
  <Plans cloud_account_number="1992093958" cloud_account_type="VAR">
    <product product_id="338" product_group_id="73" product_type="ADD-ON">
      <name>POWER PACK - 2GB OF DATA</name>
      <description>Use this add-on to add 2GB of data ($16 cash value) to the cash balance for subscribers on the By the Gig plan.</description>
      <discount_recurring_price>18.00</discount_recurring_price>
      <discount_setup_price>0.00</discount_setup_price>
      <cycle_length>WITH PLAN</cycle_length>
      <prompt_for_variables>N</prompt_for_variables>
      <replenish_with_plan>N</replenish_with_plan>
      <status>1</status>
      <plan rate_plan_id="52873">
        <name>Zilla PowerPack 16</name>
        <description>$16 of cash value or 2GB of data.</description>
        <recurring_price>16.00</recurring_price>
        <setup_price>0.00</setup_price>
        <autopay_discount></autopay_discount>
        <status>1</status>
      </plan>
    </product>
    <product product_id="337" product_group_id="73" product_type="ADD-ON">
      <name>POWER PACK - 1GB OF DATA</name>
      <description>Use this add-on to add 1GB of data ($8 cash value) to the cash balance for subscribers on the By the Gig plan.</description>
      <discount_recurring_price>8.00</discount_recurring_price>
      <discount_setup_price>0.00</discount_setup_price>
      <cycle_length>WITH PLAN</cycle_length>
      <prompt_for_variables>N</prompt_for_variables>
      <replenish_with_plan>N</replenish_with_plan>
      <status>1</status>
      <plan rate_plan_id="52808">
        <name>Zilla PowerPack</name>
        <description>$8 of cash value or 1GB of data.</description>
        <recurring_price>8.00</recurring_price>
        <setup_price>0.00</setup_price>
        <autopay_discount></autopay_discount>
        <status>1</status>
      </plan>
    </product>
  </Plans>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('cloud_account_type' => "",'cloud_account_number' => "",'product_group_id' => "");

try { $responce = $tc->request('Plan/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Plan/Search service using the API simulator.


Plan/Create

For VAR accounts this method creates a rate plan based on a product. For CORE users this method creates a new product.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Plan/Create
Parameters
Variable Required Description
product_id
VAR ONLY: The product_id of the CORE rate plan. Required for the creation of VAR rate plans.
name
The name of the product; should be 10 characters or more.
description
The description of the rate plan; should be 10 characters or more.
recurring_price
The recurring price of the rate plan in full dollar amount; 10.50 for example.
setup_price
The setup proce of the rate plan in full dollar amount; 35.50 for example
autopay_discount
The discount in dollar amounts for customers utilizing auto-pay.
status
The status of the rate plan; must be either 1-ACTIVE or 2-LOCKED. VAR accounts can also set status to 4-REPLENISH ONLY
product_group_id
CORE ONLY: The product group you wish to associate the plan with
cycle_days
CORE ONLY: The amount of days on the cycle; 30 for example.
product_type
CORE ONLY: The type of product. Should be one of TRADITIONAL or ADD-ON.
prompt_for_variables
CORE ONLY: If variables are required when this product is ordered; Y or N.
replenish_with_plan
CORE ONLY: For Add-On plans only; if the product should be replenished with the primary product; Y or N.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123808"
    },
    "plan": {
        "@attributes": {
            "rate_plan_id": "98814"
        },
        "name": "Test Rate Plan",
        "description": "For hotspot and data only devices. No voice.",
        "recurring_price": "$10.00",
        "setup_price": "$25.00",
        "status": "1"
    }
}
      

<telecloud trans_id="3123808">
  <plan rate_plan_id="98814">
    <name>Test Rate Plan</name>
    <description>For hotspot and data only devices. No voice.</description>
    <recurring_price>$10.00</recurring_price>
    <setup_price>$25.00</setup_price>
    <status>1</status>
  </plan>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('product_id' => "",'name' => "",'description' => "",'recurring_price' => "",'setup_price' => "",'autopay_discount' => "",'status' => "",'product_group_id' => "",'cycle_days' => "",'product_type' => "",'prompt_for_variables' => "",'replenish_with_plan' => "");

try { $responce = $tc->request('Plan/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Plan/Create service using the API simulator.


Plan/Edit

Edit an existing rate plan.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Plan/Edit
Parameters
Variable Required Description
product_id
CORE ONLY: The product_id of the CORE rate plan you wish to edit.
rate_plan_id
VAR ONLY: The rate_plan_id of the rate plan you wish to edit.
name
The name of the product; should be 10 characters or more.
description
The description of the rate plan; should be 10 characters or more.
recurring_price
The recurring price of the rate plan in full dollar amount; 10.50 for example.
setup_price
The setup proce of the rate plan in full dollar amount; 35.50 for example
autopay_discount
The discount in dollar amounts for customers utilizing auto-pay.
status
The status of the rate plan; must be either 1-ACTIVE; 2-LOCKED; or 4-REPLENISH ONLY.
cycle_days
CORE ONLY: The amount of days on the cycle; 30 for example.
prompt_for_variables
CORE ONLY: If variables are required when this product is ordered; Y or N.
replenish_with_plan
CORE ONLY: For Add-On plans only; if the product should be replenished with the primary product; Y or N.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123820"
    },
    "product": {
        "@attributes": {
            "product_id": "108",
            "product_group_id": "26",
            "product_type": "TRADITIONAL"
        },
        "name": "Comcast Residential 16x3 Dynamic IP",
        "description": "Test desscription for editing a plan.",
        "recurring_price": "$10.00",
        "setup_price": "$20.00",
        "cycle_length": "25",
        "prompt_for_variables": "Y",
        "replenish_with_plan": "Y",
        "status": "1"
    }
}
      

<telecloud trans_id="3123820">
  <product product_id="108" product_group_id="26" product_type="TRADITIONAL">
    <name>Comcast Residential 16x3 Dynamic IP</name>
    <description>Test desscription for editing a plan.</description>
    <recurring_price>$10.00</recurring_price>
    <setup_price>$20.00</setup_price>
    <cycle_length>25</cycle_length>
    <prompt_for_variables>Y</prompt_for_variables>
    <replenish_with_plan>Y</replenish_with_plan>
    <status>1</status>
  </product>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('product_id' => "",'rate_plan_id' => "",'name' => "",'description' => "",'recurring_price' => "",'setup_price' => "",'autopay_discount' => "",'status' => "",'cycle_days' => "",'prompt_for_variables' => "",'replenish_with_plan' => "");

try { $responce = $tc->request('Plan/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Plan/Edit service using the API simulator.


Plan/Delete

Deletes a CORE product or VAR rate plan. This action wont affect orders already utilizing the plan, upon replenishment a new plan will need to be selected. This action cant be reversed.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/Plan/Delete
Parameters
Variable Required Description
product_id
CORE ONLY: The product_id of the CORE rate plan you wish to delete.
rate_plan_id
VAR ONLY: The rate_plan_id of the rate plan you wish to delete.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123829"
    },
    "plan": {
        "@attributes": {
            "rate_plan_id": "52562"
        },
        "status": "3"
    }
}
      

<telecloud trans_id="3123829">
  <plan rate_plan_id="52562">
    <status>3</status>
  </plan>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('product_id' => "",'rate_plan_id' => "");

try { $responce = $tc->request('Plan/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Plan/Delete service using the API simulator.

ProductGroup


ProductGroup/Search

Search for product groups connected to your Cloud account.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/ProductGroup/Search
Parameters
Variable Required Description
product_group_id
Provide a prouct_group_id to search for a specific product group.
Successful Response

      {
    "ProductGroups": {
        "group": [
            {
                "@attributes": {
                    "group_id": "22",
                    "status": "1",
                    "moduleid_order": "1",
                    "moduleid_replenish": "10",
                    "moduleid_status": "2",
                    "moduleid_swap": "4",
                    "moduleid_cancel": ""
                },
                "name": "YW T-Mobile Network",
                "description": "\nIncludes service plans on the YW T-Mobile GSM network.\n",
                "variables": {
                    "VAR1": "IMEI",
                    "VAR2": "ICCID",
                    "VAR3": "MDN",
                    "VAR4": "Number_Port",
                    "VAR5": "Account_Number",
                    "VAR6": "PIN",
                    "VAR7": "SSN_or_TAX_ID",
                    "VAR8": "Mobile_Number",
                    "VAR9": "MINUTES_REMAINING",
                    "VAR10": "SMS_REMAINING",
                    "VAR11": "DATA_REMAINING",
                    "VAR12": "CASH_BALANCE",
                    "VAR13": "ORDER_ID",
                    "VAR15": "PREVIOUS_CARRIER"
                }
            },
            {
                "@attributes": {
                    "group_id": "72",
                    "status": "2",
                    "moduleid_order": "1",
                    "moduleid_replenish": "10",
                    "moduleid_status": "5",
                    "moduleid_swap": "4",
                    "moduleid_cancel": ""
                },
                "name": "YW Sprint Network",
                "description": "\nService on the nationwide Sprint network. Include the unlimited Sprint plan.\n",
                "variables": {
                    "VAR1": "MEID",
                    "VAR2": "ICCID",
                    "VAR3": "MDN",
                    "VAR4": "Number_Port",
                    "VAR5": "Account_Number",
                    "VAR6": "PIN",
                    "VAR7": "SSN_or_TAX_ID",
                    "VAR8": "Mobile_Number",
                    "VAR9": "MINUTES_REMAINING",
                    "VAR10": "SMS_REMAINING",
                    "VAR11": "DATA_REMAINING",
                    "VAR12": "CASH_BALANCE",
                    "VAR13": "ORDER_ID",
                    "VAR15": "PREVIOUS_CARRIER"
                }
            }
        ]
    }
}
      

<telecloud>
  <ProductGroups>
    <group group_id="22" status="1" moduleid_order="1" moduleid_replenish="10" moduleid_status="2" moduleid_swap="4" moduleid_cancel="">
      <name>YW T-Mobile Network</name>
      <description>Includes service plans on the YW T-Mobile GSM network.</description>
      <variables>
        <VAR1 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the IMEI from the GSM device." SWAPABLE="Y" PROMPT="Y" CATEGORY="">IMEI</VAR1>
        <VAR2 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the ICCID from the SIM card." SWAPABLE="Y" PROMPT="Y" CATEGORY="">ICCID</VAR2>
        <VAR3 TYPE="TEXT" OPTIONS="" DESCRIPTION="The customers 10 digit wireless number." SWAPABLE="N" PROMPT="N" CATEGORY="">MDN</VAR3>
        <VAR4 TYPE="OPTIONS" OPTIONS="NO,YES" DESCRIPTION="Choose YES or NO if porting, then complete all below fields." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Number_Port</VAR4>
        <VAR5 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the account number as listed with the previous provider." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Account_Number</VAR5>
        <VAR6 TYPE="TEXT" OPTIONS="" DESCRIPTION="The PIN or Account Password as listed with the previous provider." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">PIN</VAR6>
        <VAR7 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the primary account holders social security number or tax ID." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">SSN_or_TAX_ID</VAR7>
        <VAR8 TYPE="TEXT" OPTIONS="" DESCRIPTION="The mobile number the customer wishes to port." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Mobile_Number</VAR8>
        <VAR9 TYPE="TEXT" OPTIONS="" DESCRIPTION="Minutes remaining on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">MINUTES_REMAINING</VAR9>
        <VAR10 TYPE="TEXT" OPTIONS="" DESCRIPTION="SMS remaining on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">SMS_REMAINING</VAR10>
        <VAR11 TYPE="TEXT" OPTIONS="" DESCRIPTION="DATA remaining on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">DATA_REMAINING</VAR11>
        <VAR12 TYPE="TEXT" OPTIONS="" DESCRIPTION="Cash remaining on the account for extra services." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">CASH_BALANCE</VAR12>
        <VAR13 TYPE="TEXT" OPTIONS="" DESCRIPTION="The order ID from the HEG YW system." SWAPABLE="N" PROMPT="N" CATEGORY="Account Information">ORDER_ID</VAR13>
        <VAR15 TYPE="TEXT" OPTIONS="" DESCRIPTION="The name of the carrier the customer is porting from." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">PREVIOUS_CARRIER</VAR15>
      </variables>
    </group>
    <group group_id="72" status="2" moduleid_order="1" moduleid_replenish="10" moduleid_status="5" moduleid_swap="4" moduleid_cancel="">
      <name>YW Sprint Network</name>
      <description>Service on the nationwide Sprint network. Include the unlimited Sprint plan.</description>
      <variables>
        <VAR1 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the 15 or 18 digit MEID." SWAPABLE="Y" PROMPT="Y" CATEGORY="">MEID</VAR1>
        <VAR2 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the ICCID from the Sprint SIM card." SWAPABLE="Y" PROMPT="Y" CATEGORY="">ICCID</VAR2>
        <VAR3 TYPE="TEXT" OPTIONS="" DESCRIPTION="The customers 10 digit wireless number." SWAPABLE="N" PROMPT="N" CATEGORY="">MDN</VAR3>
        <VAR4 TYPE="OPTIONS" OPTIONS="NO,YES" DESCRIPTION="Choose YES or NO if porting, then complete all below fields." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Number_Port</VAR4>
        <VAR5 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the account number as listed with the previous provider." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Account_Number</VAR5>
        <VAR6 TYPE="TEXT" OPTIONS="" DESCRIPTION="The PIN or Account Password as listed with the previous provider." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">PIN</VAR6>
        <VAR7 TYPE="TEXT" OPTIONS="" DESCRIPTION="Enter the primary account holders social security number or tax ID." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">SSN_or_TAX_ID</VAR7>
        <VAR8 TYPE="TEXT" OPTIONS="" DESCRIPTION="The mobile number the customer wishes to port." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">Mobile_Number</VAR8>
        <VAR9 TYPE="TEXT" OPTIONS="" DESCRIPTION="Minutes remaining on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Porting Information">MINUTES_REMAINING</VAR9>
        <VAR10 TYPE="TEXT" OPTIONS="" DESCRIPTION="SMS remaining on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">SMS_REMAINING</VAR10>
        <VAR11 TYPE="TEXT" OPTIONS="" DESCRIPTION="DATA remaining on the current plan." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">DATA_REMAINING</VAR11>
        <VAR12 TYPE="TEXT" OPTIONS="" DESCRIPTION="Cash remaining on the account for extra services." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">CASH_BALANCE</VAR12>
        <VAR13 TYPE="TEXT" OPTIONS="" DESCRIPTION="The order ID from the HEG YW system." SWAPABLE="N" PROMPT="N" CATEGORY="Usage Information">ORDER_ID</VAR13>
        <VAR15 TYPE="TEXT" OPTIONS="" DESCRIPTION="The name of the previous carrier the customer is porting from." SWAPABLE="N" PROMPT="Y" CATEGORY="Porting Information">PREVIOUS_CARRIER</VAR15>
      </variables>
    </group>
  </ProductGroups>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('product_group_id' => "");

try { $responce = $tc->request('ProductGroup/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the ProductGroup/Search service using the API simulator.


ProductGroup/Create

Create a new product group. Variables should be seperated by hashes and formatted as follows:
Variable Name|Prompt for new orders? Either Y or N|Type of input. Either 'TEXT' or 'OPTIONS'|If input is options a comma seperated list OR XML URL.|A short description of the variable.|Y or N if the variable is swappable.|The category for the variable.

CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/ProductGroup/Create
Parameters
Variable Required Description
name
The name of the new product group
description
A descrtion of the product group for your reference.
moduleid_order
The ID of the module to call for new orders.
moduleid_replenish
The ID of the module to call for replenishments.
moduleid_status
The ID of the module to call for order status changes.
moduleid_swap
The ID of the module to call when variables are swapped on an order.
moduleid_cancel
The ID of the module to call when orders are cancelled.
VAR1
The value of variable 1 in the proper variable format.
VAR2
The value of variable 2 in the proper variable format.
VAR3
The value of variable 3 in the proper variable format.
VAR4
The value of variable 4 in the proper variable format.
VAR5
The value of variable 5 in the proper variable format.
VAR6
The value of variable 6 in the proper variable format.
VAR7
The value of variable 7 in the proper variable format.
VAR8
The value of variable 8 in the proper variable format.
VAR9
The value of variable 9 in the proper variable format.
VAR10
The value of variable 10 in the proper variable format.
VAR11
The value of variable 11 in the proper variable format.
VAR12
The value of variable 12 in the proper variable format.
VAR13
The value of variable 13 in the proper variable format.
VAR14
The value of variable 14 in the proper variable format.
VAR15
The value of variable 15 in the proper variable format.
VAR16
The value of variable 16 in the proper variable format.
VAR17
The value of variable 17 in the proper variable format.
VAR18
The value of variable 18 in the proper variable format.
VAR19
The value of variable 19 in the proper variable format.
VAR20
The value of variable 20 in the proper variable format.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123869"
    },
    "productgroup": {
        "@attributes": {
            "product_group_id": "75"
        }
    }
}
      

<telecloud trans_id="3123869">
  <productgroup product_group_id="75" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('name' => "",'description' => "",'moduleid_order' => "",'moduleid_replenish' => "",'moduleid_status' => "",'moduleid_swap' => "",'moduleid_cancel' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "");

try { $responce = $tc->request('ProductGroup/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the ProductGroup/Create service using the API simulator.


ProductGroup/Edit

Edit and make changes to an existing product group.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/ProductGroup/Edit
Parameters
Variable Required Description
product_group_id
The ID of the product group you wish to edit.
name
The name of the new product group
description
A descrtion of the product group for your reference.
moduleid_order
The ID of the module to call for new orders.
moduleid_replenish
The ID of the module to call for replenishments.
moduleid_status
The ID of the module to call for order status changes.
moduleid_swap
The ID of the module to call when variables are swapped on an order.
moduleid_cancel
The ID of the module to call when orders are cancelled.
VAR1
The value of variable 1 in the proper variable format.
VAR2
The value of variable 2 in the proper variable format.
VAR3
The value of variable 3 in the proper variable format.
VAR4
The value of variable 4 in the proper variable format.
VAR5
The value of variable 5 in the proper variable format.
VAR6
The value of variable 6 in the proper variable format.
VAR7
The value of variable 7 in the proper variable format.
VAR8
The value of variable 8 in the proper variable format.
VAR9
The value of variable 9 in the proper variable format.
VAR10
The value of variable 10 in the proper variable format.
VAR11
The value of variable 11 in the proper variable format.
VAR12
The value of variable 12 in the proper variable format.
VAR13
The value of variable 13 in the proper variable format.
VAR14
The value of variable 14 in the proper variable format.
VAR15
The value of variable 15 in the proper variable format.
VAR16
The value of variable 16 in the proper variable format.
VAR17
The value of variable 17 in the proper variable format.
VAR18
The value of variable 18 in the proper variable format.
VAR19
The value of variable 19 in the proper variable format.
VAR20
The value of variable 20 in the proper variable format.
status
Either 1 for unlocked or 2 for locked.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123999"
    },
    "productgroup": {
        "@attributes": {
            "product_group_id": "75"
        }
    }
}
      

<telecloud trans_id="3123999">
  <productgroup product_group_id="75" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('product_group_id' => "",'name' => "",'description' => "",'moduleid_order' => "",'moduleid_replenish' => "",'moduleid_status' => "",'moduleid_swap' => "",'moduleid_cancel' => "",'VAR1' => "",'VAR2' => "",'VAR3' => "",'VAR4' => "",'VAR5' => "",'VAR6' => "",'VAR7' => "",'VAR8' => "",'VAR9' => "",'VAR10' => "",'VAR11' => "",'VAR12' => "",'VAR13' => "",'VAR14' => "",'VAR15' => "",'VAR16' => "",'VAR17' => "",'VAR18' => "",'VAR19' => "",'VAR20' => "",'status' => "");

try { $responce = $tc->request('ProductGroup/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the ProductGroup/Edit service using the API simulator.

Module


Module/Search

Search for existing modules under your control.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Module/Search
Parameters
Variable Required Description
module_id
Provide a 'module_id' to search for a specific real-time module
Successful Response

      {
    "Modules": {
        "module": {
            "@attributes": {
                "module_id": "26"
            },
            "name": "VZW 4G SIM Swap",
            "description": "Swap the SIM on a Verizon 4G plan.",
            "url": "\nhttps:\/\/yourwebsite.com\/modules_folder\/sim_swap.asp\n",
            "status": {}
        }
    }
}
      

<telecloud>
  <Modules>
    <module module_id="26">
      <name>VZW 4G SIM Swap</name>
      <description>Swap the SIM on a Verizon 4G plan.</description>
      <url>https://yourwebsite.com/modules_folder/sim_swap.asp</url>
      <status />
    </module>
  </Modules>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('module_id' => "");

try { $responce = $tc->request('Module/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Module/Search service using the API simulator.


Module/Create

Create a module for real-time processing for a product group.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Module/Create
Parameters
Variable Required Description
name
A name for the real-time module.
description
A description of the module for future reference.
url
The full url to the location of your module file.
status
The status of your module. Options are either 1 for active or 2 for suspended.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123887"
    },
    "module": {
        "@attributes": {
            "module_id": "32"
        }
    }
}
      

<telecloud trans_id="3123887">
  <module module_id="32" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('name' => "",'description' => "",'url' => "",'status' => "");

try { $responce = $tc->request('Module/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Module/Create service using the API simulator.


Module/Edit

Edit and make changes to an existing module.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Module/Edit
Parameters
Variable Required Description
module_id
The module_id of the real time module you wish to edit.
name
A name for the real-time module.
description
A description of the module for future reference.
url
The full url to the location of your module file.
status
The status of your module. Options are either 1 for active or 2 for suspended.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123887"
    },
    "module": {
        "@attributes": {
            "module_id": "32"
        }
    }
}
      

<telecloud trans_id="3123887">
  <module module_id="32" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('module_id' => "",'name' => "",'description' => "",'url' => "",'status' => "");

try { $responce = $tc->request('Module/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Module/Edit service using the API simulator.


Module/Delete

Delete an existing module. NOTE: Deleting a module will prevent it from being utilized in previously assigned product groups.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/Module/Delete
Parameters
Variable Required Description
module_id
The module_id of the real time module you wish to delete.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123893"
    },
    "module": {
        "@attributes": {
            "module_id": "8"
        }
    }
}
      

<telecloud trans_id="3123893">
  <module module_id="8" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('module_id' => "");

try { $responce = $tc->request('Module/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Module/Delete service using the API simulator.

User


User/Search

Get a list of users connected to your Cloud account.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/User/Search
Parameters
Variable Required Description
user_id
Provide a user_id to get the details of a specific user.
Successful Response

      {
    "Users": {
        "user": [
            {
                "@attributes": {
                    "user_id": "232",
                    "profile_img": "https:\/\/secureaccesspoint.com\/profileimg\/112333587627.png"
                },
                "username": "some_one1",
                "email": "test@hawkinsegroup.com",
                "first_name": "Test",
                "last_name": "User",
                "initial_password": "144era",
                "access_level": "ADMIN",
                "status": "1",
                "last_login": "2019-07-07 12:59:52",
                "last_ip": "24.745.11.13"
            },
            {
                "@attributes": {
                    "user_id": "233",
                    "profile_img": "https:\/\/secureaccesspoint.com\/profileimg\/20488774561722452.jpg"
                },
                "username": "some_one2",
                "email": "legal@hawkinsegroup.com",
                "first_name": "Chris",
                "last_name": "Cooper",
                "initial_password": "788733rr",
                "access_level": "ADMIN",
                "status": "1",
                "last_login": "2018-04-09 18:27:56",
                "last_ip": "91.422.38.250"
            }
        ]
    }
}
      

<telecloud>
  <Users>
    <user user_id="232" profile_img="https://secureaccesspoint.com/profileimg/112333587627.png">
      <username>some_one1</username>
      <email>test@hawkinsegroup.com</email>
      <first_name>Test</first_name>
      <last_name>User</last_name>
      <initial_password>144era</initial_password>
      <access_level>ADMIN</access_level>
      <status>1</status>
      <last_login>2019-07-07 12:59:52</last_login>
      <last_ip>24.745.11.13</last_ip>
    </user>
    <user user_id="233" profile_img="https://secureaccesspoint.com/profileimg/20488774561722452.jpg">
      <username>some_one2</username>
      <email>legal@hawkinsegroup.com</email>
      <first_name>Chris</first_name>
      <last_name>Cooper</last_name>
      <initial_password>788733rr</initial_password>
      <access_level>ADMIN</access_level>
      <status>1</status>
      <last_login>2018-04-09 18:27:56</last_login>
      <last_ip>91.422.38.250</last_ip>
    </user>
  </Users>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('user_id' => "");

try { $responce = $tc->request('User/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the User/Search service using the API simulator.


User/Create

Create a new user under your Cloud account.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/User/Create
Parameters
Variable Required Description
email
The e-mail address of the user. The system will send the initial password to this address.
first_name
The first name of the user
last_name
The last name of the user
access_level
The user access level. Options are ADMIN; STAFF; or SUPPORT.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123913"
    },
    "user": {
        "@attributes": {
            "user_id": "4717"
        },
        "username": "chris_westbrook2",
        "initial_password": "2ne6j"
    }
}
      

<telecloud trans_id="3123913">
  <user user_id="4717">
    <username>chris_westbrook2</username>
    <initial_password>2ne6j</initial_password>
  </user>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('email' => "",'first_name' => "",'last_name' => "",'access_level' => "");

try { $responce = $tc->request('User/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the User/Create service using the API simulator.


User/Edit

Edit an existing user under your Cloud account.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/User/Edit
Parameters
Variable Required Description
user_id
The user_id of the user you wish to edit.
first_name
The first name of the user
last_name
The last name of the user
email
The email address of the user
access_level
The user access level. Options are ADMIN; STAFF; or SUPPORT.
status
The status of the user. 1 for active or 2 for locked.
profile_image_url
Provide a new url to a profile image. The image will be fetched and stored on the TeleCloud.app servers
Successful Response

      {
    "@attributes": {
        "trans_id": "3123901"
    },
    "user": {
        "@attributes": {
            "user_id": "518"
        }
    }
}
      

<telecloud trans_id="3123901">
  <user user_id="518" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('user_id' => "",'first_name' => "",'last_name' => "",'email' => "",'access_level' => "",'status' => "",'profile_image_url' => "");

try { $responce = $tc->request('User/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the User/Edit service using the API simulator.

Ticket


Ticket/Search

Search support tickets using specified criteria. To view the messages connected to a specific ticket provide the 'ticket_id'.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Ticket/Search
Parameters
Variable Required Description
ticket_id
Specify a ticket_id to view only the specified ticket and the messages posted on that ticket.
account_number
Specify a customer account number to view tickets connected to the account.
order_number
Specify a order number to view tickets connected to an order number.
cloud_account_type
The type of cloud account you are searching. Only needed when searching for tickets connected to a cloud account under your control.
cloud_account_number
To search for tickets connected to a specific cloud account under your control specify the cloud account number.
direction
Either INTERNAL or EXPERNAL.
status
Search for tickets only wtih a specified status; options include 'OPEN'; 'ANSWERED'; 'CLOSED'; and 'WORKING'.
Successful Response

      {
    "Tickets": {
        "@attributes": {
            "results": "1"
        },
        "ticket": {
            "@attributes": {
                "ticket_id": "WHE-77971",
                "ticket_email": "440-WHE-77971@telecloud.app"
            },
            "date": "2016-01-15 18:59:02",
            "CORE": "Hawkins Enterprise Group LLC",
            "VAR": "ZillaTalk",
            "direction": "EXTERNAL",
            "opened_by": "Chad Hawkins [VAR]",
            "opened_via": "POST",
            "department": "TECH SUPPORT",
            "subject": "Connection and MMS Issues",
            "message": "\n<p>Customer having a problem with connection and MMS issue son iPhone 6+<\/p><p>Don<\/p>\n",
            "attachments": {
                "@attributes": {
                    "results": "2"
                },
                "file": [
                    "\nhttps:\/\/telecloud.app\/attachments\/1563155912634.jpg\n",
                    "\nhttps:\/\/telecloud.app\/attachments\/1563155912534.png\n"
                ]
            },
            "status": "CLOSED",
            "reply": [
                {
                    "@attributes": {
                        "message_id": "791"
                    },
                    "date": "2016-01-15 19:00:02",
                    "posted_by": "Chad Hawkins [VAR]",
                    "posted_via": "POST",
                    "message": "\n<p>GSM Network iPHone:<br><br>Apple iPhone - Internet and MMS (iOS Version 6 or Later)<br>Go to \"Settings\", tap on WiFi and temporarily turn it OFF<br>Back in \"Settings\", scroll down to \"Messages\" and tap to open it. Make sure MMS is OFF<br>Go back to \"Settings\", tap on \"General\" and then \"Cellular\". Make sure \"Enable 3G\" is OFF &amp; \"Data Roaming\" is ON.<br>Scroll down &amp; tap on \"Cellular Data Network\"<br>Under \"Cellular Data Network\" put in the following:<br>Cellular Data APN: pwg<br>MMS APN: pwg<br>MMSC: http:\/\/pwg.mmsmvno.com\/mms.wapenc (needs to be \".com\/mms\/wapenc\"<br>MMS Proxy: 216.155.165.50 (deleted this, and MMS could send to non iphones)<br>MMS Max Message Size: 1048576<br>MMS UA Prof URL: http:\/\/www.apple.com\/mms\/uaprof.rdf<br>Leave all other fields blank<br><br><\/p><p>Click on the Home button to go back to the main phone screen<br>Go back to \"Settings\" one more time, scroll down and tap on \"Messages\" and turn it ON<br>Press the Home button and you're set to send &amp; receive MMS on PWG<br>Once you have set it up and tested to see it works, you can re-enable WiFi, turn off Data Roaming and turn on 3G<br><\/p><p><br><\/p><p><br><\/p>\n"
                },
                {
                    "@attributes": {
                        "message_id": "814"
                    },
                    "date": "2016-01-29 08:58:22",
                    "posted_by": "DON HAWKINS [CORE]",
                    "posted_via": "POST",
                    "message": "<p><br><\/p>"
                }
            ]
        }
    }
}
      

<telecloud>
  <Tickets results="1">
    <ticket ticket_id="WHE-77971" ticket_email="440-WHE-77971@telecloud.app">
      <date unix="1452902342" last_reply="0000-00-00 00:00:00" elapsed_time="About 1275 day(s) ago.">2016-01-15 18:59:02</date>
      <CORE cloud_account_number="0628198300">Hawkins Enterprise Group LLC</CORE>
      <VAR cloud_account_number="1992093958">ZillaTalk</VAR>
      <direction>EXTERNAL</direction>
      <opened_by icon_url="https://telecloud.app/images/icon_person_placeholder.png">Chad Hawkins [VAR]</opened_by>
      <opened_via>POST</opened_via>
      <department>TECH SUPPORT</department>
      <subject>Connection and MMS Issues</subject>
      <message>&lt;p&gt;Customer having a problem with connection and MMS issue son iPhone 6+&lt;/p&gt;&lt;p&gt;Don&lt;/p&gt;</message>
      <attachments results="2">
        <file>https://telecloud.app/attachments/1563155912634.jpg</file>
        <file>https://telecloud.app/attachments/1563155912534.png</file>
      </attachments>
      <status>CLOSED</status>
      <reply message_id="791">
        <date unix="1452902402" elapsed_time="About 1275 day(s) ago.">2016-01-15 19:00:02</date>
        <posted_by type="STAFF" icon_url="https://telecloud.app/images/icon_person_placeholder.png">Chad Hawkins [VAR]</posted_by>
        <posted_via>POST</posted_via>
        <message>&lt;p&gt;GSM Network iPHone:&lt;br&gt;&lt;br&gt;Apple iPhone - Internet and MMS (iOS Version 6 or Later)&lt;br&gt;Go to "Settings", tap on WiFi and temporarily turn it OFF&lt;br&gt;Back in "Settings", scroll down to "Messages" and tap to open it. Make sure MMS is OFF&lt;br&gt;Go back to "Settings", tap on "General" and then "Cellular". Make sure "Enable 3G" is OFF &amp;amp; "Data Roaming" is ON.&lt;br&gt;Scroll down &amp;amp; tap on "Cellular Data Network"&lt;br&gt;Under "Cellular Data Network" put in the following:&lt;br&gt;Cellular Data APN: pwg&lt;br&gt;MMS APN: pwg&lt;br&gt;MMSC: http://pwg.mmsmvno.com/mms.wapenc (needs to be ".com/mms/wapenc"&lt;br&gt;MMS Proxy: 216.155.165.50 (deleted this, and MMS could send to non iphones)&lt;br&gt;MMS Max Message Size: 1048576&lt;br&gt;MMS UA Prof URL: http://www.apple.com/mms/uaprof.rdf&lt;br&gt;Leave all other fields blank&lt;br&gt;&lt;br&gt;&lt;/p&gt;&lt;p&gt;Click on the Home button to go back to the main phone screen&lt;br&gt;Go back to "Settings" one more time, scroll down and tap on "Messages" and turn it ON&lt;br&gt;Press the Home button and you're set to send &amp;amp; receive MMS on PWG&lt;br&gt;Once you have set it up and tested to see it works, you can re-enable WiFi, turn off Data Roaming and turn on 3G&lt;br&gt;&lt;/p&gt;&lt;p&gt;&lt;br&gt;&lt;/p&gt;&lt;p&gt;&lt;br&gt;&lt;/p&gt;</message>
      </reply>
      <reply message_id="814">
        <date unix="1454075902" elapsed_time="About 1261 day(s) ago.">2016-01-29 08:58:22</date>
        <posted_by type="STAFF" icon_url="https://telecloud.app/images/icon_person_placeholder.png">DON HAWKINS [CORE]</posted_by>
        <posted_via>POST</posted_via>
        <message>&lt;p&gt;&lt;br&gt;&lt;/p&gt;</message>
      </reply>
    </ticket>
  </Tickets>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('ticket_id' => "",'account_number' => "",'order_number' => "",'cloud_account_type' => "",'cloud_account_number' => "",'direction' => "",'status' => "");

try { $responce = $tc->request('Ticket/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Ticket/Search service using the API simulator.


Ticket/Create

Creates a support ticket.
Tickets are considered opened by a customer when direction is set to "EXTERNAL-CUSTOMER", account_number must be provided.
Tickets are considered opened by a guest when "guest_email" is provided.
Tickets are considered opened by a staff member (the API user) when neither "guest_email" is provided and direction is not set to "EXTERNAL-CUSTOMER".

CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Ticket/Create
Parameters
Variable Required Description
subject
The subject of the ticket; 10 character minimum.
department
Options are SALES; TECH SUPPORT; and BILLING.
message
The original message or request of the support ticket.
direction
Either INTERNAL; EXTERNAL; or EXTERNAL-CUSTOMER. Customers can view EXTERNAL tickets. EXTERNAL-CUSTOMER tickets are considered opened by the customer.
guest_email
If a customer or potential customer (GUEST) is opening the ticket provide their e-mail address.
account_number
Provide a customer account number to link the ticket to a customer account.
order_number
Provide a order number to link the ticket to a order number on the provided account_number.
cloud_account_type
Provide the type of cloud account to link the ticket to a cloud account under your control.
cloud_account_number
Provide the cloud account number to link the ticket to a cloud account under your control.
attachments
A comma seperated list of images you wish to attach to the ticket/reply. Must be the full url path to an image.
Successful Response

      {
    "@attributes": {
        "trans_id": "3123957"
    },
    "ticket": {
        "@attributes": {
            "ticket_id": "PBCM-91777"
        }
    }
}
      

<telecloud trans_id="3123957">
  <ticket ticket_id="PBCM-91777" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('subject' => "",'department' => "",'message' => "",'direction' => "",'guest_email' => "",'account_number' => "",'order_number' => "",'cloud_account_type' => "",'cloud_account_number' => "",'attachments' => "");

try { $responce = $tc->request('Ticket/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Ticket/Create service using the API simulator.


Ticket/Reply

Post a reply to an existing support ticket. Similar rules apply to opening a support ticket. To post a reply as a customer pass the 'account_number' parameter.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Ticket/Reply
Parameters
Variable Required Description
ticket_id
The ticket_id of the ticket you wish to post a reply on.
message
The contents on your message or reply.
guest_email
If a customer or potential customer (GUEST) is opening the ticket provide their e-mail address.
account_number
Provide a customer account number to post the replay as the customer.
attachments
A comma seperated list of images you wish to attach to the ticket/reply. Must be the full url path to an image.
working
To place the ticket in a WORKING status provide a 'Y'.
Successful Response

      {
    "@attributes": {
        "trans_id": "3124051"
    },
    "ticket": {
        "@attributes": {
            "ticket_id": "UWXCLP-96302"
        }
    }
}
      

<telecloud trans_id="3124051">
  <ticket ticket_id="UWXCLP-96302" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('ticket_id' => "",'message' => "",'guest_email' => "",'account_number' => "",'attachments' => "",'working' => "");

try { $responce = $tc->request('Ticket/Reply','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Ticket/Reply service using the API simulator.


Ticket/Edit

Change the status of a support ticket. Most status changes are automatic, this function allows you to change the ticket to either 'CLOSED' or 'ON-HOLD'.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Ticket/Edit
Parameters
Variable Required Description
ticket_id
The ticket_id of the ticket you wish to change the status of.
new_status
The new status of the ticket.
Successful Response

      {
    "@attributes": {
        "trans_id": "3124157"
    },
    "ticket": {
        "@attributes": {
            "ticket_id": "MVEM-23948"
        }
    }
}
      

<telecloud trans_id="3124157">
  <ticket ticket_id="MVEM-23948" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('ticket_id' => "",'new_status' => "");

try { $responce = $tc->request('Ticket/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Ticket/Edit service using the API simulator.

Promo


Promo/Search

Find all promotions you've created.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Promo/Search
Parameters
Variable Required Description
promo_code
To find a specific promotion provide the promo code.
Successful Response

      {
    "Promotions": {
        "promo": [
            {
                "@attributes": {
                    "promo_id": "2",
                    "rate_plan_id": "1441"
                },
                "promo_code": "51515",
                "value": "50.00",
                "expiration_date": {}
            },
            {
                "@attributes": {
                    "promo_id": "1",
                    "rate_plan_id": ""
                },
                "promo_code": "20off",
                "value": "12.35",
                "expiration_date": "7\/17\/2019"
            }
        ]
    }
}
      

<telecloud>
  <Promotions>
    <promo promo_id="2" rate_plan_id="1441">
      <promo_code>51515</promo_code>
      <value>50.00</value>
      <expiration_date />
    </promo>
    <promo promo_id="1" rate_plan_id="">
      <promo_code>20off</promo_code>
      <value>12.35</value>
      <expiration_date>7/17/2019</expiration_date>
    </promo>
  </Promotions>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('promo_code' => "");

try { $responce = $tc->request('Promo/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Promo/Search service using the API simulator.


Promo/Create

Create a promo code for your customers.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Promo/Create
Parameters
Variable Required Description
promo_code
The promotion code you wish to use.
value
The value of the promo code in full dollar amounts.
expiration_date
The day the promo code should become no longer valid.
rate_plan_id
Provide a rate_plan_id to associate this promo code with a specific rate plan.
Successful Response

      {
    "@attributes": {
        "trans_id": "3124120"
    },
    "promo": {
        "@attributes": {
            "promo_id": "5547"
        }
    }
}
      

<telecloud trans_id="3124120">
  <promo promo_id="5547" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('promo_code' => "",'value' => "",'expiration_date' => "",'rate_plan_id' => "");

try { $responce = $tc->request('Promo/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Promo/Create service using the API simulator.


Promo/Delete

Delete a promo code.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/Promo/Delete
Parameters
Variable Required Description
promo_code
The promotion code you wish to delete.
Successful Response

      {
    "@attributes": {
        "trans_id": "3124151"
    },
    "promo": {
        "@attributes": {
            "promo_id": "10"
        }
    }
}
      

<telecloud trans_id="3124151">
  <promo promo_id="10" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('promo_code' => "");

try { $responce = $tc->request('Promo/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Promo/Delete service using the API simulator.

Reports


Reports/Search

Search for reports on a cloud account under your control, a customer account, or your own account.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Reports/Search
Parameters
Variable Required Description
account_number
To find repors about a specific customer account.
cloud_account_type
The type of cloud account you wish to pull reports for. Leave blank to get reports about your own account.
cloud_account_number
The cloud account number. Provide only if cloud_account_type is set.
Successful Response

      {
    "Reports": {
        "account_number": "7105045",
        "orders": {
            "active": "2",
            "suspended": "1",
            "non-pay": "0",
            "cancelled": "7",
            "churn": {
                "item": [
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0",
                    "0"
                ]
            }
        },
        "financial": {
            "wholesale_spend": {
                "current_month": "0.00",
                "previous_month": "0.00",
                "history": {
                    "month_1": "0.00",
                    "month_2": "0.00",
                    "month_3": "0.00",
                    "month_4": "0.00",
                    "month_5": "0.00",
                    "month_6": "0.00",
                    "month_7": "0.00",
                    "month_8": "0.00",
                    "month_9": "0.00",
                    "month_10": "0.00",
                    "month_11": "0.00",
                    "month_12": "0.00"
                }
            },
            "income": {
                "current_month": "0.00",
                "previous_month": "0.00",
                "history": {
                    "month_1": "0.00",
                    "month_2": "0.00",
                    "month_3": "0.00",
                    "month_4": "0.00",
                    "month_5": "0.00",
                    "month_6": "0.00",
                    "month_7": "0.00",
                    "month_8": "0.00",
                    "month_9": "0.00",
                    "month_10": "0.00",
                    "month_11": "0.00",
                    "month_12": "0.00"
                }
            }
        },
        "tickets": {
            "internal": {
                "open": "0",
                "answered": "0",
                "working": "0",
                "closed": "1"
            },
            "external": {
                "open": "0",
                "answered": "0",
                "working": "0",
                "closed": "2"
            }
        }
    }
}
      

<telecloud>
  <Reports>
    <account_number>7105045</account_number>
    <orders>
      <active>2</active>
      <suspended>1</suspended>
      <non-pay>0</non-pay>
      <cancelled>7</cancelled>
      <churn>
        <item date="2019-07-31" churn="">0</item>
        <item date="2019-07-30" churn="">0</item>
        <item date="2019-07-29" churn="">0</item>
        <item date="2019-07-28" churn="">0</item>
        <item date="2019-07-27" churn="">0</item>
        <item date="2019-07-26" churn="">0</item>
        <item date="2019-07-25" churn="">0</item>
        <item date="2019-07-24" churn="">0</item>
        <item date="2019-07-23" churn="">0</item>
        <item date="2019-07-22" churn="">0</item>
        <item date="2019-07-21" churn="">0</item>
        <item date="2019-07-20" churn="">0</item>
        <item date="2019-07-19" churn="">0</item>
        <item date="2019-07-18" churn="">0</item>
        <item date="2019-07-17" churn="">0</item>
        <item date="2019-07-16" churn="">0</item>
        <item date="2019-07-15" churn="">0</item>
        <item date="2019-07-14" churn="">0</item>
        <item date="2019-07-13" churn="">0</item>
        <item date="2019-07-12" churn="">0</item>
        <item date="2019-07-11" churn="">0</item>
        <item date="2019-07-10" churn="">0</item>
        <item date="2019-07-09" churn="">0</item>
        <item date="2019-07-08" churn="">0</item>
        <item date="2019-07-07" churn="">0</item>
        <item date="2019-07-06" churn="">0</item>
        <item date="2019-07-05" churn="">0</item>
        <item date="2019-07-04" churn="">0</item>
        <item date="2019-07-03" churn="">0</item>
        <item date="2019-07-02" churn="">0</item>
      </churn>
    </orders>
    <financial>
      <wholesale_spend>
        <current_month>0.00</current_month>
        <previous_month>0.00</previous_month>
        <history>
          <month_1 month_name="JUNE" month_year="2019-06">0.00</month_1>
          <month_2 month_name="MAY" month_year="2019-05">0.00</month_2>
          <month_3 month_name="APRIL" month_year="2019-04">0.00</month_3>
          <month_4 month_name="MARCH" month_year="2019-03">0.00</month_4>
          <month_5 month_name="FEBRUARY" month_year="2019-02">0.00</month_5>
          <month_6 month_name="JANUARY" month_year="2019-01">0.00</month_6>
          <month_7 month_name="DECEMBER" month_year="2018-12">0.00</month_7>
          <month_8 month_name="NOVEMBER" month_year="2018-11">0.00</month_8>
          <month_9 month_name="OCTOBER" month_year="2018-10">0.00</month_9>
          <month_10 month_name="SEPTEMBER" month_year="2018-09">0.00</month_10>
          <month_11 month_name="AUGUST" month_year="2018-08">0.00</month_11>
          <month_12 month_name="JULY" month_year="2018-07">0.00</month_12>
        </history>
      </wholesale_spend>
      <income>
        <current_month>0.00</current_month>
        <previous_month>0.00</previous_month>
        <history>
          <month_1 month_name="JUNE" month_year="2019-06">0.00</month_1>
          <month_2 month_name="MAY" month_year="2019-05">0.00</month_2>
          <month_3 month_name="APRIL" month_year="2019-04">0.00</month_3>
          <month_4 month_name="MARCH" month_year="2019-03">0.00</month_4>
          <month_5 month_name="FEBRUARY" month_year="2019-02">0.00</month_5>
          <month_6 month_name="JANUARY" month_year="2019-01">0.00</month_6>
          <month_7 month_name="DECEMBER" month_year="2018-12">0.00</month_7>
          <month_8 month_name="NOVEMBER" month_year="2018-11">0.00</month_8>
          <month_9 month_name="OCTOBER" month_year="2018-10">0.00</month_9>
          <month_10 month_name="SEPTEMBER" month_year="2018-09">0.00</month_10>
          <month_11 month_name="AUGUST" month_year="2018-08">0.00</month_11>
          <month_12 month_name="JULY" month_year="2018-07">0.00</month_12>
        </history>
      </income>
    </financial>
    <tickets>
      <internal>
        <open>0</open>
        <answered>0</answered>
        <working>0</working>
        <closed>1</closed>
      </internal>
      <external>
        <open>0</open>
        <answered>0</answered>
        <working>0</working>
        <closed>2</closed>
      </external>
    </tickets>
  </Reports>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('account_number' => "",'cloud_account_type' => "",'cloud_account_number' => "");

try { $responce = $tc->request('Reports/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Reports/Search service using the API simulator.

Notifications


Notifications/Search

Get a list of your notifications and associated settings.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Notifications/Search
Parameters
Variable Required Description
notification_type
The type of notification.
notification_id
The ID of a specific notification.
Successful Response

      {
    "Notifications": {
        "notification": {
            "@attributes": {
                "notification_id": "7",
                "notify_customer": "Y"
            },
            "event": "Order\/Create",
            "from_email": "newemail@mybrand.com",
            "html": {},
            "html_customer": {}
        }
    }
}
      

<telecloud>
  <Notifications>
    <notification notification_id="7" notify_customer="Y">
      <event customer_notification_available="Y">Order/Create</event>
      <from_email>newemail@mybrand.com</from_email>
      <html>
<![CDATA[<p><html>New Client HTML</html></p>]]>
      </html>
      <html_customer>
<![CDATA[<p><html>New Customer HTML</html></p>]]>
      </html_customer>
    </notification>
  </Notifications>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('notification_type' => "",'notification_id' => "");

try { $responce = $tc->request('Notifications/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Notifications/Search service using the API simulator.


Notifications/Create

Create a new notification type.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Notifications/Create
Parameters
Variable Required Description
event
The type of event you wish to setup notifications for.

Acceptable values are:
'CloudAccount/Create'
'Ticket/Create'
'Ticket/Reply'
'Order/Create'
'Order/Replenish'
'Order/Cancel'
notify_customer
If the customer should receive a customer notification for the event (only applies to events where a customer account is associated). Y or N are acceptable values.
html
The html content of the notification
html_customer
The html content of the notification sent to the customer (required when 'notify_customer' is Y).
from_email
The e-mail address the notification should be sent from.
Successful Response

      {
    "@attributes": {
        "trans_id": "3129380",
        "notify_customer": "Y"
    },
    "notification": {
        "@attributes": {
            "notification_id": "7"
        },
        "event": "Order\/Create",
        "from_email": "orders@mybrand.com",
        "html": {},
        "html_customer": {}
    }
}
      

<telecloud trans_id="3129380" notify_customer="Y">
  <notification notification_id="7">
    <event>Order/Create</event>
    <from_email>orders@mybrand.com</from_email>
    <html>
<![CDATA[<p><html>Stuff</html></p>]]>
    </html>
    <html_customer>
<![CDATA[<p><html>Customer Stuff</html></p>]]>
    </html_customer>
  </notification>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('event' => "",'notify_customer' => "",'html' => "",'html_customer' => "",'from_email' => "");

try { $responce = $tc->request('Notifications/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Notifications/Create service using the API simulator.


Notifications/Edit

Make chages to a previously created notification.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Notifications/Edit
Parameters
Variable Required Description
notification_id
The ID of the notification you wish to edit.
event
The type of event you wish to setup notifications for. Acceptable values are 'CloudAccount/Create' or 'Ticket/Create' or 'Ticket/Reply' or 'Order/Create' or 'Order/Replenish' or 'Order/Cancel'
notify_customer
If the customer should receive a customer notification for the event (only applies to events where a customer account is associated). Y or N are acceptable values.
html
The html content of the notification.
html_customer
The html content of the notification sent to the customer (required when 'notify_customer' is Y).
from_email
The e-mail address the notification should be sent from.
Successful Response

      {
    "@attributes": {
        "trans_id": "3129383"
    },
    "notification": {
        "@attributes": {
            "notification_id": "",
            "notify_customer": "Y"
        },
        "event": "Order\/Create",
        "from_email": "newemail@mybrand.com",
        "html": {},
        "html_customer": {}
    }
}
      

<telecloud trans_id="3129383">
  <notification notification_id="" notify_customer="Y">
    <event>Order/Create</event>
    <from_email>newemail@mybrand.com</from_email>
    <html>
<![CDATA[<p><html>New Client HTML</html></p>]]>
    </html>
    <html_customer>
<![CDATA[<p><html>New Customer HTML</html></p>]]>
    </html_customer>
  </notification>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('notification_id' => "",'event' => "",'notify_customer' => "",'html' => "",'html_customer' => "",'from_email' => "");

try { $responce = $tc->request('Notifications/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Notifications/Edit service using the API simulator.


Notifications/Delete

Delete a notification.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/Notifications/Delete
Parameters
Variable Required Description
notification_id
The notification_id of the notification you wish to delete.
Successful Response

      {
    "@attributes": {
        "trans_id": "3129072"
    },
    "notification": {
        "@attributes": {
            "notification_id": "181871"
        }
    }
}
      

<telecloud trans_id="3129072">
  <notification notification_id="181871" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('notification_id' => "");

try { $responce = $tc->request('Notifications/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Notifications/Delete service using the API simulator.


Notifications/SearchTemplate

Get the original template for a specific event notification.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Notifications/SearchTemplate
Parameters
Variable Required Description
event
The name of the event you wish to view the template for.
Successful Response

      {
    "templates": {
        "notification_template": [
            {
                "@attributes": {
                    "template_id": "6"
                },
                "event": "Ticket\/Reply",
                "cloud_notification_status": "NOT READY",
                "customer_notification_status": "NOT READY"
            },
            {
                "@attributes": {
                    "template_id": "5"
                },
                "event": "Order\/Cancel",
                "cloud_notification_status": "NOT READY",
                "customer_notification_status": "NOT READY"
            },
            {
                "@attributes": {
                    "template_id": "4"
                },
                "event": "Order\/Replenish",
                "cloud_notification_status": "NOT READY",
                "customer_notification_status": "NOT READY"
            },
            {
                "@attributes": {
                    "template_id": "3"
                },
                "event": "Order\/Create",
                "cloud_notification_status": "READY",
                "customer_notification_status": "READY"
            },
            {
                "@attributes": {
                    "template_id": "2"
                },
                "event": "CloudAccount\/Create",
                "cloud_notification_status": "NOT READY",
                "customer_notification_status": "NOT READY"
            },
            {
                "@attributes": {
                    "template_id": "1"
                },
                "event": "Ticket\/Create",
                "cloud_notification_status": "NOT READY",
                "customer_notification_status": "NOT READY"
            }
        ]
    }
}
      

<telecloud>
  <templates>
    <notification_template template_id="6">
      <event customer_notification_available="Y">Ticket/Reply</event>
      <cloud_notification_status>NOT READY</cloud_notification_status>
      <customer_notification_status>NOT READY</customer_notification_status>
    </notification_template>
    <notification_template template_id="5">
      <event customer_notification_available="Y">Order/Cancel</event>
      <cloud_notification_status>NOT READY</cloud_notification_status>
      <customer_notification_status>NOT READY</customer_notification_status>
    </notification_template>
    <notification_template template_id="4">
      <event customer_notification_available="Y">Order/Replenish</event>
      <cloud_notification_status>NOT READY</cloud_notification_status>
      <customer_notification_status>NOT READY</customer_notification_status>
    </notification_template>
    <notification_template template_id="3">
      <event customer_notification_available="Y">Order/Create</event>
      <cloud_notification_status>READY</cloud_notification_status>
      <customer_notification_status>READY</customer_notification_status>
    </notification_template>
    <notification_template template_id="2">
      <event customer_notification_available="N">CloudAccount/Create</event>
      <cloud_notification_status>NOT READY</cloud_notification_status>
      <customer_notification_status>NOT READY</customer_notification_status>
    </notification_template>
    <notification_template template_id="1">
      <event customer_notification_available="Y">Ticket/Create</event>
      <cloud_notification_status>NOT READY</cloud_notification_status>
      <customer_notification_status>NOT READY</customer_notification_status>
    </notification_template>
  </templates>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('event' => "");

try { $responce = $tc->request('Notifications/SearchTemplate','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Notifications/SearchTemplate service using the API simulator.

Gateways


Gateways/Search

Get a list of all supported payment gatways in addition to the payment gateways setup on your Cloud account.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Gateways/Search
Parameters
Variable Required Description
gateway_id
The 'gateway_id' of a previously setup gateway you wish to search for.
Successful Response

      {
    "Gateways": {
        "gateway": {
            "@attributes": {
                "gateway_id": "3",
                "default_cc_gateway": "N",
                "default_ach_gateway": "N"
            },
            "name": "STRIPE",
            "credentials_1": "fejhfbweufbu34b2"
        }
    }
}
      

<telecloud>
  <Gateways>
    <gateway gateway_id="3" default_cc_gateway="N" default_ach_gateway="N">
      <name>STRIPE</name>
      <credentials_1 name="API KEY">fejhfbweufbu34b2</credentials_1>
    </gateway>
  </Gateways>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('gateway_id' => "");

try { $responce = $tc->request('Gateways/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Gateways/Search service using the API simulator.


Gateways/Create

Setup a new payment gatway by providing the payment gateway credentials.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Gateways/Create
Parameters
Variable Required Description
gateway
The name of the payment gateway you wish to setup
credentials_1
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
credentials_2
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
credentials_3
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
credentials_4
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
Successful Response

      {
    "@attributes": {
        "trans_id": "3130130"
    },
    "gateway": {
        "@attributes": {
            "gateway_id": "732232"
        }
    }
}
      

<telecloud trans_id="3130130">
  <gateway gateway_id="732232" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('gateway' => "",'credentials_1' => "",'credentials_2' => "",'credentials_3' => "",'credentials_4' => "");

try { $responce = $tc->request('Gateways/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Gateways/Create service using the API simulator.


Gateways/Delete

Delete a previously created payment gateway.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/Gateways/Delete
Parameters
Variable Required Description
gateway_id
The 'gateway_id' of the gateway you wish to delete.
Successful Response

      {
    "@attributes": {
        "trans_id": "3130133"
    },
    "gateway": {
        "@attributes": {
            "gateway_id": "1"
        }
    }
}
      

<telecloud trans_id="3130133">
  <gateway gateway_id="1" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('gateway_id' => "");

try { $responce = $tc->request('Gateways/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Gateways/Delete service using the API simulator.


Gateways/Edit

Update the credentials on a payment gateway and set a payment gateway as default on your cloud account so it can be utilized for real time billing.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Gateways/Edit
Parameters
Variable Required Description
gateway_id
The 'gateway_id' of the gateway you wish to delete.
default_cc_gateway
Provide a 'Y' to set the gateway as the default for credit card billing or an 'N' to remove it as default.
default_ach_gateway
Provide a 'Y' to set the gatway as the default for ACH billing or an 'N' to remove it as default.
credentials_1
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
credentials_2
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
credentials_3
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
credentials_4
The credentials for the payment gatway as described in the 'PaymentGateways/Search' method.
Successful Response

      {
    "@attributes": {
        "trans_id": "3130152"
    },
    "gateway": {
        "@attributes": {
            "gateway_id": "8433434",
            "default_cc_gateway": "Y",
            "default_ach_gateway": "Y"
        }
    }
}
      

<telecloud trans_id="3130152">
  <gateway gateway_id="8433434" default_cc_gateway="Y" default_ach_gateway="Y" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('gateway_id' => "",'default_cc_gateway' => "",'default_ach_gateway' => "",'credentials_1' => "",'credentials_2' => "",'credentials_3' => "",'credentials_4' => "");

try { $responce = $tc->request('Gateways/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Gateways/Edit service using the API simulator.

Alerts


Alerts/Search

Retrieve alerts for your username.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Alerts/Search
Parameters
Variable Required Description
type
Can be either ALERT or ANNOUNCEMENT.
Successful Response

      {
    "Alerts": {
        "alert": {
            "@attributes": {
                "alert_id": "41",
                "order_number": "",
                "account_number": "",
                "transaction_id": "",
                "billing_trans_id": ""
            },
            "date": "October 18th, 2019 12:21pm",
            "user_id": "don_hawkins1",
            "subject": "TeleKloud V3 End of LIfe Notice",
            "content": {},
            "status": "1",
            "type": "ANNOUNCEMENT"
        }
    }
}
      

<telecloud>
  <Alerts>
    <alert alert_id="41" order_number="" account_number="" transaction_id="" billing_trans_id="">
      <date>October 18th, 2019 12:21pm</date>
      <user_id>don_hawkins1</user_id>
      <subject>TeleKloud V3 End of LIfe Notice</subject>
      <content>
<![CDATA[<p>After four years, we are officially sunsetting TeleKloud V3 (this system). This basically means we will no longer make updates or repairs to the TeleKloud interface or API. <br />
<br />
TeleCloud.app (previously known as V4) is launching in early October and includes an all-new API, interface, and many new tools based on suggestions we received from you during our six month suggestion period in 2018.<br />
<br />
With the new TeleCloud.app you'll have the ability to get things done faster and provide a better experience for your customers. We look forward to introducing it!<br />
<br />
Thank you for understanding.<br />
<br />
Team MVNOU</p>]]>
      </content>
      <status>1</status>
      <type>ANNOUNCEMENT</type>
    </alert>
  </Alerts>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('type' => "");

try { $responce = $tc->request('Alerts/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Alerts/Search service using the API simulator.


Alerts/Edit

Change the status of an alert.
CORE VAR PARTNER AFFILIATE
PATCH https://telecloud.app/API/{format}/Alerts/Edit
Parameters
Variable Required Description
status
Either 1 for NEW or 2 for DISMISSED.
Successful Response

      
      



<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('status' => "");

try { $responce = $tc->request('Alerts/Edit','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Alerts/Edit service using the API simulator.

Announcements


Announcements/Search

Search for announcements. NOTE: This service searches for announcements you or another AMDIN on your cloud account have posted. To view your individual announcements use the 'Alerts/Search' service.
CORE VAR PARTNER AFFILIATE
GET https://telecloud.app/API/{format}/Announcements/Search
Parameters
Variable Required Description
announcement_id
Provide the announcement_id to search for a specific announcement.
Successful Response

      {
    "Announcements": {
        "announcement": {
            "@attributes": {
                "announcements_id": "89",
                "show_var": "",
                "show_partner": "N",
                "show_affiliate": "N",
                "read": "900",
                "unread": "500"
            },
            "date": "September 19th, 2019 12:00am",
            "subject": "TeleKloud V3 End of LIfe Notice",
            "contents": {}
        }
    }
}
      

<telecloud>
  <Announcements>
    <announcement announcements_id="89" show_var="" show_partner="N" show_affiliate="N" read="900" unread="500">
      <date>September 19th, 2019 12:00am</date>
      <subject>TeleKloud V3 End of LIfe Notice</subject>
      <contents>
<![CDATA[<p>After four years, we are officially sunsetting TeleKloud V3 (this system). This basically means we will no longer make updates or repairs to the TeleKloud interface or API. <br />
<br />
TeleCloud.app (previously known as V4) is launching in early October and includes an all-new API, interface, and many new tools based on suggestions we received from you during our six month suggestion period in 2018.<br />
<br />
With the new TeleCloud.app you'll have the ability to get things done faster and provide a better experience for your customers. We look forward to introducing it!<br />
<br />
Thank you for understanding.<br />
<br />
Team MVNOU</p>]]>
      </contents>
    </announcement>
  </Announcements>
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('announcement_id' => "");

try { $responce = $tc->request('Announcements/Search','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Announcements/Search service using the API simulator.


Announcements/Create

Create a new announcement.
CORE VAR PARTNER AFFILIATE
POST https://telecloud.app/API/{format}/Announcements/Create
Parameters
Variable Required Description
subject
The subject of your announcement.
description
The description or contents of the announcement.
show_var
Provide a Y to show this announcement to VAR accounts.
show_partner
Provide a Y to show this announcement to PARTNER accounts.
show_affiliate
Provide a Y to show this announcement to affiliate accounts.
Successful Response

      {
    "@attributes": {
        "trans_id": "3132190"
    },
    "announcement": {
        "@attributes": {
            "announcement_id": "91"
        }
    }
}
      

<telecloud trans_id="3132190">
  <announcement announcement_id="91" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('subject' => "",'description' => "",'show_var' => "",'show_partner' => "",'show_affiliate' => "");

try { $responce = $tc->request('Announcements/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Announcements/Create service using the API simulator.


Announcements/Delete

Delete a announcement making it no longer available for viewing.
CORE VAR PARTNER AFFILIATE
DELETE https://telecloud.app/API/{format}/Announcements/Delete
Parameters
Variable Required Description
announcement_id
The announcement_id of the announcement you wish to delete.
Successful Response

      {
    "@attributes": {
        "trans_id": "3132354"
    },
    "announcement": {
        "@attributes": {
            "announcement_id": "100"
        }
    }
}
      

<telecloud trans_id="3132354">
  <announcement announcement_id="100" />
</telecloud>

<?php 
//API_ID_KEY,API_KEY,response_format (xml or json),return (clean = return object, leave blank to return raw)
$tc = new telecloud('','','xml','clean'); 
            
$params = array('announcement_id' => "");

try { $responce = $tc->request('Announcements/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($responce);
?>

TeleCloud.app API Simulator

Initiate a live call to the Announcements/Delete service using the API simulator.