Skip to content

ListContact Improvements #787

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
bbernhard merged 5 commits into from
Feb 13, 2026
Merged

ListContact Improvements #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
379ff16
direct uuid contact search
dangnabit Feb 12, 2026
6ec6e19
Adds --all-recipient handling for ListContact endpoints
dangnabit Feb 12, 2026
5fcaa2c
type cleanup, fix typo
dangnabit Feb 12, 2026
eece5f4
remove ListContact, extended ListContacts to accept uuid
dangnabit Feb 13, 2026
59f9cd3
revert moving list contact types around
dangnabit Feb 13, 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
20 changes: 16 additions & 4 deletions src/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2408,6 +2408,7 @@ func (a *Api) AddStickerPack(c *gin.Context) {
// @Produce json
// @Success 200 {object} []client.ListContactsResponse
// @Param number path string true "Registered Phone Number"
// @Param all_recipients query string false "Include all known recipients, not only contacts." (default: false)"
// @Router /v1/contacts/{number} [get]
func (a *Api) ListContacts(c *gin.Context) {
number, err := url.PathUnescape(c.Param("number"))
Expand All @@ -2421,8 +2422,12 @@ func (a *Api) ListContacts(c *gin.Context) {
return
}

contacts, err := a.signalClient.ListContacts(number)

allRecipients := c.DefaultQuery("all_recipients", "false")
if allRecipients != "true" && allRecipients != "false" {
c.JSON(400, Error{Msg: "Couldn't process request - all_recipients parameter needs to be either 'true' or 'false'"})
return
}
contacts, err := a.signalClient.ListContacts(number, StringToBool(allRecipients), "")
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
Expand All @@ -2437,6 +2442,7 @@ func (a *Api) ListContacts(c *gin.Context) {
// @Produce json
// @Success 200 {object} client.ListContactsResponse
// @Param number path string true "Registered Phone Number"
// @Param all_recipients query string false "Include all known recipients, not only contacts." (default: false)"
// @Router /v1/contacts/{number}/{uuid} [get]
func (a *Api) ListContact(c *gin.Context) {
number, err := url.PathUnescape(c.Param("number"))
Expand All @@ -2456,7 +2462,13 @@ func (a *Api) ListContact(c *gin.Context) {
return
}

contact, err := a.signalClient.ListContact(number, uuid)
allRecipients := c.DefaultQuery("all_recipients", "false")
if allRecipients != "true" && allRecipients != "false" {
c.JSON(400, Error{Msg: "Couldn't process request - all_recipients parameter needs to be either 'true' or 'false'"})
return
}

contacts, err := a.signalClient.ListContacts(number, StringToBool(allRecipients), uuid)
if err != nil {
switch err.(type) {
case *client.NotFoundError:
Expand All @@ -2468,7 +2480,7 @@ func (a *Api) ListContact(c *gin.Context) {
}
}

c.JSON(200, contact)
c.JSON(200, contacts[0])
}

// @Summary Returns the avatar of a contact
Expand Down
44 changes: 26 additions & 18 deletions src/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2602,7 +2602,7 @@ func (s *SignalClient) AddStickerPack(number string, packId string, packKey stri
}
}

func (s *SignalClient) ListContacts(number string) ([]ListContactsResponse, error) {
func (s *SignalClient) ListContacts(number string, allRecipients bool, recipient string) ([]ListContactsResponse, error) {
type SignalCliProfileResponse struct {
LastUpdateTimestamp int64 `json:"lastUpdateTimestamp"`
GivenName string `json:"givenName"`
Expand All @@ -2611,7 +2611,7 @@ func (s *SignalClient) ListContacts(number string) ([]ListContactsResponse, erro
HasAvatar bool `json:"hasAvatar"`
}

type ListContactsSignlCliResponse struct {
type ListContactsSignalCliResponse struct {
Number string `json:"number"`
Uuid string `json:"uuid"`
Name string `json:"name"`
Expand All @@ -2634,29 +2634,51 @@ func (s *SignalClient) ListContacts(number string) ([]ListContactsResponse, erro
var rawData string

if s.signalCliMode == JsonRpc {
type Request struct {
AllRecipients bool `json:"allRecipients,omitempty"`
Recipient string `json:"recipient,omitempty"`
}
req := Request{}
if allRecipients {
req.AllRecipients = allRecipients
}
if recipient != "" {
req.Recipient = recipient
}

jsonRpc2Client, err := s.getJsonRpc2Client()
if err != nil {
return nil, err
}
rawData, err = jsonRpc2Client.getRaw("listContacts", &number, nil)
rawData, err = jsonRpc2Client.getRaw("listContacts", &number, req)
if err != nil {
return resp, err
}
} else {
cmd := []string{"--config", s.signalCliConfig, "-o", "json", "-a", number, "listContacts"}
if allRecipients {
cmd = append(cmd, "--all-recipients")
}
if recipient != "" {
cmd = append(cmd, recipient)
}
rawData, err = s.cliClient.Execute(true, cmd, "")
if err != nil {
return resp, err
}
}

var signalCliResp []ListContactsSignlCliResponse
var signalCliResp []ListContactsSignalCliResponse
err = json.Unmarshal([]byte(rawData), &signalCliResp)
if err != nil {
log.Error("Couldn't list contacts", err.Error())
return resp, errors.New("Couldn't process request - invalid signal-cli response")
}

if recipient != "" && len(signalCliResp) == 0 {
return resp, &NotFoundError{Description: "No user with that id (" + recipient + ") found"}
}

for _, value := range signalCliResp {
entry := ListContactsResponse{
Number: value.Number,
Expand Down Expand Up @@ -2684,20 +2706,6 @@ func (s *SignalClient) ListContacts(number string) ([]ListContactsResponse, erro
return resp, nil
}

func (s *SignalClient) ListContact(number string, uuid string) (ListContactsResponse, error) {
contacts, err := s.ListContacts(number)
if err != nil {
return ListContactsResponse{}, err
}

for _, contact := range contacts {
if contact.Uuid == uuid {
return contact, nil
}
}

return ListContactsResponse{}, &NotFoundError{Description: "No contact with that id (" + uuid + ") found"}
}

func (s *SignalClient) SetPin(number string, registrationLockPin string) error {
if s.signalCliMode == JsonRpc {
Expand Down
71 changes: 43 additions & 28 deletions src/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,6 +573,12 @@ const docTemplate = `{
"name": "number",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Include all known recipients, not only contacts.",
"name": "all_recipients",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -682,6 +688,12 @@ const docTemplate = `{
"name": "number",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Include all known recipients, not only contacts.",
"name": "all_recipients",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -2653,7 +2665,7 @@ const docTemplate = `{
"type": "string"
},
"permissions": {
"$ref": "#/definitions/api.GroupPermissions"
"$ref": "#/definitions/data.GroupPermissions"
}
}
},
Expand Down Expand Up @@ -2727,32 +2739,6 @@ const docTemplate = `{
}
}
},
"api.GroupPermissions": {
"type": "object",
"properties": {
"add_members": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"edit_group": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"send_messages": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
}
}
},
"api.LoggingConfiguration": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -3085,7 +3071,7 @@ const docTemplate = `{
"type": "string"
},
"permissions": {
"$ref": "#/definitions/api.GroupPermissions"
"$ref": "#/definitions/data.GroupPermissions"
}
}
},
Expand Down Expand Up @@ -3230,6 +3216,9 @@ const docTemplate = `{
"items": {
"type": "string"
}
},
"permissions": {
"$ref": "#/definitions/data.GroupPermissions"
}
}
},
Expand Down Expand Up @@ -3359,6 +3348,32 @@ const docTemplate = `{
}
}
},
"data.GroupPermissions": {
"type": "object",
"properties": {
"add_members": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"edit_group": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"send_messages": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
}
}
},
"data.LinkPreviewType": {
"type": "object",
"properties": {
Expand Down
71 changes: 43 additions & 28 deletions src/docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,12 @@
"name": "number",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Include all known recipients, not only contacts.",
"name": "all_recipients",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -679,6 +685,12 @@
"name": "number",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Include all known recipients, not only contacts.",
"name": "all_recipients",
"in": "query"
}
],
"responses": {
Expand Down Expand Up @@ -2650,7 +2662,7 @@
"type": "string"
},
"permissions": {
"$ref": "#/definitions/api.GroupPermissions"
"$ref": "#/definitions/data.GroupPermissions"
}
}
},
Expand Down Expand Up @@ -2724,32 +2736,6 @@
}
}
},
"api.GroupPermissions": {
"type": "object",
"properties": {
"add_members": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"edit_group": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"send_messages": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
}
}
},
"api.LoggingConfiguration": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -3082,7 +3068,7 @@
"type": "string"
},
"permissions": {
"$ref": "#/definitions/api.GroupPermissions"
"$ref": "#/definitions/data.GroupPermissions"
}
}
},
Expand Down Expand Up @@ -3227,6 +3213,9 @@
"items": {
"type": "string"
}
},
"permissions": {
"$ref": "#/definitions/data.GroupPermissions"
}
}
},
Expand Down Expand Up @@ -3356,6 +3345,32 @@
}
}
},
"data.GroupPermissions": {
"type": "object",
"properties": {
"add_members": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"edit_group": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
},
"send_messages": {
"type": "string",
"enum": [
"only-admins",
"every-member"
]
}
}
},
"data.LinkPreviewType": {
"type": "object",
"properties": {
Expand Down
Loading
Loading