GoliathDevelopersGet an API key
Reference/Phone Numbersgenerated from the gateway manifest

getPhoneLineRingPolicy

One line's own ring policy.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

One line's own ring policy (its override of the org default), in getPhoneRouting's shape; null when the line follows the default. phoneLineId from getPhoneRouting or listCommunicationChannels.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getPhoneLineRingPolicy",
    "variables": {
      "phoneLineId": "<phoneLineId>"
    }
  }'
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.getPhoneLineRingPolicy({
  phoneLineId: '<phoneLineId>'
})
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: 'getPhoneLineRingPolicy',
    variables: {
      phoneLineId: '<phoneLineId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

phoneLineIdID!required

Response

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

response shape
{
  "data": {
    "ringPolicyQuery": {
      "phoneLineRingPolicy": {
        "id": "<ID>",
        "humanStage": {
          "targetKind": "EXTERNAL",
          "ringSeconds": 0,
          "externalE164": "…",
          "specificUser": {
            "id": "<ID>",
            "name": "…"
          },
          "phoneLineIds": [
            "<ID>"
          ],
          "userGroupId": "<ID>",
          "ringAllTeamMembers": true,
          "areaCodeForwardingMap": "…",
          "ownerlessStep": {
            "targetKind": "EXTERNAL",
            "externalE164": "…",
            "specificUser": {
              "id": "<ID>",
              "name": "…"
            },
            "phoneLineIds": [
              "<ID>"
            ],
            "userGroupId": "<ID>"
          },
          "schedule": {
            "timezone": "…",
            "days": [
              {
                "day": "MON",
                "open": "…",
                "close": "…",
                "enabled": true
              }
            ]
          }
        },
        "aiStage": {
          "agents": [
            {
              "id": "<ID>",
              "name": "…",
              "canAnswerCalls": true,
              "cannotAnswerReason": "PAUSED"
            }
          ],
          "rotation": "SINGLE"
        }
      }
    }
  }
}

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.

READsearchAvailablePhoneNumbersREADgetVoiceTrustSummaryREADgetPhoneRoutingWRITEsetOrgDefaultRingPolicyWRITEsetPhoneLineRingPolicyADMINprovisionPhoneNumber