{"id":462,"date":"2022-04-25T12:59:46","date_gmt":"2022-04-25T12:59:46","guid":{"rendered":"https:\/\/phonenumbermonitoring.com\/wiki\/?post_type=lsvr_kba&p=462"},"modified":"2022-08-23T14:37:32","modified_gmt":"2022-08-23T14:37:32","slug":"pnm-api","status":"publish","type":"lsvr_kba","link":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/pnm-api\/","title":{"rendered":"PNM API"},"content":{"rendered":"

PhoneNumberMonitoring provides the PNM API to allow third-party services to get information about created monitoring plans and placed calls.<\/p>\n

The PNM API is served over HTTPS. All API responses are returned in JSON format.<\/p>\n

Base URL<\/h2>\n

All URIs referenced in the document have the following base:<\/p>\n

https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/<\/pre>\n
Authentication<\/h2>\n
To set up an integration with PhoneNumberMonitoring (PNM) you must have access to an active PNM account and account API Unique Identifier to be authenticated by the service. To be authenticated you are required to pass your API UID in URL with every API request:<\/p>\n
https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/plans?{apiuid}&...<\/span><\/span><\/pre>\n
Path Parameters<\/h3>\n
\n\n\n\n\n
Field<\/strong><\/th>\nType<\/strong><\/th>\nRequired<\/strong><\/th>\nDescription<\/strong><\/th>\n<\/tr>\n
\n
apiuid<\/em><\/span><\/p>\n<\/td>\n
\n
string<\/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
To find the API UID generated for your PNM account, go to Account<\/strong> > Profile<\/strong> > Credentials<\/strong> and copy the UID from the corresponding filed.\u00a0If you need to change your API UID, you can do this at any time under the Credentials<\/strong> tab by clicking the Regenerate<\/strong> button next to the API UID<\/strong> filed.<\/p>\n
Endpoints<\/h2>\n
All read methods are HTTPS GET requests. Calls made over HTTP will fail.<\/p>\n
All query parameters should be sent in URI and separated by an ampersand &<\/span><\/code>. Every call to the PNM API must include PNM UID of your active PNM account.<\/p>\n
List Plans API<\/b><\/a><\/p>\n
The PNM API provides GetJobStatus\/plans<\/span><\/em> endpoint to get information on all monitoring plans that are created within your PNM account.<\/p>\n
https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/plans?apiuid=XXXXXXXXXX<\/pre>\n
List Active Plans API<\/strong><\/a><\/p>\n
The PNM API provides GetJobStatus\/activeplans<\/span><\/em> endpoint to get information only on active monitoring plans within your PNM account.<\/p>\n
https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/activeplans?apiuid=XXXXXXXXXX<\/pre>\n
Get Notifications API<\/b><\/a><\/p>\n
The PNM API provides GetJobStatus\/all<\/span><\/em> endpoint to get information on all notifications for the last 24 hours or as specified in the query.<\/p>\n
https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/all?apiuid=XXXXXXXXXX<\/pre>\n
<\/pre>\n
Get Notifications By Status API<\/strong><\/a><\/p>\n
The PNM API provides GetJobStatus\/bystatus<\/span><\/em> endpoint to get information on all notifications for the calls with a specific status.<\/p>\n
https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/bystatus?apiuid=XXXXXXXXXX&status=XXXXXXXXXXXXX<\/pre>\n
where status can be: incorrectresponse, noanydigit, sysphoneerror, noanswer , busy, fails, success, answer, anydigit, anyword, rtmtimeout<\/p>\n
Get Notifications By Plan API<\/strong><\/a><\/p>\n
The PNM API provides GetJobStatus\/byID<\/span><\/em> endpoint to get information on all notifications for the specified plan.<\/p>\n
https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/byID?apiuid=XXXXXXXXXX&id=XX<\/pre>\n
Get Last Notification For Plan API<\/strong><\/a><\/p>\n
The PNM API provides GetJobStatus\/lastbyID<\/span><\/em> endpoint to get information on the last generated notification for the specified plan.<\/p>\n
https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/lastbyID?apiuid=XXXXXXXXXX&id=XX<\/pre>\n","protected":false},"excerpt":{"rendered":"
PhoneNumberMonitoring provides the PNM API to allow third-party services to get information about created monitoring plans and placed calls. The PNM API is served over HTTPS. All API responses are returned in JSON format. Base URL All URIs referenced in the document have the following base: https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/ Authentication To set up an integration with PhoneNumberMonitoring […]<\/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-462","lsvr_kba","type-lsvr_kba","status-publish","format-standard","hentry","lsvr_kba_cat-pnm-api-reference"],"yoast_head":"\nPhone Number Monitoring API | Phone Number Monitoring<\/title>\n<meta name=\"description\" content=\"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \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\/pnm-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Phone Number Monitoring API | Phone Number Monitoring\" \/>\n<meta property=\"og:description\" content=\"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \u27a1\ufe0f Click here to learn more information\" \/>\n<meta property=\"og:url\" content=\"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/pnm-api\/\" \/>\n<meta property=\"article:modified_time\" content=\"2022-08-23T14:37:32+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=\"Phone Number Monitoring API | Phone Number Monitoring\" \/>\n<meta name=\"twitter:description\" content=\"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \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\\\/pnm-api\\\/\",\"url\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/pnm-api\\\/\",\"name\":\"Phone Number Monitoring API | Phone Number Monitoring\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/#website\"},\"datePublished\":\"2022-04-25T12:59:46+00:00\",\"dateModified\":\"2022-08-23T14:37:32+00:00\",\"description\":\"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \u27a1\ufe0f Click here to learn more information\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/pnm-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/pnm-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/pnm-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\":\"PNM 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":"Phone Number Monitoring API | Phone Number Monitoring","description":"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \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\/pnm-api\/","og_locale":"en_US","og_type":"article","og_title":"Phone Number Monitoring API | Phone Number Monitoring","og_description":"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \u27a1\ufe0f Click here to learn more information","og_url":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/pnm-api\/","article_modified_time":"2022-08-23T14:37:32+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":"Phone Number Monitoring API | Phone Number Monitoring","twitter_description":"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \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\/pnm-api\/","url":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/pnm-api\/","name":"Phone Number Monitoring API | Phone Number Monitoring","isPartOf":{"@id":"https:\/\/phonenumbermonitoring.com\/wiki\/#website"},"datePublished":"2022-04-25T12:59:46+00:00","dateModified":"2022-08-23T14:37:32+00:00","description":"Detailed instructions for PNM API \u2705 Base URL \u2705 Authentication \u2705 Path Parameters \u2705 Endpoints \u27a1\ufe0f Click here to learn more information","breadcrumb":{"@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/pnm-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/pnm-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/pnm-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":"PNM 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\/462","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=462"}],"version-history":[{"count":5,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/462\/revisions"}],"predecessor-version":[{"id":736,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/462\/revisions\/736"}],"wp:attachment":[{"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/media?parent=462"}],"wp:term":[{"taxonomy":"lsvr_kba_cat","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_cat?post=462"},{"taxonomy":"lsvr_kba_tag","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_tag?post=462"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}