Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

TFU Live agent id. Never use an ordinary provider agent id.

Query Parameters

locationId
string
required

Sub-account belonging to the authenticated agency and any narrower credential location binding.

campaignId
string

When more than one campaign uses this rep, the one whose calling line to use.

Pattern: ^[a-zA-Z0-9_-]{1,100}$

Response

Successful response.

success
any
required
line
object | null
required

The rep’s calling line as it is now.

pending
object | null
required

A number being bought or connected for the rep right now, else null.

countries
object[]
required

Where a TFU Live rep’s number can be bought.

campaign
any

Present when the rep has no campaign yet, so it has no line to put a number on.