messagebird · Schema

Hlr

Properties

Name Type Description
id string The unique identifier of the HLR.
href string The URL of the HLR resource.
msisdn integer The phone number queried.
network integer The MCC-MNC code of the mobile network operator.
reference string The client reference.
status string The status of the HLR query.
createdDatetime string The date and time when the HLR was created.
statusDatetime string The date and time of the last status update.
View JSON Schema on GitHub

JSON Schema

messagebird-hlr-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Hlr",
  "title": "Hlr",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the HLR."
    },
    "href": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the HLR resource."
    },
    "msisdn": {
      "type": "integer",
      "format": "int64",
      "description": "The phone number queried."
    },
    "network": {
      "type": "integer",
      "description": "The MCC-MNC code of the mobile network operator."
    },
    "reference": {
      "type": "string",
      "description": "The client reference."
    },
    "status": {
      "type": "string",
      "description": "The status of the HLR query.",
      "enum": [
        "sent",
        "absent",
        "active",
        "unknown",
        "failed"
      ]
    },
    "createdDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the HLR was created."
    },
    "statusDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time of the last status update."
    }
  }
}