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

getPhoneRouting

Who answers an inbound call or text.

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

Who answers an inbound call or text: the call routing the Automations Map's Phone calls area shows, and who gets a new contact. orgDefaultRingPolicy is the default every line follows unless it has its own (null = none configured): humanStage is who rings first (targetKind LINE_OWNER the number's own user, SPECIFIC_USER one teammate, TEAM a team, ORG_USER_ROTATION a rotation of lines, EXTERNAL or AREA_CODE_MAP forwarding; a null humanStage means nobody rings and the AI pickup answers at once), for ringSeconds, only inside its schedule (null = always); aiStage is the AI employees that pick up a missed call, in rotation (no AI answers only when it is empty or every one has canAnswerCalls false). defaultInboundIntakePolicy is who gets a NEW contact created by inbound traffic. Each line lists its owner and ringPolicyId / assignmentPolicyId (null = follows the default); read a line's own policy with getPhoneLineRingPolicy. Change a ring policy with setOrgDefaultRingPolicy or setPhoneLineRingPolicy.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getPhoneRouting",
    "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.getPhoneRouting()
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: 'getPhoneRouting',
    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": {
    "ringPolicyQuery": {
      "orgDefaultRingPolicy": {
        "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"
        }
      }
    },
    "currentUser": {
      "id": "<ID>",
      "organization": {
        "id": "<ID>",
        "defaultInboundIntakePolicy": {
          "assigneeUserIds": [
            "<ID>"
          ],
          "participantUserIds": [
            "<ID>"
          ],
          "teamIds": [
            "<ID>"
          ],
          "agentAssigneeIds": [
            "<ID>"
          ],
          "workflowGroupIds": [
            "<ID>"
          ],
          "tags": [
            "…"
          ]
        },
        "twilioPhoneNumbers": [
          {
            "id": "<ID>",
            "e164Number": "…",
            "user": {
              "id": "<ID>",
              "firstName": "…",
              "lastName": "…"
            },
            "ringPolicyId": "<ID>",
            "assignmentPolicyId": "<ID>"
          }
        ]
      }
    }
  }
}

Errors

Behaviour

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