Interface ILiveKitPhoneNumberService

Namespace

LiveKit.Services

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

Service for managing phone numbers for SIP integration.

Provides methods for searching, purchasing, and managing phone numbers for SIP trunk configuration. See Phone Number Service Documentation for more information.

public interface ILiveKitPhoneNumberService

Methods

GetPhoneNumberAsync(GetPhoneNumberRequest, CancellationToken)

Gets a specific phone number.

Task<GetPhoneNumberResponse> GetPhoneNumberAsync(GetPhoneNumberRequest request, CancellationToken cancellationToken = default)

Parameters

request GetPhoneNumberRequest

cancellationToken CancellationToken

Returns

Task<GetPhoneNumberResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ListPhoneNumbersAsync(ListPhoneNumbersRequest, CancellationToken)

Lists phone numbers for the project.

Task<ListPhoneNumbersResponse> ListPhoneNumbersAsync(ListPhoneNumbersRequest request, CancellationToken cancellationToken = default)

Parameters

request ListPhoneNumbersRequest

cancellationToken CancellationToken

Returns

Task<ListPhoneNumbersResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

PurchasePhoneNumberAsync(PurchasePhoneNumberRequest, CancellationToken)

Purchases phone numbers from inventory.

Task<PurchasePhoneNumberResponse> PurchasePhoneNumberAsync(PurchasePhoneNumberRequest request, CancellationToken cancellationToken = default)

Parameters

request PurchasePhoneNumberRequest

cancellationToken CancellationToken

Returns

Task<PurchasePhoneNumberResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ReleasePhoneNumbersAsync(ReleasePhoneNumbersRequest, CancellationToken)

Releases phone numbers back to inventory.

Task<ReleasePhoneNumbersResponse> ReleasePhoneNumbersAsync(ReleasePhoneNumbersRequest request, CancellationToken cancellationToken = default)

Parameters

request ReleasePhoneNumbersRequest

cancellationToken CancellationToken

Returns

Task<ReleasePhoneNumbersResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

SearchPhoneNumbersAsync(SearchPhoneNumbersRequest, CancellationToken)

Searches available phone numbers in inventory.

Task<SearchPhoneNumbersResponse> SearchPhoneNumbersAsync(SearchPhoneNumbersRequest request, CancellationToken cancellationToken = default)

Parameters

request SearchPhoneNumbersRequest

cancellationToken CancellationToken

Returns

Task<SearchPhoneNumbersResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

UpdatePhoneNumberAsync(UpdatePhoneNumberRequest, CancellationToken)

Updates a phone number configuration.

Task<UpdatePhoneNumberResponse> UpdatePhoneNumberAsync(UpdatePhoneNumberRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdatePhoneNumberRequest

cancellationToken CancellationToken

Returns

Task<UpdatePhoneNumberResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.