Get Notifications Info API

Request URL

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

Returns the list and information about all notifications generated within last 24 hours on the monitoring plans in the PNM account. You can specify custom start and end dates for the notifications.

Query Parameters

Field	Required	Description
apiuid	required	API UID for your PNM account.
start	optional	The start date of the period for which the notifications need to be retrieved from the system. Date format: YYYY-MM-DD
end	optional	The end date of the period for which the notifications need to be retrieved from the system. Date format: YYYY-MM-DD

Field

Required

Description

apiuid

required

API UID for your PNM account.

start

optional

The start date of the period for which the notifications need to be retrieved from the system.

Date format:

YYYY-MM-DD

end

optional

The end date of the period for which the notifications need to be retrieved from the system.

Date format:

YYYY-MM-DD

https://api.phonenumbermonitoring.com/GetJobStatus/all?apiuid=XXXXXXX&start=2022-01-01&end=2022-05-01

Response

If the request succeeds, the server responds with the 200 HTTP status code and all notifications generated within last 24 hours or as defined by the query parameters.

{
    "plan": [
        {
            "planID": 2362,
            "nextActive": "null",
            "status": "Disabled",
            "phoneNumber": "16447464017",
            "planName": "home",
            "notifications": []
        },
        {
            "planID": 1282,
            "nextActive": "5/10/2022 4:50:00 PM",
            "status": "Enabled",
            "phoneNumber": "15644625186",
            "planName": "new",
            "notifications": [
                {
                    "notificationID": 4208704,
                    "phoneNumber": "15644625186",
                    "Created": "5/3/2022 4:50:04 PM",
                    "cost": 0,
                    "result": "NoAnswer",
                    "calls": [
                        {
                            "callID": 4289491,
                            "callTime": "5/3/2022 4:50:04 PM",
                            "duration": 0,
                            "captured": "",
                            "result": "NoAnswer"
                        }
                    ]
                }
            ]
        },
        {
            "planID": 12244,
            "nextActive": "null",
            "status": "Incomplete",
            "phoneNumber": "15644515111",
            "planName": "test_exeption",
            "notifications": []
        }
    ]
}

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.
notifications	An array of notifications generated for the related plan for the specified period.
notificationID	The notification ID.
Created	The date and time when the notification was created.
cost	The cost of the call. “Null” is set for the unanswered calls.
result	The call status. The possible values: incorrectresponse, noanydigit, sysphoneerror, noanswer , busy, fails, success, answer, anydigit, anyword, rtmtimeout
calls	An array of calls.
callID	The call ID.
callTime	The time when the call happened.
duration	The duration time of the call.
captured	The response that was captured if the call was answered.