{"id":719,"date":"2022-05-06T13:05:53","date_gmt":"2022-05-06T13:05:53","guid":{"rendered":"https:\/\/phonenumbermonitoring.com\/wiki\/?post_type=lsvr_kba&p=719"},"modified":"2022-08-23T15:23:13","modified_gmt":"2022-08-23T15:23:13","slug":"get-notifications-by-status-api","status":"publish","type":"lsvr_kba","link":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-by-status-api\/","title":{"rendered":"Get Notifications By Status API"},"content":{"rendered":"

Request URL<\/h2>\n

GET<\/strong> https:\/\/api.phonenumbermonitoring.com\/GetJobStatus\/bystatus?apiuid<\/span>=XXXXXXX&status=XXXXXXXX<\/em><\/p>\n

Returns information about notifications with specific status generated within the last 24 hours. You can specify a custom date range with the query parameters.<\/p>\n

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

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

\n

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

The status of the calls which notifications you want to receive.<\/p>\n

Possible values:<\/p>\n

    \n
  • incorrectresponse – incorrect response code<\/li>\n
  • noanydigit – no any key pressed<\/li>\n
  • sysphoneerror – phone system error<\/li>\n
  • noanswer – no answer received<\/li>\n
  • busy – line is busy<\/li>\n
  • fails – connection failed<\/li>\n
  • success – successful call attempt<\/li>\n
  • answer – call answered<\/li>\n
  • anydigit – any key pressed<\/li>\n
  • anyword – any word from specified answered<\/li>\n
  • rtmtimeout – RTM timeout reached<\/li>\n<\/ul>\n<\/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\/bystatus?apiuid=XXXXXXX&status=anydigit&start=2020-05-01<\/pre>\n
Response<\/h3>\n
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.<\/p>\n
{\r\n    \"plan\": [\r\n        {\r\n            \"planID\": 111,\r\n            \"nextActive\": \"null\",\r\n            \"status\": \"Disabled\",\r\n            \"phoneNumber\": \"15644625186\",\r\n            \"planName\": \"test new\",\r\n            \"notifications\": [\r\n                {\r\n                    \"notificationID\": 3502833,\r\n                    \"phoneNumber\": \"15644625186\",\r\n                    \"Created\": \"6\/15\/2021 11:33:16 AM\",\r\n                    \"result\": \"Success\",\r\n                    \"calls\": {\r\n                        \"callID\": 3576622,\r\n                        \"callTime\": \"6\/15\/2021 11:33:16 AM\",\r\n                        \"duration\": 12,\r\n                        \"captured\": \"4\",\r\n                        \"result\": \"Success\"\r\n                    }\r\n                },\r\n                {\r\n                    \"notificationID\": 3421149,\r\n                    \"phoneNumber\": \"18844669900\",\r\n                    \"Created\": \"5\/12\/2021 12:08:29 PM\",\r\n                    \"result\": \"Success\",\r\n                    \"calls\": {\r\n                        \"callID\": 3494541,\r\n                        \"callTime\": \"5\/12\/2021 12:08:29 PM\",\r\n                        \"duration\": 7,\r\n                        \"captured\": \"thank you for calling\",\r\n                        \"result\": \"Success\"\r\n                    }\r\n                }\r\n            \r\n                ]\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\/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 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 […]<\/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-719","lsvr_kba","type-lsvr_kba","status-publish","format-standard","hentry","lsvr_kba_cat-pnm-api-reference"],"yoast_head":"\nGet Notifications By Status API | Phone Number Monitoring<\/title>\n<meta name=\"description\" content=\"Detailed instructions for get notifications by status 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-by-status-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Get Notifications By Status API | Phone Number Monitoring\" \/>\n<meta property=\"og:description\" content=\"Detailed instructions for get notifications by status 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-by-status-api\/\" \/>\n<meta property=\"article:modified_time\" content=\"2022-08-23T15:23:13+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 By Status API | Phone Number Monitoring\" \/>\n<meta name=\"twitter:description\" content=\"Detailed instructions for get notifications by status 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-by-status-api\\\/\",\"url\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-by-status-api\\\/\",\"name\":\"Get Notifications By Status API | Phone Number Monitoring\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/#website\"},\"datePublished\":\"2022-05-06T13:05:53+00:00\",\"dateModified\":\"2022-08-23T15:23:13+00:00\",\"description\":\"Detailed instructions for get notifications by status 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-by-status-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-by-status-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/phonenumbermonitoring.com\\\/wiki\\\/knowledge-base\\\/get-notifications-by-status-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 By Status 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 By Status API | Phone Number Monitoring","description":"Detailed instructions for get notifications by status 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-by-status-api\/","og_locale":"en_US","og_type":"article","og_title":"Get Notifications By Status API | Phone Number Monitoring","og_description":"Detailed instructions for get notifications by status 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-by-status-api\/","article_modified_time":"2022-08-23T15:23:13+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 By Status API | Phone Number Monitoring","twitter_description":"Detailed instructions for get notifications by status 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-by-status-api\/","url":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-by-status-api\/","name":"Get Notifications By Status API | Phone Number Monitoring","isPartOf":{"@id":"https:\/\/phonenumbermonitoring.com\/wiki\/#website"},"datePublished":"2022-05-06T13:05:53+00:00","dateModified":"2022-08-23T15:23:13+00:00","description":"Detailed instructions for get notifications by status 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-by-status-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-by-status-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/phonenumbermonitoring.com\/wiki\/knowledge-base\/get-notifications-by-status-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 By Status 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\/719","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=719"}],"version-history":[{"count":5,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/719\/revisions"}],"predecessor-version":[{"id":742,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba\/719\/revisions\/742"}],"wp:attachment":[{"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/media?parent=719"}],"wp:term":[{"taxonomy":"lsvr_kba_cat","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_cat?post=719"},{"taxonomy":"lsvr_kba_tag","embeddable":true,"href":"https:\/\/phonenumbermonitoring.com\/wiki\/wp-json\/wp\/v2\/lsvr_kba_tag?post=719"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}