Skip to main content
POST
/
v1
/
calls
/
{callId}
/
commands
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/calls/{callId}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "answer"
}
'
{
  "callId": "call_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "command": "hangup",
  "status": "accepted"
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Path Parameters

​
callId
string
required

Unique identifier for a Call. Format: call_[test_]{ksuid}

Pattern: ^call_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"call_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Body

application/json
​
type
enum<string>
required
Available options:
answer

Response

Command accepted

​
callId
string
required

Unique identifier for a Call. Format: call_[test_]{ksuid}

Pattern: ^call_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"call_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
command
string
required

The command that was executed

Example:

"hangup"

​
status
enum<string>
required

Whether the command was accepted for execution

Available options:
accepted,
queued
Example:

"accepted"