Skip to content
Phone Number Monitoring

Phone Number Monitoring API

Last updated

Phone Number Monitoring provides the Phone Number Monitoring API to allow third-party services to get information about created monitoring plans and placed calls.

The Phone Number Monitoring API is served over HTTPS. All API responses are returned in JSON format.

Base URL

All URIs referenced in the document have the following base:

https://api.phonenumbermonitoring.com/GetJobStatus/

Authentication

To set up an integration with Phone Number Monitoring (PNM) you must have access to an active Phone Number Monitoring account and account API Unique Identifier to be authenticated by the service. To be authenticated you are required to pass your API UID in URL with every API request:

https://api.phonenumbermonitoring.com/GetJobStatus/plans?{apiuid}&...

Path Parameters

Field Type Required Description
apiuid string true API UID for your Phone Number Monitoring account.

To find the API UID generated for your Phone Number Monitoring account, go to Account > Profile > Credentials and copy the UID from the corresponding filed. If you need to change your API UID, you can do this at any time under the Credentials tab by clicking the Regenerate button next to the API UID filed.

Endpoints

All read methods are HTTPS GET requests. Calls made over HTTP will fail.

All query parameters should be sent in URI and separated by an ampersand &. Every call to the Phone Number Monitoring API must include Phone Number Monitoring UID of your active Phone Number Monitoring account.

List Plans API

The Phone Number Monitoring API provides GetJobStatus/plans endpoint to get information on all monitoring plans that are created within your Phone Number Monitoring account.

https://api.phonenumbermonitoring.com/GetJobStatus/plans?apiuid=XXXXXXXXXX

List Active Plans API

The Phone Number Monitoring API provides GetJobStatus/activeplans endpoint to get information only on active monitoring plans within your Phone Number Monitoring account.

https://api.phonenumbermonitoring.com/GetJobStatus/activeplans?apiuid=XXXXXXXXXX

Get Notifications API

The Phone Number Monitoring API provides GetJobStatus/all endpoint to get information on all notifications for the last 24 hours or as specified in the query.

https://api.phonenumbermonitoring.com/GetJobStatus/all?apiuid=XXXXXXXXXX

Get Notifications By Status API

The Phone Number Monitoring API provides GetJobStatus/bystatus endpoint to get information on all notifications for the calls with a specific status.

https://api.phonenumbermonitoring.com/GetJobStatus/bystatus?apiuid=XXXXXXXXXX&status=XXXXXXXXXXXXX

where status can be: incorrectresponse, noanydigit, sysphoneerror, noanswer, busy, fails, success, answer, anydigit, anyword, rtmtimeout

Get Notifications By Plan API

The Phone Number Monitoring API provides GetJobStatus/byID endpoint to get information on all notifications for the specified plan.

https://api.phonenumbermonitoring.com/GetJobStatus/byID?apiuid=XXXXXXXXXX&id=XX

Get Last Notification For Plan API

The Phone Number Monitoring API provides GetJobStatus/lastbyID endpoint to get information on the last generated notification for the specified plan.

https://api.phonenumbermonitoring.com/GetJobStatus/lastbyID?apiuid=XXXXXXXXXX&id=XX