MoroccoAPIDocumentation
API reference

Choose a resource. Set the parameters. Try it.

No API keyJSON responsesOpen CORS

Prefixes & carriers

GET/api/v2/telecom/numbering-ranges

Good to know. Offline format validation and Google prefixes. No subscriber identity, active-line check, current carrier or physical location.

Parameters

05
stringOptional · Query

National prefix, including the leading zero.

2-6 characters
Pattern^0[5-8][0-9]{0,4}$
stringOptional · Query

Resource category.

stringOptional · Query

Carrier identifier, such as maroc-telecom.

2-80 characters
Pattern^[a-z]+(?:-[a-z]+)*$
integerOptional · Query

Results per page. Default 100, maximum 500.

Minimum: 1Maximum: 500Default: 100
integerOptional · Query

Matching results to skip. Starts at 0.

Minimum: 0Maximum: 2147483647Default: 0
Read the response

data: The requested results, as an object or an array.

meta: Dataset sources, license and dates. null means unknown or unavailable.

meta.pagination: Lists: 100 results by default, 500 maximum. Use limit and offset; meta.pagination.next_offset is null on the last page.

Illustrative example: With limit=10 and offset=0, the first page holds at most 10 results. If next_offset is 10, request the next page with offset=10 and the same filters. Stop when next_offset is null.

API v2 is the canonical path. Older /api/v1 paths remain compatibility aliases for the currently published behavior, including pagination; no removal date is scheduled.

Response fields 10

[] means each item in a list. null means unknown or unavailable, never zero. The guide language does not translate source values.

dataobject[]

Requested result: a single object or a list.

data[].prefixstring

Leading digits of a national-format number, including the zero.

data[].international_prefixstring

International form of the prefix, with +212 replacing the leading zero.

data[].maskstring

Pattern: each X is one remaining digit, for example 06XXXXXXXX.

data[].categorystring

Facility or prefix category; use the published values.

Accepted values: "carrier" "geographic"

data[].original_operatorobject | null

Operator associated with the prefix in the source; may differ from the current operator.

data[].original_operator.codestring

Operator identifier inside an operator object; national prefix inside a phone area.

data[].original_operator.namestring

Resource name, grouped by language where applicable.

data[].area_codestring | null

Associated geographic area prefix, or null.

data[].more_specific_prefixesstring[]

Longer sub-prefixes providing a more specific match.

Data structure
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "prefix",
          "international_prefix",
          "mask",
          "category",
          "original_operator",
          "area_code",
          "more_specific_prefixes"
        ],
        "properties": {
          "prefix": {
            "type": "string",
            "minLength": 2,
            "maxLength": 6,
            "pattern": "^0[5-8][0-9]{0,4}$"
          },
          "international_prefix": {
            "type": "string"
          },
          "mask": {
            "type": "string",
            "pattern": "^0[0-9]+X+$"
          },
          "category": {
            "enum": [
              "carrier",
              "geographic"
            ]
          },
          "original_operator": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "name"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                }
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "area_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "more_specific_prefixes": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 2,
              "maxLength": 6,
              "pattern": "^0[5-8][0-9]{0,4}$"
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "numbering-ranges"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "Apache-2.0"
          ]
        },
        "retrieved_at": {
          "type": "string",
          "format": "date"
        },
        "transformation_version": {
          "type": "string"
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "Apache-2.0"
                ]
              },
              "source_updated_at": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              }
            }
          }
        },
        "pagination": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "limit",
            "offset",
            "count",
            "has_more",
            "next_offset"
          ],
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 1,
              "maximum": 500
            },
            "offset": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 500
            },
            "has_more": {
              "type": "boolean"
            },
            "next_offset": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}
Sources and pagination 19
metaobject

Result context: sources, dates, license and pagination where applicable.

meta.datasetstring

Name of the dataset for this result or source.

Accepted values: "numbering-ranges"

meta.totalinteger

Number of matching records before pagination; not the size of this page.

meta.licensestring

Reuse license. mixed means licenses differ: inspect each source.

Accepted values: "Apache-2.0"

meta.retrieved_atstring

Date the project retrieved the source file; not the observation date.

meta.transformation_versionstring

Version of the dataset conversion rules; separate from the API version.

meta.sourcesobject[]

Sources used for this result, with their publishers and licenses.

meta.sources[].datasetstring

Name of the dataset for this result or source.

meta.sources[].producerstring

Organization publishing the original data.

meta.sources[].source_urlstring

Source publication or dataset landing page.

meta.sources[].resource_urlstring

Link to the actual file or resource used.

meta.sources[].licensestring

Reuse license. mixed means licenses differ: inspect each source.

Accepted values: "Apache-2.0"

meta.sources[].source_updated_atstring | null

Last update reported by the source; not the retrieval date.

meta.paginationobject

Information for reading a collection one page at a time.

meta.pagination.limitinteger

Requested maximum records per page: default 100, maximum 500.

meta.pagination.offsetinteger

Matching records skipped before this page, after filtering. The first page starts at 0.

meta.pagination.countinteger

Number of records actually returned on this page.

meta.pagination.has_moreboolean

true when another page of records remains.

meta.pagination.next_offsetinteger | null

Use as offset for the next page; null at the end. Keep the same filters.

Errors
  • 400: Invalid or missing parameter.

Errors return error.code, error.message and error.request_id.

errorobject

Details of a failed request; replaces data and meta.

error.codestring

Stable error code, such as RESOURCE_NOT_FOUND; use it in application logic.

error.messagestring

Human-readable error explanation; use code for application logic.

error.request_idstring

Identifier for this request, useful when reporting a problem.

Your request

GET · JSON

Base URL

Response

The live response will appear here.

Language changes the guide, not JSON keys or source values.