Get Disposition Codes

GET /api/v1/organizations/disposition-codes — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/organizations/disposition-codes

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/organizations/disposition-codes \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "codes": [
    "<string>"
  ],
  "end_task_reason_codes": [
    "<string>"
  ],
  "system_codes": [
    "<string>"
  ]
}

get/api/v1/organizations/disposition-codes

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

codesstring[]required#

Every code that can appear in gathered_context.mapped_call_disposition: the platform's built-in dispositions plus any custom mapped codes this organization's runs have produced.

end_task_reason_codesstring[]required#

Disposition codes defined by Pipecat's EndTaskReason enum.

system_codesstring[]required#

Only the platform's built-in dispositions, without the custom codes this organization's runs have produced. This is the set a disposition mapping translates from, so the mapping editor seeds its rows here: codes also contains mapped codes, which are the targets of a mapping rather than its sources.

Migrate Model Configuration V2 Get Preferences