Azure.ProgrammableConnectivity (preview:2024-02-09)

2025/03/04 • 5 updated methods

DeviceLocation_Verify (updated)
Description :  Verifies whether a device is within a specified location area, defined as an accuracy (radius) around a point, specified by longitude and latitude.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeviceLocation_Verify",
  "$parameters": {
    "body": {
      "$properties": {
        "networkIdentifier": [
          {
            "#name": "identifierType",
            "Description": {
              "new": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode'",
              "old": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'"
            }
          },
          {
            "#name": "identifier",
            "Description": {
              "new": "The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint.",
              "old": "The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /device-location/location:verify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
apc-gateway-id:
{
Description: The identifier of the APC Gateway resource which should handle this request. ,
Required: True ,
}
string ,
body:
{
Description: Body parameter. ,
Required: True ,
}
{
networkIdentifier:
{
Description: Network to query for this device, or device information to enable network routing. ,
Required: True ,
}
{
identifierType:
{
Description: The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode' ,
Required: True ,
}
string ,
identifier:
{
Description: The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code. A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint. ,
Required: True ,
}
string ,
}
,
latitude:
{
Description: Latitude of location to be verified ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of location to be verified ,
Format: double ,
Required: True ,
}
number ,
accuracy:
{
Description: Accuracy expected for location verification in kilometers ,
Format: int32 ,
Required: True ,
}
integer ,
device:
{
Description: The device to find the location for. Exactly one of Network Access Code, Phone Number, IPv4 address, or IPv6 address ,
Required: True ,
}
{
networkAccessIdentifier:
{
Description: External identifier or network access identifier of the device ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number in E.164 format (starting with country code), and optionally prefixed with '+' ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The Ipv4 address ,
Required: False ,
}
{
ipv4:
{
Description: An IPv4 address. This may be specified as an exact address, or as a subnet in CIDR notation. ,
Required: True ,
}
string ,
port:
{
Description: User equipment port. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ipv6Address:
{
Description: The Ipv6 address ,
Required: False ,
}
{
ipv6:
{
Description: An IPv6 address. This may be specified as an exact address, or as a subnet in CIDR notation. ,
Required: True ,
}
string ,
port:
{
Description: User equipment port. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Response verifying location ,
}
{
verificationResult:
{
Description: True if the location is in the specified area, False otherwise ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeviceNetwork_Retrieve (updated)
Description :  Retrieves the network a given device is on. Returns network in a networkCode format that can be used for other APIs.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeviceNetwork_Retrieve",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "identifierType",
          "Description": {
            "new": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode'",
            "old": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'"
          }
        },
        {
          "#name": "identifier",
          "Description": {
            "new": "The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint.",
            "old": "The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /device-network/network:retrieve
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
apc-gateway-id:
{
Description: The identifier of the APC Gateway resource which should handle this request. ,
Required: True ,
}
string ,
body:
{
Description: Body parameter. ,
Required: True ,
}
{
identifierType:
{
Description: The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode' ,
Required: True ,
}
string ,
identifier:
{
Description: The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code. A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: The network that the device is on. ,
}
{
networkCode:
{
Description: The identifier for the network. This can be used as the networkIdentifier for the service APIs. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
NumberVerification_VerifyWithoutCode (updated)
Description :  Verifies the phone number (MSISDN) associated with a device. As part of the frontend authorization flow, the device is redirected to the operator network to authenticate directly.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NumberVerification_VerifyWithoutCode",
  "$parameters": {
    "body": {
      "$properties": {
        "networkIdentifier": [
          {
            "#name": "identifierType",
            "Description": {
              "new": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode'",
              "old": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'"
            }
          },
          {
            "#name": "identifier",
            "Description": {
              "new": "The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint.",
              "old": "The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /number-verification/number:verify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
apc-gateway-id:
{
Description: The identifier of the APC Gateway resource which should handle this request. ,
Required: True ,
}
string ,
body:
{
Description: Body parameter. ,
Required: True ,
}
{
networkIdentifier:
{
Description: Identifier for the network to query for this device. ,
Required: True ,
}
{
identifierType:
{
Description: The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode' ,
Required: True ,
}
string ,
identifier:
{
Description: The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code. A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: Phone number in E.164 format (starting with country code), and optionally prefixed with '+' ,
Required: False ,
}
string ,
hashedPhoneNumber:
{
Description: Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in **E.164 format (starting with country code)**. Optionally prefixed with '+'. ,
Required: False ,
}
string ,
redirectUri:
{
Description: Redirect URI to backend application. ,
Format: uri ,
Required: True ,
}
string ,
}
,
}

⚐ Response (302)

{
location:
{
Description: The URI of the network's authorization endpoint, which should be followed by the front-end application. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
SimSwap_Retrieve (updated)
Description :  Provides timestamp of latest SIM swap
Reference :  Link ¶

⚶ Changes

{
  "#id": "SimSwap_Retrieve",
  "$parameters": {
    "body": {
      "$properties": {
        "networkIdentifier": [
          {
            "#name": "identifierType",
            "Description": {
              "new": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode'",
              "old": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'"
            }
          },
          {
            "#name": "identifier",
            "Description": {
              "new": "The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint.",
              "old": "The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /sim-swap/sim-swap:retrieve
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
apc-gateway-id:
{
Description: The identifier of the APC Gateway resource which should handle this request. ,
Required: True ,
}
string ,
body:
{
Description: Body parameter. ,
Required: True ,
}
{
phoneNumber:
{
Description: Phone number in E.164 format (starting with country code), and optionally prefixed with '+' ,
Required: False ,
}
string ,
networkIdentifier:
{
Description: Network to query for this device ,
Required: True ,
}
{
identifierType:
{
Description: The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode' ,
Required: True ,
}
string ,
identifier:
{
Description: The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code. A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Response with SimSwap date ,
}
{
date:
{
Description: Datetime of most recent swap for SIM ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
SimSwap_Verify (updated)
Description :  Verifies if a SIM swap has been performed during a past period (defined in the request with 'maxAgeHours' attribute). Returns 'True' if a SIM swap has occured.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SimSwap_Verify",
  "$parameters": {
    "body": {
      "$properties": {
        "networkIdentifier": [
          {
            "#name": "identifierType",
            "Description": {
              "new": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode'",
              "old": "The type of identifier for the network. one of: 'IPv4', 'IPv6', 'NetworkCode'"
            }
          },
          {
            "#name": "identifier",
            "Description": {
              "new": "The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint.",
              "old": "The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.\nA Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /sim-swap/sim-swap:verify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
apc-gateway-id:
{
Description: The identifier of the APC Gateway resource which should handle this request. ,
Required: True ,
}
string ,
body:
{
Description: Body parameter. ,
Required: True ,
}
{
phoneNumber:
{
Description: Phone number in E.164 format (starting with country code), and optionally prefixed with '+' ,
Required: False ,
}
string ,
maxAgeHours:
{
Description: Maximum lookback for SimSwap verification ,
Format: int32 ,
Required: False ,
}
integer ,
networkIdentifier:
{
Description: Identifier for the network to query for this device. ,
Required: True ,
}
{
identifierType:
{
Description: The type of identifier for the network. one of: 'IPv4', 'IPv6', 'MSISDN', 'NetworkCode' ,
Required: True ,
}
string ,
identifier:
{
Description: The network identifier, based on the identifierType: an IPv4 address, an IPv6 address, an MSISDN, or a Network Code. A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
x-ms-request-id:
{
Description: An opaque, globally-unique, server-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Response verifying SimSwap in period ,
}
{
verificationResult:
{
Description: True if the SIM has swapped in the specified period, False otherwise ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}