Get a call menu

Returns prompts, ordered choices, and directly configured fallback routing for one call menu.

GET/customer/phone-systems/{phoneSystemId}/call-menus/{callMenuId}

Authorization

X-API-KeyAPI key · headerrequired

API key (sk_phones_* prefix) for programmatic access

Path parameters

phoneSystemIdstring<uuid>required

Phone system identifier, discoverable via the accessible phone systems operation.

callMenuIdstring<uuid>required

Call-menu identifier from a list response or typed reference.

Responses

200Call-menu choices and directly configured fallback routing.

allowDirectExtensionDialbooleanrequired

choicesobject[]required

Show properties

Array of object

actionsobject[]required

min items 1

Show properties

Array of object

Any of:

object

idstring<uuid>required

phoneSystemIdstring<uuid>required

typestringrequired

Allowed:extensionagent-configcall-groupcall-menu

object

idstring<uuid>required

phoneSystemIdstring<uuid>required

typestringrequired

Allowed:extension-voicemailcall-group-voicemail

object

Any of:

object

playbackUrlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

typestringrequired

object

phoneNumberstring<phone-number>required

E.164 phone number, including the leading + and international country code.

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

digitstringrequired

Allowed:0123456789*

createdAtstring<date-time>required

When the call menu was created.

idstring<uuid>required

maxRepeatsintegerrequired

min 1

namestringrequired

noInputActionobjectrequired

Show properties

Any of:

object

idstring<uuid>required

phoneSystemIdstring<uuid>required

typestringrequired

Allowed:extensionagent-configcall-groupcall-menu

object

idstring<uuid>required

phoneSystemIdstring<uuid>required

typestringrequired

Allowed:extension-voicemailcall-group-voicemail

object

Any of:

object

playbackUrlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

typestringrequired

object

phoneNumberstring<phone-number>required

E.164 phone number, including the leading + and international country code.

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

object

typestringrequired

phoneSystemIdstring<uuid>required

promptPlaybackUrlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

statusstringrequired

Allowed:activeinactive

updatedAtstring<date-time>required

When the call menu record was last updated.

400A path identifier is invalid.

codestringrequired

Stable machine identifier to branch on.

correlationIdstringrequired

Request identifier to quote to support.

detailstringrequired

User-safe explanation. Display it if you must; never match on it.

errorsobject[]

Field-level validation problems. Present on validation failures.

Show properties

Array of object

codestringrequired

Per-field machine code (REQUIRED, TOO_SMALL, …).

detailstringrequired

Human-readable description of the field problem.

pointerstringrequired

JSON Pointer to the offending request field.

paramsobject

Extra primitive detail about the condition, such as a limit that was hit.

retry_afterinteger

Seconds to wait before retrying, when a meaningful delay exists.

retryablebooleanrequired

Whether this condition is transient. Derived from code.

statusintegerrequired

Mirrors the HTTP status code.

titlestringrequired

Short human summary of the problem type.

typestringrequired

URL identifying the problem type. An identifier to match, not a link.

401The API key is missing, malformed, expired, or revoked.

codestringrequired

Stable machine identifier to branch on.

correlationIdstringrequired

Request identifier to quote to support.

detailstringrequired

User-safe explanation. Display it if you must; never match on it.

errorsobject[]

Field-level validation problems. Present on validation failures.

Show properties

Array of object

codestringrequired

Per-field machine code (REQUIRED, TOO_SMALL, …).

detailstringrequired

Human-readable description of the field problem.

pointerstringrequired

JSON Pointer to the offending request field.

paramsobject

Extra primitive detail about the condition, such as a limit that was hit.

retry_afterinteger

Seconds to wait before retrying, when a meaningful delay exists.

retryablebooleanrequired

Whether this condition is transient. Derived from code.

statusintegerrequired

Mirrors the HTTP status code.

titlestringrequired

Short human summary of the problem type.

typestringrequired

URL identifying the problem type. An identifier to match, not a link.

403The key lacks the call-menus:read scope, or is not a tenant API key.

codestringrequired

Stable machine identifier to branch on.

correlationIdstringrequired

Request identifier to quote to support.

detailstringrequired

User-safe explanation. Display it if you must; never match on it.

errorsobject[]

Field-level validation problems. Present on validation failures.

Show properties

Array of object

codestringrequired

Per-field machine code (REQUIRED, TOO_SMALL, …).

detailstringrequired

Human-readable description of the field problem.

pointerstringrequired

JSON Pointer to the offending request field.

paramsobject

Extra primitive detail about the condition, such as a limit that was hit.

retry_afterinteger

Seconds to wait before retrying, when a meaningful delay exists.

retryablebooleanrequired

Whether this condition is transient. Derived from code.

statusintegerrequired

Mirrors the HTTP status code.

titlestringrequired

Short human summary of the problem type.

typestringrequired

URL identifying the problem type. An identifier to match, not a link.

404The call menu or phone system does not exist within the key grant.

codestringrequired

Stable machine identifier to branch on.

correlationIdstringrequired

Request identifier to quote to support.

detailstringrequired

User-safe explanation. Display it if you must; never match on it.

errorsobject[]

Field-level validation problems. Present on validation failures.

Show properties

Array of object

codestringrequired

Per-field machine code (REQUIRED, TOO_SMALL, …).

detailstringrequired

Human-readable description of the field problem.

pointerstringrequired

JSON Pointer to the offending request field.

paramsobject

Extra primitive detail about the condition, such as a limit that was hit.

retry_afterinteger

Seconds to wait before retrying, when a meaningful delay exists.

retryablebooleanrequired

Whether this condition is transient. Derived from code.

statusintegerrequired

Mirrors the HTTP status code.

titlestringrequired

Short human summary of the problem type.

typestringrequired

URL identifying the problem type. An identifier to match, not a link.

Request

curl -X GET "https://api.steerphones.com/v1/customer/phone-systems/%3Cuuid%3E/call-menus/%3Cuuid%3E" \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "allowDirectExtensionDial": true,
  "choices": [
    {
      "actions": [
        {
          "id": "<uuid>",
          "phoneSystemId": "<uuid>",
          "type": "extension"
        }
      ],
      "digit": "0"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "id": "<uuid>",
  "maxRepeats": 0,
  "name": "string",
  "noInputAction": {
    "id": "<uuid>",
    "phoneSystemId": "<uuid>",
    "type": "extension"
  },
  "phoneSystemId": "<uuid>",
  "promptPlaybackUrl": "<uri>",
  "status": "active",
  "updatedAt": "2024-01-01T00:00:00Z"
}

{
  "code": "string",
  "correlationId": "string",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "params": {},
  "retry_after": 0,
  "retryable": true,
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "correlationId": "string",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "params": {},
  "retry_after": 0,
  "retryable": true,
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "correlationId": "string",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "params": {},
  "retry_after": 0,
  "retryable": true,
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "correlationId": "string",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "params": {},
  "retry_after": 0,
  "retryable": true,
  "status": 0,
  "title": "string",
  "type": "string"
}