Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

An API key (sig_...), or a session token from the web app.

Path Parameters

agentId
string<uuid>
required

The agent's id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

callId
string<uuid>
required

The call's id in Signal (not the platform's call id).

Response

The call's signals.

object
enum<string>
required
Available options:
call_signals
callId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

detected
object[] | null
required

The signals raised on the call. Null until the call is analysed.

observations
object[] | null
required

Moments in the call checked against how the agent is configured. Evidence for an issue, never an issue on their own. Null when the call has not been read this way.