Communication/PhoneNumbers - Add Number Lookup API

specification/communication/data-plane/PhoneNumbers/preview/2023-05-01-preview/examples/DeleteOperation.json

@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "api-version": "2022-12-01",
+    "api-version": "2023-05-01-preview",
     "endpoint": "https://resourcename.communication.azure.com/",
     "operationId": "search_my-operation-id"
   },

specification/communication/data-plane/PhoneNumbers/preview/2023-05-01-preview/examples/SearchOperatorInformation.json

@@ -0,0 +1,28 @@
+{
+  "parameters": {
+    "api-version": "2023-05-01-preview",
+    "endpoint": "https://resourcename.communication.azure.com/",
+    "body": {
+      "phoneNumbers": [
+        "+11234567890"
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "values": [
+          {
+            "phoneNumber": "+11234567890",
+            "numberType": "mobile",
+            "operatorDetails": {
+              "name": "T-Mobile",
+              "mobileNetworkCode": "260",
+              "mobileCountryCode": "310"
+            }
+          }
+        ]
+      }
+    }
+  }
+}

specification/communication/data-plane/PhoneNumbers/preview/2023-05-01-preview/phonenumbers.json

@@ -844,6 +844,54 @@
           }
         }
       }
+    },
+    "/operatorInformation/:search": {
+      "post": {
+        "tags": [
+          "Obtain operator information for requested numbers"
+        ],
+        "summary": "Searches for operator information for a given list of phone numbers.",
+        "operationId": "PhoneNumbers_OperatorInformationSearch",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "in": "body",
+            "name": "body",
+            "required": true,
+            "description": "The phone number(s) whose operator information should be searched",
+            "schema": {
+              "$ref": "#/definitions/OperatorInformationRequest"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "schema": {
+              "$ref": "#/definitions/OperatorInformationResult"
+            }
+          },
+          "default": {
+            "description": "Failure",
+            "schema": {
+              "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Search for operator information on phone numbers": {
+            "$ref": "./examples/SearchOperatorInformation.json"
+          }
+        }
+      }
     }
   },
   "definitions": {
@@ -1418,6 +1466,80 @@
           "type": "string"
         }
       }
+    },
+    "OperatorInformationRequest": {
+      "description": "Represents a search request for operator information for the given phone numbers",
+      "type": "object",
+      "properties": {
+        "phoneNumbers": {
+          "description": "Phone number(s) whose operator information is being requested",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "OperatorInformationResult": {
+      "description": "Represents a search result containing operator information associated with the requested phone numbers",
+      "type": "object",
+      "properties": {
+        "values": {
+          "description": "Results of a search.\r\nThis array will have one entry per requested phone number which will contain the relevant operator information.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/OperatorInformation"
+          }
+        }
+      }
+    },
+    "OperatorInformation": {
+      "description": "Represents metadata about a phone number that is controlled/provided by that phone number's operator.",
+      "type": "object",
+      "properties": {
+        "phoneNumber": {
+          "description": "E.164 formatted string representation of the phone number",
+          "type": "string"
+        },
+        "numberType": {
+          "description": "Type of service associated with the phone number",
+          "enum": [
+            "geographic",
+            "mobile",
+            "paging",
+            "freePhone",
+            "specialServices",
+            "testNumber",
+            "voip"
+          ],
+          "type": "string",
+          "x-ms-enum": {
+            "name": "OperatorNumberType",
+            "modelAsString": true
+          }
+        },
+        "operatorDetails": {
+          "$ref": "#/definitions/OperatorDetails"
+        }
+      }
+    },
+    "OperatorDetails": {
+      "description": "Represents metadata describing the operator of a phone number",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "Name of the phone operator",
+          "type": "string"
+        },
+        "mobileNetworkCode": {
+          "description": "Mobile Network Code",
+          "type": "string"
+        },
+        "mobileCountryCode": {
+          "description": "Mobile Country Code",
+          "type": "string"
+        }
+      }
     }
   },
   "parameters": {