Get a reference dataset

Returns a single reference dataset by name, so you can map the codes that appear in call data to human-readable labels in your own reporting and UI.

When to use. Look up the fixed lookup values used across call data, for example to turn a Q.850 cause code or a SIP response code into a readable label, or to list the possible call statuses. These values change rarely, so you can fetch them once and cache them.

Parameters. dataset-name (path, required) selects which dataset to return. Allowed values:

  • object-types: call object type ID to its meaning.
  • status: the possible call status values.
  • q850: Q.850 disconnect cause code to its meaning.
  • client-hangup-dispositions: the possible values identifying who ended the call.
  • sip-term-statuses: SIP termination response code to its reason phrase.

Returns. A single-key object whose key is the requested dataset-name and whose value is that dataset, either a map of code to label or a flat list of string values. An unknown dataset name returns 404.

Example. GET /api/reference-data/q850

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

The name of the dataset to retrieve.

Allowed:
Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json