All pages

API reference

Get a command

GET /v1/conversations/{conversation_id}/commands/{command_id}

View as Markdown

How something a call was asked to do went: sent, taken once the call's agent has it, then done or failed. Needs calls:control.

Parameters

Name In Type Required Description
conversation_id path string (uuid) Yes
command_id path string (uuid) Yes

Answer

200 with ConversationCommandObject.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
404 This key reaches no such conversation or command.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

Read how a command went
#!/bin/sh
# Read how a command went
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/conversations/5b7d9f1b-3d5f-4b7d-a9f1-b3d5f7b9dbfd/commands/6c8e0a2c-4e6a-4c8e-b0a2-c4e6a8cafc0e" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.