Initiate Call Test

POST /api/v1/public/agent/test/{uuid} — request parameters and responses from the Menace Voice API schema.

2 min read

post/api/v1/public/agent/test/{uuid}

Request example

curl --request POST \
  --url https://voice.menaceui.com/api/v1/public/agent/test/{uuid} \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone_number": "<string>",
  "initial_context": {},
  "telephony_configuration_id": 1,
  "from_phone_number_id": 1
}'

Response

{
  "status": "<string>",
  "workflow_run_id": 1,
  "workflow_run_name": "<string>"
}

post/api/v1/public/agent/test/{uuid}

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

Path parameters

uuidstringrequired#

Headers

X-API-Keystringrequired#

Body

application/json

phone_numberstringrequired#

initial_contextobject · null#

Show child attributes

Any of

telephony_configuration_idinteger · null#

Show child attributes

Any of

from_phone_number_idinteger · null#

Show child attributes

Any of

Responses

application/json

Successful Response

statusstringrequired#

workflow_run_idintegerrequired#

workflow_run_namestringrequired#

Initiate Call Initiate Call By Workflow Uuid