Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

VCO / SIM Swap

Operation Information

Hornbill Integration method to swap an existing mobile phone number to a new SIM Card.

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 swap Yes None provided
SIM Card ID sim_id string The number of the SIM Card to swap the connection to Yes None provided

Output Parameters

Display Name ID Type Description
Status status string API Response status
PO Number comments string Any returned comments
SIM Card sim_card string The SIM Card ID
Swap Status sim_status string The Status of the Swap Request
Phone Number phone_number string The Phone Number for the SIM card
In This Document