Customer API

Status

Active, Maintained and In Production

Purpose

Customer facing API

For a given ANI, retrieved the number & description of the Vumber number the ANI last called.

Technology

Application is a C# .NET6.0 API.

Built with Microsoft Visual Studio Professional 2022 / 17.3.2

Source code

Application source code is stored Azure DevOps/Git 

    Project: Customer API

    Repo: Vumber / Customer API / Repoos / Files / MainAPI

Deployment Method

Azure DevOps Pipeline 

Triggered on commit

Build to WebAppName: 'vumcustapi' / slot: 'dev'

Description

This was requested by a customer who has a sales force screen pop. The customer has several numbers and wants to identify to the agent which number was called. The customer passes the ANI to the api, and the API responds with the name of the Vumber number (as alloocated by the user) 

Hosted

Hosted as Azure App Service

WebAppName: 'vumcustapi'

Logging

Logging will be on the logging server, currently VumTest2:

L:\Logs\LogReceiverService\CustomerAPI\_unauthenticated

User Documentation

Our API URL: api.vumber.com

Your apiKey: AE9BC112-6194-46BB-8F3D-XXXXXXXXXXX
Your accountNo: 118589

This is the method to use:

GET api/v1/a/{accountNo}/lastcalldetail/{callersphonenumber}

Response:

{
"publicNumber": "the vumber number the caller dialed,
"publicNumberDescription": "The description you assigned to that vumber number",
"callTime": "2022-02-15T17:16:16.693",
"callersNumber": "the caller's number (this will be the same as the number sent)"
}

So putting it altogether:

GET https://api.vumber.com/api/v1/a/118589/lastcalldetail/14702611524?apiKey=AE9BC112-6194-46BB-8F3D-XXXXXXXXXXX

Response: 200 OK

{
"publicNumber": "6789921565",
"publicNumberDescription": "Google Local In SF ",
"callTime": "2022-02-15T17:16:16.693",
"callersNumber": "+14702611524"
}

Response 404 NOT FOUND

No call record for the passed telephone number was found

Response 400 BAD REQUEST

The telephone number format was incorrect. Numbers should be 10 digits (6095556262) or 11 digits (16095556262) - no non-numeric characters allowed

Response 500 INTERNAL SERVER ERROR

We will log any errors here for review.