{"id":711,"date":"2022-05-06T11:39:50","date_gmt":"2022-05-06T11:39:50","guid":{"rendered":"https:\/\/phonenumbermonitoring.com\/wiki\/?post_type=lsvr_kba&p=711"},"modified":"2022-08-23T15:16:53","modified_gmt":"2022-08-23T15:16:53","slug":"get-notifications-info-api","status":"publish","type":"lsvr_kba","link":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/","title":{"rendered":"Get Notifications Info API"},"content":{"rendered":"

Request URL<\/h2>\n

GET<\/strong> https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/all?apiuid<\/span>=XXXXXXXXXX<\/em><\/p>\n

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.<\/span><\/h3>\n

Query Parameters<\/h3>\n
\n\n\n\n\n\n\n
Field<\/strong><\/th>\nRequired<\/strong><\/th>\nDescription<\/strong><\/th>\n<\/tr>\n
\n

apiuid<\/em><\/span><\/p>\n<\/td>\n

\n

required<\/strong><\/p>\n<\/td>\n

API UID for your PNM account.<\/td>\n<\/tr>\n
\n

start<\/em><\/p>\n<\/td>\n

\n

optional<\/p>\n<\/td>\n

The start date of the period for which the notifications need to be retrieved from the system.<\/p>\n

Date format:<\/p>\n

YYYY-MM-DD<\/em><\/td>\n<\/tr>\n

\n

end<\/em><\/p>\n<\/td>\n

\n

optional<\/p>\n<\/td>\n

The end date of the period for which the notifications need to be retrieved from the system.<\/p>\n

Date format:<\/p>\n

YYYY-MM-DD<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/all?apiuid=XXXXXXX&start=2022-01-01&end=2022-05-01<\/pre>\n
Response<\/h3>\n
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.<\/p>\n
{\r\n    \"plan\": [\r\n        {\r\n            \"planID\": 2362,\r\n            \"nextActive\": \"null\",\r\n            \"status\": \"Disabled\",\r\n            \"phoneNumber\": \"16447464017\",\r\n            \"planName\": \"home\",\r\n            \"notifications\": []\r\n        },\r\n        {\r\n            \"planID\": 1282,\r\n            \"nextActive\": \"5\/10\/2022 4:50:00 PM\",\r\n            \"status\": \"Enabled\",\r\n            \"phoneNumber\": \"15644625186\",\r\n            \"planName\": \"new\",\r\n            \"notifications\": [\r\n                {\r\n                    \"notificationID\": 4208704,\r\n                    \"phoneNumber\": \"15644625186\",\r\n                    \"Created\": \"5\/3\/2022 4:50:04 PM\",\r\n                    \"cost\": 0,\r\n                    \"result\": \"NoAnswer\",\r\n                    \"calls\": [\r\n                        {\r\n                            \"callID\": 4289491,\r\n                            \"callTime\": \"5\/3\/2022 4:50:04 PM\",\r\n                            \"duration\": 0,\r\n                            \"captured\": \"\",\r\n                            \"result\": \"NoAnswer\"\r\n                        }\r\n                    ]\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"planID\": 12244,\r\n            \"nextActive\": \"null\",\r\n            \"status\": \"Incomplete\",\r\n            \"phoneNumber\": \"15644515111\",\r\n            \"planName\": \"test_exeption\",\r\n            \"notifications\": []\r\n        }\r\n    ]\r\n}<\/pre>\n
Response Description<\/strong><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n<\/thead>\n
planID<\/em><\/td>\nThe ID of the monitoring plan in the PNM account. Use to request notification information by a plan id.<\/td>\n<\/tr>\n
nextAcitve<\/em><\/td>\nThe date and time of the next call.<\/td>\n<\/tr>\n
status<\/em><\/td>\nThe status of the monitoring plan.<\/p>\n
Possible value:<\/p>\n
    \n
  • Disabled<\/em> – postponed plan<\/li>\n
  • Enabled<\/em> – active plan<\/li>\n
  • Incomplete<\/em> – no schedule set for the plan<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
phoneNumber<\/em><\/td>\nThe monitored phone number.<\/td>\n<\/tr>\n
planName<\/em><\/td>\nThe name of the plan as specified in the PNM service.<\/td>\n<\/tr>\n
notifications<\/i><\/td>\nAn array of notifications generated for the related plan for the specified period.<\/td>\n<\/tr>\n
notificationID<\/em><\/td>\nThe notification ID.<\/td>\n<\/tr>\n
Created<\/em><\/td>\nThe date and time when the notification was created.<\/td>\n<\/tr>\n
cost<\/i><\/td>\nThe cost of the call. “Null<\/em>” is set for the unanswered calls.<\/td>\n<\/tr>\n
result<\/i><\/td>\nThe call status. The possible values: incorrectresponse, noanydigit, sysphoneerror, noanswer , busy, fails, success, answer, anydigit, anyword, rtmtimeout<\/td>\n<\/tr>\n
calls<\/i><\/td>\nAn array of calls.<\/td>\n<\/tr>\n
callID<\/i><\/td>\nThe call ID.<\/td>\n<\/tr>\n
callTime<\/i><\/td>\nThe time when the call happened.<\/td>\n<\/tr>\n
duration<\/i><\/td>\nThe duration time of the call.<\/td>\n<\/tr>\n
captured<\/i><\/td>\nThe response that was captured if the call was answered.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"
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 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 […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"nf_dc_page":"","om_disable_all_campaigns":false,"footnotes":""},"lsvr_kba_cat":[22],"lsvr_kba_tag":[],"class_list":["post-711","lsvr_kba","type-lsvr_kba","status-publish","format-standard","hentry","lsvr_kba_cat-pnm-api-reference"],"yoast_head":"\nGet Notifications Info API | Phone Number Monitoring<\/title>\n<meta name=\"description\" content=\"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Get Notifications Info API | Phone Number Monitoring\" \/>\n<meta property=\"og:description\" content=\"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information\" \/>\n<meta property=\"og:url\" content=\"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/\" \/>\n<meta property=\"article:modified_time\" content=\"2022-08-23T15:16:53+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/phonenumbermonitoring.com\/wiki\/wp-content\/uploads\/2022\/08\/new-logo2slide.png\" \/>\n\t<meta property=\"og:image:width\" content=\"271\" \/>\n\t<meta property=\"og:image:height\" content=\"311\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:title\" content=\"Get Notifications Info API | Phone Number Monitoring\" \/>\n<meta name=\"twitter:description\" content=\"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information\" \/>\n<meta name=\"twitter:image\" content=\"https:\/\/phonenumbermonitoring.com\/wiki\/wp-content\/uploads\/2022\/08\/new-logo2slide.png\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-info-api\\\/\",\"url\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-info-api\\\/\",\"name\":\"Get Notifications Info API | Phone Number Monitoring\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/#website\"},\"datePublished\":\"2022-05-06T11:39:50+00:00\",\"dateModified\":\"2022-08-23T15:16:53+00:00\",\"description\":\"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-info-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-info-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-info-api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Knowledge Base\",\"item\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Notifications Info API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/#website\",\"url\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/\",\"name\":\"\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Get Notifications Info API | Phone Number Monitoring","description":"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/","og_locale":"en_US","og_type":"article","og_title":"Get Notifications Info API | Phone Number Monitoring","og_description":"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information","og_url":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/","article_modified_time":"2022-08-23T15:16:53+00:00","og_image":[{"width":271,"height":311,"url":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-content\/uploads\/2022\/08\/new-logo2slide.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_title":"Get Notifications Info API | Phone Number Monitoring","twitter_description":"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information","twitter_image":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-content\/uploads\/2022\/08\/new-logo2slide.png","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/","url":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/","name":"Get Notifications Info API | Phone Number Monitoring","isPartOf":{"@id":"https:\/\/phonenumbermonitoring.com\/wiki\/#website"},"datePublished":"2022-05-06T11:39:50+00:00","dateModified":"2022-08-23T15:16:53+00:00","description":"Detailed instructions for get notifications info Phone Number Monitoring API \u2705 Request URL \u2705 Query Parameters \u2705 Response \u27a1\ufe0f Click here to learn more information","breadcrumb":{"@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-info-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/phonenumbermonitoring.com\/wiki\/"},{"@type":"ListItem","position":2,"name":"Knowledge Base","item":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/"},{"@type":"ListItem","position":3,"name":"Get Notifications Info API"}]},{"@type":"WebSite","@id":"https:\/\/phonenumbermonitoring.com\/wiki\/#website","url":"https:\/\/phonenumbermonitoring.com\/wiki\/","name":"","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/phonenumbermonitoring.com\/wiki\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/711","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba"}],"about":[{"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/types\/lsvr_kba"}],"author":[{"embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/comments?post=711"}],"version-history":[{"count":5,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/711\/revisions"}],"predecessor-version":[{"id":741,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/711\/revisions\/741"}],"wp:attachment":[{"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/media?parent=711"}],"wp:term":[{"taxonomy":"lsvr_kba_cat","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_cat?post=711"},{"taxonomy":"lsvr_kba_tag","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_tag?post=711"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}