Skip to content

Incorporating changes in the list phone number api #734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nishadmusthafa merged 2 commits into from
Jan 7, 2026
Merged

Incorporating changes in the list phone number api #734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b37358
Incorporating changes in the list phone number api
nishadmusthafa Jan 7, 2026
fb81a73
Doing away with the now deprecated SipDispatchRuleId field
nishadmusthafa Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
303 changes: 53 additions & 250 deletions cmd/lk/phone_number.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,17 @@ var (
Flags: []cli.Flag{
&cli.IntFlag{
Name: "limit",
Usage: "Maximum number of results (default: 50)",
Usage: "Maximum number of results per page (default: 50)",
Value: 50,
},
&cli.IntFlag{
Name: "offset",
Usage: "Offset for pagination (default: 0)",
Value: 0,
},
&cli.StringSliceFlag{
Name: "status",
Usage: "Filter by status(es) (active, pending, released). Multiple values can be specified.",
Usage: "Filter by status(es) (active, pending, released, offline). Multiple values can be specified.",
},
&cli.StringFlag{
Name: "sip-dispatch-rule-id",
Expand Down Expand Up @@ -161,36 +166,6 @@ func createPhoneNumberClient(ctx context.Context, cmd *cli.Command) (*lksdk.Phon
return lksdk.NewPhoneNumberClient(project.URL, project.APIKey, project.APISecret, withDefaultClientOpts(project)...), nil
}

// getPhoneNumberToDispatchRulesMap fetches all dispatch rules and maps phone number IDs to their associated dispatch rule IDs
// Returns a map where key is phone number ID and value is a slice of dispatch rule IDs
func getPhoneNumberToDispatchRulesMap(ctx context.Context, cmd *cli.Command) (map[string][]string, error) {
_, err := requireProject(ctx, cmd)
if err != nil {
return nil, fmt.Errorf("failed to get project: %w", err)
}

sipClient := lksdk.NewSIPClient(project.URL, project.APIKey, project.APISecret, withDefaultClientOpts(project)...)

// List all dispatch rules
resp, err := sipClient.ListSIPDispatchRule(ctx, &livekit.ListSIPDispatchRuleRequest{})
if err != nil {
return nil, fmt.Errorf("failed to list dispatch rules: %w", err)
}

// Build map: phone number ID -> []dispatch rule IDs
phoneNumberToRules := make(map[string][]string)
for _, rule := range resp.Items {
for _, trunkID := range rule.TrunkIds {
// Check if trunkID is a phone number ID (starts with PN_PPN_)
if strings.HasPrefix(trunkID, "PN_PPN_") {
phoneNumberToRules[trunkID] = append(phoneNumberToRules[trunkID], rule.SipDispatchRuleId)
}
}
}

return phoneNumberToRules, nil
}

func searchPhoneNumbers(ctx context.Context, cmd *cli.Command) error {
client, err := createPhoneNumberClient(ctx, cmd)
if err != nil {
Expand Down Expand Up @@ -265,65 +240,9 @@ func purchasePhoneNumbers(ctx context.Context, cmd *cli.Command) error {
req.SipDispatchRuleId = &dispatchRuleID
}

// Call purchase and get dispatch rules in parallel
type purchaseResult struct {
resp *livekit.PurchasePhoneNumberResponse
err error
}
type dispatchRulesResult struct {
rules map[string][]string
err error
}

purchaseChan := make(chan purchaseResult, 1)
dispatchRulesChan := make(chan dispatchRulesResult, 1)

// Purchase phone numbers
go func() {
resp, err := client.PurchasePhoneNumber(ctx, req)
purchaseChan <- purchaseResult{resp: resp, err: err}
}()

// Get dispatch rules mapping in parallel
go func() {
rules, err := getPhoneNumberToDispatchRulesMap(ctx, cmd)
dispatchRulesChan <- dispatchRulesResult{rules: rules, err: err}
}()

// Wait for purchase to complete
purchaseRes := <-purchaseChan
if purchaseRes.err != nil {
return purchaseRes.err
}
resp := purchaseRes.resp

// Wait for dispatch rules (ignore errors, we'll just not show them)
dispatchRulesRes := <-dispatchRulesChan
phoneNumberToRules := dispatchRulesRes.rules
if dispatchRulesRes.err != nil {
// Log but don't fail
if cmd.Bool("verbose") {
fmt.Fprintf(cmd.ErrWriter, "Warning: failed to get dispatch rules: %v\n", dispatchRulesRes.err)
}
phoneNumberToRules = make(map[string][]string)
}

// If dispatch rule ID was provided, add it to the mapping for display
// (The actual update is now handled by cloud-io)
if dispatchRuleID != "" {
for _, phoneNumber := range resp.PhoneNumbers {
// Check if dispatchRuleID is already in the list
found := false
for _, ruleID := range phoneNumberToRules[phoneNumber.Id] {
if ruleID == dispatchRuleID {
found = true
break
}
}
if !found {
phoneNumberToRules[phoneNumber.Id] = append(phoneNumberToRules[phoneNumber.Id], dispatchRuleID)
}
}
resp, err := client.PurchasePhoneNumber(ctx, req)
if err != nil {
return err
}

if cmd.Bool("json") {
Expand All @@ -334,9 +253,8 @@ func purchasePhoneNumbers(ctx context.Context, cmd *cli.Command) error {
fmt.Printf("Successfully purchased %d phone numbers:\n", len(resp.PhoneNumbers))
for _, phoneNumber := range resp.PhoneNumbers {
ruleInfo := ""
rules := phoneNumberToRules[phoneNumber.Id]
if len(rules) > 0 {
ruleInfo = fmt.Sprintf(" (SIP Dispatch Rules: %s)", strings.Join(rules, ", "))
if len(phoneNumber.SipDispatchRuleIds) > 0 {
ruleInfo = fmt.Sprintf(" (SIP Dispatch Rules: %s)", strings.Join(phoneNumber.SipDispatchRuleIds, ", "))
}
fmt.Printf(" %s (%s) - %s%s\n", phoneNumber.E164Format, phoneNumber.Id, strings.TrimPrefix(phoneNumber.Status.String(), "PHONE_NUMBER_STATUS_"), ruleInfo)
}
Expand All @@ -351,10 +269,17 @@ func listPhoneNumbers(ctx context.Context, cmd *cli.Command) error {
}

req := &livekit.ListPhoneNumbersRequest{}
if val := cmd.Int("limit"); val != 0 {
limit := int32(val)
req.Limit = &limit
limit := int32(cmd.Int("limit"))
offset := int32(cmd.Int("offset"))

// Encode offset and limit into a page token for pagination
// Even if offset is 0, we encode it to include the limit in the token
pageToken, err := livekit.EncodeTokenPagination(offset, limit)
if err != nil {
return fmt.Errorf("failed to encode pagination token: %w", err)
}
req.PageToken = pageToken

if statuses := cmd.StringSlice("status"); len(statuses) > 0 {
var phoneNumberStatuses []livekit.PhoneNumberStatus
for _, status := range statuses {
Expand All @@ -370,66 +295,41 @@ func listPhoneNumbers(ctx context.Context, cmd *cli.Command) error {
req.SipDispatchRuleId = &val
}

// Call list and get dispatch rules in parallel
type listResult struct {
resp *livekit.ListPhoneNumbersResponse
err error
}
type dispatchRulesResult struct {
rules map[string][]string
err error
resp, err := client.ListPhoneNumbers(ctx, req)
if err != nil {
return err
}

listChan := make(chan listResult, 1)
dispatchRulesChan := make(chan dispatchRulesResult, 1)

// List phone numbers
go func() {
resp, err := client.ListPhoneNumbers(ctx, req)
listChan <- listResult{resp: resp, err: err}
}()

// Get dispatch rules mapping in parallel
go func() {
rules, err := getPhoneNumberToDispatchRulesMap(ctx, cmd)
dispatchRulesChan <- dispatchRulesResult{rules: rules, err: err}
}()

// Wait for list to complete
listRes := <-listChan
if listRes.err != nil {
return listRes.err
if cmd.Bool("json") {
util.PrintJSON(resp)
return nil
}
resp := listRes.resp

// Wait for dispatch rules (ignore errors, we'll just not show them)
dispatchRulesRes := <-dispatchRulesChan
phoneNumberToRules := dispatchRulesRes.rules
if dispatchRulesRes.err != nil {
// Log but don't fail
if cmd.Bool("verbose") {
fmt.Fprintf(cmd.ErrWriter, "Warning: failed to get dispatch rules: %v\n", dispatchRulesRes.err)
}
phoneNumberToRules = make(map[string][]string)
fmt.Printf("Total phone numbers: %d", resp.TotalCount)
if resp.OfflineCount > 0 {
fmt.Printf(" (%d offline)", resp.OfflineCount)
}
fmt.Printf("\n")

if cmd.Bool("json") {
util.PrintJSON(resp)
return nil
// Show pagination info
if offset > 0 {
fmt.Printf("Showing results from offset %d\n", offset)
}
if resp.NextPageToken != nil {
nextOffset, _, err := livekit.DecodeTokenPagination(resp.NextPageToken)
if err == nil {
fmt.Printf("More results available. Use --offset %d to see the next page.\n", nextOffset)
}
}

fmt.Printf("Total phone numbers: %d\n", resp.TotalCount)
return listAndPrint(ctx, cmd, func(ctx context.Context, req *livekit.ListPhoneNumbersRequest) (*livekit.ListPhoneNumbersResponse, error) {
return client.ListPhoneNumbers(ctx, req)
}, req, []string{
"ID", "E164", "Country", "Area Code", "Type", "Locality", "Region", "Capabilities", "Status", "SIP Dispatch Rules",
}, func(item *livekit.PhoneNumber) []string {
rules := phoneNumberToRules[item.Id]
dispatchRulesStr := ""
if len(rules) > 0 {
dispatchRulesStr = strings.Join(rules, ", ")
} else if item.SipDispatchRuleId != "" {
dispatchRulesStr = item.SipDispatchRuleId
if len(item.SipDispatchRuleIds) > 0 {
dispatchRulesStr = strings.Join(item.SipDispatchRuleIds, ", ")
} else {
dispatchRulesStr = "-"
}
Expand Down Expand Up @@ -471,47 +371,9 @@ func getPhoneNumber(ctx context.Context, cmd *cli.Command) error {
req.PhoneNumber = &phoneNumber
}

// Call get and get dispatch rules in parallel
type getResult struct {
resp *livekit.GetPhoneNumberResponse
err error
}
type dispatchRulesResult struct {
rules map[string][]string
err error
}

getChan := make(chan getResult, 1)
dispatchRulesChan := make(chan dispatchRulesResult, 1)

// Get phone number
go func() {
resp, err := client.GetPhoneNumber(ctx, req)
getChan <- getResult{resp: resp, err: err}
}()

// Get dispatch rules mapping in parallel
go func() {
rules, err := getPhoneNumberToDispatchRulesMap(ctx, cmd)
dispatchRulesChan <- dispatchRulesResult{rules: rules, err: err}
}()

// Wait for get to complete
getRes := <-getChan
if getRes.err != nil {
return getRes.err
}
resp := getRes.resp

// Wait for dispatch rules (ignore errors, we'll just not show them)
dispatchRulesRes := <-dispatchRulesChan
phoneNumberToRules := dispatchRulesRes.rules
if dispatchRulesRes.err != nil {
// Log but don't fail
if cmd.Bool("verbose") {
fmt.Fprintf(cmd.ErrWriter, "Warning: failed to get dispatch rules: %v\n", dispatchRulesRes.err)
}
phoneNumberToRules = make(map[string][]string)
resp, err := client.GetPhoneNumber(ctx, req)
if err != nil {
return err
}

if cmd.Bool("json") {
Expand All @@ -520,12 +382,9 @@ func getPhoneNumber(ctx context.Context, cmd *cli.Command) error {
}

item := resp.PhoneNumber
rules := phoneNumberToRules[item.Id]
dispatchRulesStr := ""
if len(rules) > 0 {
dispatchRulesStr = strings.Join(rules, ", ")
} else if item.SipDispatchRuleId != "" {
dispatchRulesStr = item.SipDispatchRuleId
if len(item.SipDispatchRuleIds) > 0 {
dispatchRulesStr = strings.Join(item.SipDispatchRuleIds, ", ")
} else {
dispatchRulesStr = "-"
}
Expand Down Expand Up @@ -576,64 +435,9 @@ func updatePhoneNumber(ctx context.Context, cmd *cli.Command) error {
req.SipDispatchRuleId = &dispatchRuleID
}

// Call update and get dispatch rules in parallel
type updateResult struct {
resp *livekit.UpdatePhoneNumberResponse
err error
}
type dispatchRulesResult struct {
rules map[string][]string
err error
}

updateChan := make(chan updateResult, 1)
dispatchRulesChan := make(chan dispatchRulesResult, 1)

// Update phone number
go func() {
resp, err := client.UpdatePhoneNumber(ctx, req)
updateChan <- updateResult{resp: resp, err: err}
}()

// Get dispatch rules mapping in parallel
go func() {
rules, err := getPhoneNumberToDispatchRulesMap(ctx, cmd)
dispatchRulesChan <- dispatchRulesResult{rules: rules, err: err}
}()

// Wait for update to complete
updateRes := <-updateChan
if updateRes.err != nil {
return updateRes.err
}
resp := updateRes.resp

// Wait for dispatch rules (ignore errors, we'll just not show them)
dispatchRulesRes := <-dispatchRulesChan
phoneNumberToRules := dispatchRulesRes.rules
if dispatchRulesRes.err != nil {
// Log but don't fail
if cmd.Bool("verbose") {
fmt.Fprintf(cmd.ErrWriter, "Warning: failed to get dispatch rules: %v\n", dispatchRulesRes.err)
}
phoneNumberToRules = make(map[string][]string)
}

// If dispatch rule ID was provided, add it to the mapping for display
// (The actual update is now handled by cloud-io)
if dispatchRuleID != "" {
phoneNumberID := resp.PhoneNumber.Id
// Check if dispatchRuleID is already in the list
found := false
for _, ruleID := range phoneNumberToRules[phoneNumberID] {
if ruleID == dispatchRuleID {
found = true
break
}
}
if !found {
phoneNumberToRules[phoneNumberID] = append(phoneNumberToRules[phoneNumberID], dispatchRuleID)
}
resp, err := client.UpdatePhoneNumber(ctx, req)
if err != nil {
return err
}

if cmd.Bool("json") {
Expand All @@ -642,10 +446,9 @@ func updatePhoneNumber(ctx context.Context, cmd *cli.Command) error {
}

item := resp.PhoneNumber
rules := phoneNumberToRules[item.Id]
dispatchRulesStr := ""
if len(rules) > 0 {
dispatchRulesStr = strings.Join(rules, ", ")
if len(item.SipDispatchRuleIds) > 0 {
dispatchRulesStr = strings.Join(item.SipDispatchRuleIds, ", ")
} else {
dispatchRulesStr = "-"
}
Expand Down
Loading
Loading