How can we help?
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
Hornbill Integration method to disconnect a mobile phone number from the network. This process can take VCO up to 30 days to complete.
This is a Premium Integration.
Authentication
This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Username + Password.
To create a key of this type:
- In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
- Click on the + Create New Key button;
- On the resulting Create New Key form, choose Username + Password in the Type pick list;
- Give the Username + Password KeySafe key a Title (this is the name / identifier for the Username + Password account as you will see it when using the cloud automation node in your workflows);
- Optionally populate the Description field;
- Populate the following fields accordingly, then click the Create Key button to create your new key:
Name | Type | Description |
---|---|---|
Username | string |
Authentication Username |
Password | string |
Authentication Password |
API Endpoint | string |
Optional API Endpoint |
Tip
In order to integrate with Vodafone VCO, you will need to add your unique VCO Username and Secret (into the Password field), which are provided by Vodafone Corporate when registering with the VCO API interface. The API Endpoint field is not required to be populated for this integration.
Revoking Access
If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.
Warning
This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Username + Password account, so you will need to manage these workflows accordingly.
Input Parameters
Display Name | ID | Type | Description | Required | Supported Values |
---|---|---|---|---|---|
Production or Test | _production |
string |
Perform the API call in the Production or Test VCO Environment | Yes | Production, Test |
Phone Number | phone_number |
string |
Mobile phone number for the SIM you want to disconnect | Yes | None provided |
Notification Email | notification_email |
string |
An optional email address to receive a notification when the request has been processed | No | None provided |
Comments | comments |
string |
User provided comments | No | None provided |
Output Parameters
Display Name | ID | Type | Description |
---|---|---|---|
Status | status |
string |
API Response status |
Processed? | processed |
string |
Y if the request was accepted, N if an error occurred |
Error | error |
string |
Reason for a request being rejected |
Phone Number | phone_number |
string |
The Phone Number requested for disconnection |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}