Skip to content Skip to main navigation Skip to footer

Get Notifications By Status API

Request URL

GET https://api.phonenumbermonitoring.com/GetJobStatus/bystatus?apiuid=XXXXXXX&status=XXXXXXXX

Returns information about notifications with specific status generated within the last 24 hours. You can specify a custom date range with the query parameters.

Query Parameters

Field Required Description

apiuid

required

API UID for your PNM account.

status

required

The status of the calls which notifications you want to receive.

Possible values:

  • incorrectresponse – incorrect response code
  • noanydigit – no any key pressed
  • sysphoneerror – phone system error
  • noanswer – no answer received
  • busy – line is busy
  • fails – connection failed
  • success – successful call attempt
  • answer – call answered
  • anydigit – any key pressed
  • anyword – any word from specified answered
  • rtmtimeout – RTM timeout reached

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/bystatus?apiuid=XXXXXXX&status=anydigit&start=2020-05-01

Response

If the request succeeds, the server responds with the 200 HTTP status code and notifications with the defined status of calls as defined by the query parameters. The default report period is the last 24 hours.

{
    "plan": [
        {
            "planID": 111,
            "nextActive": "null",
            "status": "Disabled",
            "phoneNumber": "15644625186",
            "planName": "test new",
            "notifications": [
                {
                    "notificationID": 3502833,
                    "phoneNumber": "15644625186",
                    "Created": "6/15/2021 11:33:16 AM",
                    "result": "Success",
                    "calls": {
                        "callID": 3576622,
                        "callTime": "6/15/2021 11:33:16 AM",
                        "duration": 12,
                        "captured": "4",
                        "result": "Success"
                    }
                },
                {
                    "notificationID": 3421149,
                    "phoneNumber": "18844669900",
                    "Created": "5/12/2021 12:08:29 PM",
                    "result": "Success",
                    "calls": {
                        "callID": 3494541,
                        "callTime": "5/12/2021 12:08:29 PM",
                        "duration": 7,
                        "captured": "thank you for calling",
                        "result": "Success"
                    }
                }
            
                ]
        }
    ]
}

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.