{"id":701,"date":"2022-05-06T08:45:21","date_gmt":"2022-05-06T08:45:21","guid":{"rendered":"https:\/\/phonenumbermonitoring.com\/wiki\/?post_type=lsvr_kba&p=701"},"modified":"2022-08-23T10:56:19","modified_gmt":"2022-08-23T10:56:19","slug":"list-plans-api","status":"publish","type":"lsvr_kba","link":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/list-plans-api\/","title":{"rendered":"List Plans API"},"content":{"rendered":"

Request URL<\/h2>\n

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

Returns the list and information about all existed Accessibility and RTM monitoring plans in the PNM account.<\/span><\/h3>\n

Query Parameters<\/h3>\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

true<\/p>\n<\/td>\n

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

Response<\/h3>\n

If the request succeeds, the server responds with the 200 HTTP status code and the list of all available monitoring plans.<\/p>\n

[\r\n    {\r\n        \"planID\": 714,\r\n        \"nextActive\": \"null\",\r\n        \"status\": \"Disabled\",\r\n        \"phoneNumber\": \"15442625186\",\r\n        \"planName\": \"home\"\r\n    },\r\n    {\r\n        \"planID\": 2362,\r\n        \"nextActive\": \"null\",\r\n        \"status\": \"Disabled\",\r\n        \"phoneNumber\": \"16447464017\",\r\n        \"planName\": \"office\"\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\": \"15443625186\",\r\n        \"planName\": \"new\"\r\n    }\r\n]<\/pre>\n
Response Description<\/strong><\/p>\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<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"
Request URL GET https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/plans?apiuid=XXXXXXXXXX Returns the list and information about all existed Accessibility and RTM monitoring plans in the PNM account. Query Parameters Response If the request succeeds, the server responds with the 200 HTTP status code and the list of all available monitoring plans. [ { “planID”: 714, “nextActive”: “null”, “status”: “Disabled”, “phoneNumber”: “15442625186”, […]<\/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-701","lsvr_kba","type-lsvr_kba","status-publish","format-standard","hentry","lsvr_kba_cat-pnm-api-reference"],"yoast_head":"\nList Plans Phone Number Monitorin API | PNM<\/title>\n<meta name=\"description\" content=\"Detailed instructions for list plans 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\/list-plans-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"List Plans Phone Number Monitorin API | PNM\" \/>\n<meta property=\"og:description\" content=\"Detailed instructions for list plans 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\/list-plans-api\/\" \/>\n<meta property=\"article:modified_time\" content=\"2022-08-23T10:56:19+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=\"List Plans Phone Number Monitorin API | PNM\" \/>\n<meta name=\"twitter:description\" content=\"Detailed instructions for list plans 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=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/list-plans-api\\\/\",\"url\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/list-plans-api\\\/\",\"name\":\"List Plans Phone Number Monitorin API | PNM\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/#website\"},\"datePublished\":\"2022-05-06T08:45:21+00:00\",\"dateModified\":\"2022-08-23T10:56:19+00:00\",\"description\":\"Detailed instructions for list plans 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\\\/list-plans-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/list-plans-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/list-plans-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\":\"List Plans 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":"List Plans Phone Number Monitorin API | PNM","description":"Detailed instructions for list plans 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\/list-plans-api\/","og_locale":"en_US","og_type":"article","og_title":"List Plans Phone Number Monitorin API | PNM","og_description":"Detailed instructions for list plans 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\/list-plans-api\/","article_modified_time":"2022-08-23T10:56:19+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":"List Plans Phone Number Monitorin API | PNM","twitter_description":"Detailed instructions for list plans 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":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/list-plans-api\/","url":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/list-plans-api\/","name":"List Plans Phone Number Monitorin API | PNM","isPartOf":{"@id":"https:\/\/phonenumbermonitoring.com\/wiki\/#website"},"datePublished":"2022-05-06T08:45:21+00:00","dateModified":"2022-08-23T10:56:19+00:00","description":"Detailed instructions for list plans 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\/list-plans-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/list-plans-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/list-plans-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":"List Plans 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\/701","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=701"}],"version-history":[{"count":5,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/701\/revisions"}],"predecessor-version":[{"id":716,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/701\/revisions\/716"}],"wp:attachment":[{"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/media?parent=701"}],"wp:term":[{"taxonomy":"lsvr_kba_cat","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_cat?post=701"},{"taxonomy":"lsvr_kba_tag","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_tag?post=701"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}