Skip to content

working-group-two/number-lookup-provider-tester

Repository files navigation

Number Lookup Provider Tester

This application is designed to make it easier to develop a Number Lookup Provider, and will generate requests for different phone numbers, and show the responses from the provider.

That is, it allows testing your integration with the Number Lookup API without having to make actual calls to the API.

About the Number Lookup API

This is a test application for the WG2 Number Lookup API.

This API uses a bidirectional gRPC stream, where the server will send requests to the client for looking up information about a phone number. The client will then respond with the information it has about the phone number.

This information will be used in the call flow to show the user information about the caller, and to determine if the call should be blocked or not.

For more information about the API, see the following links:

About the test application

The test application does not inspect any authentication headers.

For testing authentication, you may either connect to our sandbox environment or the real production API.

It does not limit number of in-flight requests.

Usage

Usage of ./number-lookup-provider-tester:
  -address string
    	address to listen on (default ":8118")
  -numbers string
    	comma separated list of phone numbers
  -print-progress
    	print progress
  -print-requests
    	print requests
  -print-responses
    	print responses
  -rps int
    	request per second (default 16)

Example

docker run -e 8118:8118 ghcr.io/working-group-two/number-lookup-provider-tester:latest \
  --rps 5 \
  --numbers 4799990001,4799990002,4799990003 \
  --print-progress \
  --print-requests \
  --print-responses

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages