Assistant status on a call

GET

/v1/calls/{callId}/agent

const url = 'https://your-machine.your-tailnet.ts.net/v1/calls/example/agent';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://your-machine.your-tailnet.ts.net/v1/calls/example/agent \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer
apiKey

Parameters

Path Parameters

callId

required

string

Responses

200

Status, transcript and the message it took, if any.

application/json

object

requested

boolean

status

string

Allowed values: off waiting connecting live ended error

error

string

transcript

Array<object>

object

role

string

Allowed values: caller agent

text

string

string format: date-time

message

object

callId

string

remoteNumber

string

callerName

string

reason

string

callbackNumber

string

urgency

string

Allowed values: low normal high

takenAt

string format: date-time

Example

{
  "status": "off",
  "transcript": [
    {
      "role": "caller"
    }
  ],
  "message": {
    "urgency": "low"
  }
}