Sandbox
Available in
- UK
Number Recycling (CAMARA)
0.2.0Image
It can be used for
- Check if the subscriber of the phone number has changed
- Ensure phone number is correctly linked to the user
- Prevent the mis-delivery of SMS messages
API Information
How it works
Scenario 1
- User A owns the phone number +123456789 with MNO A (since 09 Oct 2023 and still active).
- User A also signed a service contract with ASP A on 22 Dec 2023.
- ASP A stores the contract date (2023‑12‑22) and the phone number.
- On 02 Nov 2024, ASP A plans to send an SMS to User A.
- ASP A sends a request to Vodafone’s Number Recycling API with:
- Phone number: +123456789
- Date: 2023‑12‑22
- The API returns false, indicating no user change for the number.
- ASP A sends the SMS to User A.
- Result: ASP A confirms the number is still linked to User A and delivers the message correctly.
- Note: When API receives a request with specified date on which a user signed a contract with MNO, the API respond sets to 'false'(e.g., 2023-10-09 in the Scenario 1 of the figure above).
Scenario 2
- User A previously owned +123456789 with MNO A (09 Oct 2023 → 25 Feb 2024).
- The number was reassigned to User B on 21 Sep 2024, who still uses it.
- User A signed a service contract with ASP A on 22 Dec 2023, and ASP A stored the date and number.
- On 02 Nov 2024, ASP A intends to send an SMS to User A.
- ASP A sends a request to Vodafone’s Number Recycling API with:
- Phone number: +123456789
- Date: 2023‑12‑22
- The API returns true, confirming the number is now linked to a different user.
- ASP A does not send the SMS and instead contacts User A via post/mail.
- Result: Mis‑delivery is avoided, and customer data is protected.
- Note: When the API receives a request with specified date during which there is no contract with MNO for the phone number, the API respond sets to 'true'(e.g., the period between 2024-02-25 and 2024-09-20 in the Scenario 2 of the figure above).
Run in Postman
To begin using the Vodafone workspace in Postman, please follow the steps below to create a set of credentials that can be used with our sandbox collections:
- Register an account on https://developer.vodafone.com and create a sandbox app for the APIs that you are interested in.
- Use the Client Key and Secret from your sandbox app to populate the relating variables in the "Sandbox Credentials" environment group in Postman.
- These API use a three-legged OAuth flow. A three-legged OAuth process involves three parties: the end-user (or resource owner), the client (the third-party application), and the server (or authorization server).
- First call the authorize endpoint to get an authorization code. Your client credentials will be taken from the environment variables.
- You need to call the authorize end-point for each Identity API in the CAMARA portfolio as the product scope is set in the request body of the authorize call.
- Call the token endpoint to exchange the authorization code for a bearer token that is used in the API resource endpoint.
- The last bearer token and trace ID will be stored in collection variables associated with the API solution that you have chosen.
- You can use these collections as read-only or create a fork into your own personal workspace to edit the details.
You can access all of Vodafone's sandbox APIs in our Postman workspace by clicking the button below:
What is Postman?
Postman is a popular development and testing tool that is widely used across the API developer community. It offers an easy to use interface for making HTTP requests, testing API responses and collaborating with team members. For more details, see postman.com
