Phone System

LC Phone API v3

API Service for LC Phone - versión v3

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /phone-system/number-pools — Listar number pools
• GET /phone-system/numbers/location/{locationId}/available — Listar available phone numbers
• POST /phone-system/numbers/location/{locationId}/purchase — Purchase number for location
• GET /phone-system/numbers/location/{locationId} — Listar active numbers

GET /phone-system/number-pools

Listar number pools Returns number pools for the location. Requires locationId as a query parameter.

Scopes requeridos: numberpools.read

Parametros: - locationId (query, string) (requerido) — Location Id to scope the number pool list

Respuestas: - 200 — List of number pools for the location.

GET /phone-system/numbers/location/{locationId}/available

Listar available phone numbers Search Twilio inventory for purchasable phone numbers in a country for the given location.

Scopes requeridos: phonenumbers.read

Parametros: - firstPart (query, string) (requerido) — firstPart is the beginning of the phone number - lastPart (query, string) (requerido) — lastPart is the ending of the phone number - anywhere (query, string) (requerido) — anywhere are the numbers required anywhere in phone number - numberTypes (query, array) (requerido) — comma separated types of phone number required - smsEnabled (query, boolean) (requerido) — requested phone numbers should have sms functionality - mmsEnabled (query, boolean) (requerido) — requested phone numbers should have mms functionality - voiceEnabled (query, boolean) (requerido) — requested phone numbers should have voice functionality - countryCode (query, string) (requerido) — country for which the phone numbers are being requested - locationId (path, string) (requerido) — Location Id as string

Respuestas: - 200 — Available phone numbers matching the search criteria.

POST /phone-system/numbers/location/{locationId}/purchase

Purchase number for location Purchase number for location. With versión: v3, the HTTP 201 body is the standard success envelope (status, data, message, statusCode). The v3 purchase fields live under data: number, locationId, id, and underLcAccount (renamed from under_ghl_account).

Scopes requeridos: phonenumbers.write

Parametros: - locationId (path, string) (requerido) — Location Id as string - versión (header, string) (requerido) — Send v3 to use the v3 response contract (AIP). This is the supported versión value for these endpoints.

Cuerpo de la peticion (application/json): - phoneNumber (requerido) — string — phoneNumber to purchase - addressSid (requerido) — string — addressSid twilio address id - bundleSid (requerido) — string — bundleSid twilio bundle id - countryCode (requerido) — string — country for which the phone numbers are being requested - numberType (requerido) — object — type of phone number to be purchased - paymentIntentId (requerido) — string — stripe payment intent id - stripeAccountId (requerido) — string — stripe account id - paymentMethodId (requerido) — string — stripe registered payment method id - locality (requerido) — string — locality of the user in which number is being purchased - region (requerido) — string — region of the user in which number is being purchased - fingerprintId (requerido) — string — fingerprintId is request id which is unique for every purchase number request - skipLocationKYC (requerido) — boolean — Skip location-level KYC verification if agency-level compliance has already been verified

Respuestas: - 201 — Success envelope; v3 purchase details are in data (slim shape: number, locationId, id, underLcAccount).

GET /phone-system/numbers/location/{locationId}

Listar active numbers List active numbers. With versión: v3, the HTTP 200 body is the standard success envelope (status, data, message, statusCode). The v3 list payload is under data; isUnderGhl is renamed to isUnderLc per AIP naming convention.

Scopes requeridos: phonenumbers.read

Parametros: - locationId (path, string) (requerido) — Location Id as string - pageSize (query, number) — How many resources to return in each list page. The default is 50, and the maximum is 1000. - page (query, number) — The page index. The default is 0. - searchFilter (query, string) — Number search Filter - skipNumberPool (query, boolean) — When true, exclude numbers assigned to number pools from the list. - includeRcsSenderIds (query, boolean) — Include RCS Sender IDs - versión (header, string) (requerido) — Send v3 to use the v3 response contract (AIP). This is the supported versión value for these endpoints.

Respuestas: - 200 — Success envelope; v3 list details are in data (including isUnderLc instead of legacy isUnderGhl).