getVoiceTrustSummary

One org-wide picture of caller-trust registration: the carrier registration that keeps outbound calls from showing as "Spam Likely". accountState is chosen by loudest call to action, not by progress (FAILED > REGISTERING > REGISTERED > SELF_MANAGED > NOT_ELIGIBLE), so one refused account reads FAILED even when another is done. The line counts split the org's numbers by registration (registered / registering / failed, summing to eligibleLineCount) and by carrier health (watch / atRisk). needsAttention is the only flag that means "a human must act now": a refused account or a number carriers appear to be rejecting; failedLineCount alone does not raise it, because a single errored attempt is retried by the next sweep. Read-only: registration runs on its own schedule and there is nothing to submit through this API.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getVoiceTrustSummary",
    "variables": {}
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.phoneNumbers.getVoiceTrustSummary()

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'getVoiceTrustSummary',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

None. Send "variables": {}.

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "voiceTrustQuery": {
      "summary": {
        "accountState": "REGISTERED",
        "eligibleLineCount": 0,
        "registeredLineCount": 0,
        "registeringLineCount": 0,
        "failedLineCount": 0,
        "watchLineCount": 0,
        "atRiskLineCount": 0,
        "needsAttention": true
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "getVoiceTrustSummary", "variables": {} }'

import { GoliathClient } from '@goliath-data/sdk' const goliath = new GoliathClient({ apiKey: process.env.GOLIATH_API_KEY!, baseUrl: 'https://server.goliathdata.com', }) const result = await goliath.phoneNumbers.getVoiceTrustSummary()

const res = await fetch('https://server.goliathdata.com/api/v1/call', { method: 'POST', headers: { Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ operationId: 'getVoiceTrustSummary', variables: {} }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related