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

provisionPhoneNumber

Buy a phone number from Twilio (a RECURRING monthly charge) and assign it to targetUserId.

POST/api/v1/callADMINidempotent · 24 hruns as the key's owner
View as Markdown

Buy a phone number from Twilio (a RECURRING monthly charge) and assign it to targetUserId. It shows at once in listCommunicationChannels, ready to send from. Confirm first: name the number, who gets it and the monthly charge. phoneNumber must be an E.164 number returned by searchAvailablePhoneNumbers (an unavailable number is rejected). targetUserId is normally the key owner (listCommunicationChannels.currentUser.id); a user outside your organization is rejected. A number past the phone numbers the plan includes adds $5/mo on top of the plan: it is refused (PHONE_NUMBER_ALLOWANCE_REFUSED) unless confirmExtraPhoneNumberCharge is true, which you send only once the person agreed to that extra charge. checkBillingAction tells you beforehand whether a number is included. ADMIN scope: the key owner must currently be an org admin. Idempotent: reuse an Idempotency-Key to make a retry safe.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "provisionPhoneNumber",
    "variables": {
      "phoneNumber": "<String>",
      "targetUserId": "<targetUserId>"
    }
  }'
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.provisionPhoneNumber(
  {
    phoneNumber: '<String>',
    targetUserId: '<targetUserId>'
  },
  { idempotencyKey: crypto.randomUUID() },
)
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',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'provisionPhoneNumber',
    variables: {
      phoneNumber: '<String>',
      targetUserId: '<targetUserId>'
    }
  }),
})
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.

phoneNumberString!required
targetUserIdID!required
confirmExtraPhoneNumberChargeBoolean

Response

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

response shape
{
  "data": {
    "twilioMutation": {
      "provisionPhoneNumber": {
        "id": "<ID>",
        "e164Number": "…",
        "isPrimary": true,
        "canSendSms": 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.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

READsearchAvailablePhoneNumbersREADgetVoiceTrustSummaryREADgetPhoneRoutingREADgetPhoneLineRingPolicyWRITEsetOrgDefaultRingPolicyWRITEsetPhoneLineRingPolicy