Skip to content Skip to main navigation Skip to footer

List Active Plans API

Request URL

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

Returns the list and information about all active monitoring plans in the PNM account.

Query Parameters

Field Required Description

apiuid

true

API UID for your PNM account.

Response

If the request succeeds, the server responds with the 200 HTTP status code and the list of all monitoring plans that are currently activated in the account.

[
{
"planID": 1282,
"nextActive": "5/10/2022 4:50:00 PM",
"status": "Enabled",
"phoneNumber": "15442625186",
"planName": "new"
}
]

Response Description

Field Description
planID The ID of the monitoring plan in the PNM account. Use to request notification information by a plan id.
nextAcitve The date and time of the next call.
status The status of the monitoring plan.

Possible value:

  • Disabled – postponed plan
  • Enabled – active plan
  • Incomplete – no schedule set for the plan
phoneNumber The monitored phone number.
planName The name of the plan as specified in the PNM service.