How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

messagebird HLR API

Operations for creating and viewing HLR network queries.

messagebird HLR API is one of 19 APIs that Messagebird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include HLR. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 4 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://rest.messagebird.com.

4 operations 3 paths 3 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://rest.messagebird.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

messagebird HLR API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (accessKey). By default, every request must be authenticated.

  • accessKey — Access key authentication in the form of 'AccessKey {accessKey}'.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

HLR 4

Operations for creating and viewing HLR network queries.

POST
/hlr
Create an HLR
createHlr body → 201400401422
GET
/hlr/{id}
View an HLR
viewHlr 1 param → 200401404
POST
/lookup/{phoneNumber}/hlr
Request an HLR lookup
createHlrLookup 1 param body → 201400401
GET
/lookup/{phoneNumber}/hlr
View an HLR lookup
viewHlrLookup 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Hlr (8 properties), HlrLookup (6 properties), HlrCreate (2 properties). Each schema is shown below with its type and property counts.

Hlr
object
8 properties
HlrCreate
object
2 properties 1 required
HlrLookup
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

messagebird-hlr-api-openapi.yml Raw ↑

Other APIs Messagebird publishes across the network.

messagebird Available Numbers API
messagebird Balance API
messagebird Call Flows API
messagebird Calls API
messagebird Contacts API
messagebird Conversations API
messagebird Groups API
messagebird Legs API
messagebird Lookup API
messagebird Messages API
messagebird Purchased Numbers API
messagebird Recordings API
Where this information came from

This is an independent, third-party profile of messagebird HLR API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.