Proxy Number Mapping
Content
Overview
The anonymous call API provides the user the ability to map two mobile numbers together to a proxy number, whereby either of the numbers mapped can initiate calls to each other by dialing the proxy number. This will provide the end user to make a call in a secure way by protecting their identity
Method
The following REST methods are available:
- Subscribing New Users.
- Removing the added Users.
Requirements
Authorization API calls All API call request to ideabiz.lk required Authorization headers. Please refer the Token Management (http://docs.ideabiz.lk/Getting_Started/Token_Manegment) document for Authorization.
Request Header
Content-Type: application/json
Authorization: Bearer [access token]
Accept: application/json
Sample Request Header
Content-Type: application/json
Authorization: Bearer a92ba8hjgjhgjh3fa1609cabcd79
Accept: application/json
Subscribing New Users
This allows you to add two new users for a service provided by your application. All charges are Taxable, and Standard Taxes will be charged from the subscriber on top of the charging amount.
Request
Given below is a sample request of the API call.
URL
https://ideabiz.lk/apicall/pnm/{version}
Sample URL
https://ideabiz.lk/apicall/pnm/v1.0
Method
POST
Body
{
"a_party": "94xxxxxxxxx",
"a_party_ref_id": "12345",
"a_party_type": "D",
"b_party": "94xxxxxxxxx",
"b_party_ref_id": "98765",
"b_party_type": "C",
"short_code": "43098",
"time_out_period": "600",
"reference_id": "1234_bb"
}
Response
Status code : 200
{
"response": "Both users entered Successfully"
}
Removing the added Users
This allows you to remove the existing user pair.
Request
Given below is a sample request of the API call.
URL
https://ideabiz.lk/apicall/pnm/{version}/drop-user
Sample URL
https://ideabiz.lk/apicall/pnm/v1.0/drop-user
Method
POST
Body
{
"reference_id": "1234_bb"
}
Response
Status code : 200
{
"response": "users successfully removed"
}
Given below are the Request parameters of the service.
Parameter Name |
Description |
Type |
Mandatory/Optional |
a_party/b_party |
In this case the a_party/b_party are the userss MSISDNs including the country code. Eg:94766691500. |
string |
Mandatory |
a_party_ref_id |
An unique reference for the User that identifies the User. |
string |
Mandatory |
b_party_ref_id |
An unique reference for the User that identifies the User. |
string |
Mandatory |
a/b_party_type |
D for Driver / C for Customer |
string |
Mandatory |
Short Code |
Short code allocated for the app |
string |
Mandatory |
time_out_period |
Time duration in seconds [ 60 - for time out in 1 minute ] |
string |
Mandatory |
reference_id |
An unique reference id for scheduled job |
string |
Mandatory |
Response Codes
200 – Success!
400 – Bad request; check the error message for details
401 – Authentication failure, check your authentication details
403 – Forbidden; please provide authentication credentials
404 – Not found: mistake in the host or path of the service URI
405 – Method not supported: for example you mistakenly used a HTTP GET instead of a POST
500 – The server encountered an unexpected condition. This could be wrong authentication details or limited user permission.
503 – Server busy and service unavailable. Please retry the request.
Faults
HTTP Respose code 503
Fault Response Body
{
"fault": {
"code": "900800",
"message": "Message Throttled Out",
"description": "You have exceeded your quota"
}
}