Create branded caller ID

POSThttps://api.tried.com.au/create-branded-caller-id

Needs keys Creates a branded caller ID record for a number in your workspace and enrolls the number in Telnyx Number Reputation. The record starts as pending; check approval with Refresh branded caller ID. Real enrollment needs TELNYX_API_KEY and TELNYX_ENTERPRISE_ID. Without a Telnyx key, mock mode stores the record with provider mock and approves it on the first refresh.

Request#

Field	Type	Required	Description
`phone_number`	string	Yes	A number in your workspace, in E.164.
`display_name`	string	Yes	Name shown to the person you call. 1 to 32 characters.
`call_reason`	string	No	Short reason for the call, up to 60 characters.
`logo_url`	string	No	URL of your logo. Must be a valid URL.

Example request#

curl -X POST https://api.tried.com.au/create-branded-caller-id \
  -H "Authorization: Bearer $TRIED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+14155550123",
    "display_name": "Harbour Dental",
    "call_reason": "Appointment reminder"
  }'

const res = await fetch("https://api.tried.com.au/create-branded-caller-id", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TRIED_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    phone_number: "+14155550123",
    display_name: "Harbour Dental",
    call_reason: "Appointment reminder",
  }),
});
const branded = await res.json();

import os, requests

res = requests.post(
    "https://api.tried.com.au/create-branded-caller-id",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    json={
        "phone_number": "+14155550123",
        "display_name": "Harbour Dental",
        "call_reason": "Appointment reminder",
    },
)
branded = res.json()

Response#

201 Created

{
  "branded_caller_id": "bcid_7e2a91c4d08f5b36e1a9c7d0",
  "phone_number": "+14155550123",
  "display_name": "Harbour Dental",
  "call_reason": "Appointment reminder",
  "status": "pending",
  "provider": "telnyx",
  "provider_reference": "c41f9a2e-6b07-4d1a-9e35-8f2b1d6c0a47",
  "created_timestamp": 1792396800000,
  "last_modification_timestamp": 1792396800000
}

Field	Type	Description
`branded_caller_id`	string	Record ID, `bcid_` plus 24 hex characters.
`call_reason`	string	Left out when not set.
`logo_url`	string	Left out when not set.
`status`	string	`pending`, `approved` or `rejected`.
`provider`	string	`telnyx`, or `mock` in mock mode.
`provider_reference`	string or null	The Telnyx enrollment ID.
`created_timestamp`	integer	Unix ms.
`last_modification_timestamp`	integer	Unix ms.

Errors#

Status	When
`400`	Body validation failed, for example `display_name: String must contain at most 32 character(s)`.
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `numbers` scope. Members get `The member role is read-only`.
`404`	`Phone number ... not found` in this workspace.
`429`	Rate limit exceeded. See Rate limits.
`500`	Telnyx rejected the enrollment, or `TELNYX_ENTERPRISE_ID` is not set.

See Errors for the body format.