aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-19 23:54:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

added new API endpoints to show/hide typing indicators

Browse Source 
see #166
This commit is contained in:
Bernhard B
2021-10-25 19:44:47 +02:00
parent d1190f8299
commit 80805c069d
6 changed files with 435 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
src/api/api.go
View File

@@ -72,6 +72,10 @@ type SendMessageV2 struct {
Base64Attachments []string `json:"base64_attachments"`
}
type TypingIndicatorRequest struct {
Recipient string `json:"recipient"`
}
type Error struct {
Msg string `json:"error"`
}
@@ -885,3 +889,69 @@ func (a *Api) QuitGroup(c *gin.Context) {
}
c.Status(http.StatusNoContent)
}
// @Summary Show Typing Indicator.
// @Tags Messages
// @Description Show Typing Indicator.
// @Accept json
// @Produce json
// @Success 201 {string} OK
// @Failure 400 {object} Error
// @Param number path string true "Registered Phone Number"
// @Param data body TypingIndicatorRequest true "Type"
// @Router /v1/typing-indicator/{number} [put]
func (a *Api) SendStartTyping(c *gin.Context) {
var req TypingIndicatorRequest
err := c.BindJSON(&req)
if err != nil {
c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
log.Error(err.Error())
return
}
number := c.Param("number")
if number == "" {
c.JSON(400, Error{Msg: "Couldn't process request - number missing"})
return
}
err = a.signalClient.SendStartTyping(number, req.Recipient)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
c.Status(http.StatusNoContent)
}
// @Summary Hide Typing Indicator.
// @Tags Messages
// @Description Hide Typing Indicator.
// @Accept json
// @Produce json
// @Success 201 {string} OK
// @Failure 400 {object} Error
// @Param number path string true "Registered Phone Number"
// @Param data body TypingIndicatorRequest true "Type"
// @Router /v1/typing-indicator/{number} [delete]
func (a *Api) SendStopTyping(c *gin.Context) {
var req TypingIndicatorRequest
err := c.BindJSON(&req)
if err != nil {
c.JSON(400, Error{Msg: "Couldn't process request - invalid request"})
log.Error(err.Error())
return
}
number := c.Param("number")
if number == "" {
c.JSON(400, Error{Msg: "Couldn't process request - number missing"})
return
}
err = a.signalClient.SendStopTyping(number, req.Recipient)
if err != nil {
c.JSON(400, Error{Msg: err.Error()})
return
}
c.Status(http.StatusNoContent)
}

85
src/client/client.go
View File

@@ -994,3 +994,88 @@ func (s *SignalClient) QuitGroup(number string, groupId string) error {
}
return err
}
func (s *SignalClient) SendStartTyping(number string, recipient string) error {
var err error
recp := recipient
isGroup := false
if strings.HasPrefix(recipient, groupPrefix) {
isGroup = true
recp, err = ConvertGroupIdToInternalGroupId(recipient)
if err != nil {
return errors.New("Invalid group id")
}
}
if s.signalCliMode == JsonRpc {
type Request struct {
Recipient string `json:"recipient,omitempty"`
GroupId string `json:"group-id,omitempty"`
}
request := Request{}
if !isGroup {
request.Recipient = recp
} else {
request.GroupId = recp
}
jsonRpc2Client, err := s.getJsonRpc2Client(number)
if err != nil {
return err
}
_, err = jsonRpc2Client.getRaw("sendTyping", request)
} else {
cmd := []string{"--config", s.signalCliConfig, "-u", number, "sendTyping"}
if !isGroup {
cmd = append(cmd, recp)
} else {
cmd = append(cmd, []string{"-g", recp}...)
}
_, err = runSignalCli(true, cmd, "", s.signalCliMode)
}
return err
}
func (s *SignalClient) SendStopTyping(number string, recipient string) error {
var err error
recp := recipient
isGroup := false
if strings.HasPrefix(recipient, groupPrefix) {
isGroup = true
recp, err = ConvertGroupIdToInternalGroupId(recipient)
if err != nil {
return errors.New("Invalid group id")
}
}
if s.signalCliMode == JsonRpc {
type Request struct {
Recipient string `json:"recipient,omitempty"`
GroupId string `json:"group-id,omitempty"`
Stop bool `json:"stop"`
}
request := Request{Stop: true}
if !isGroup {
request.Recipient = recp
} else {
request.GroupId = recp
}
jsonRpc2Client, err := s.getJsonRpc2Client(number)
if err != nil {
return err
}
_, err = jsonRpc2Client.getRaw("sendTyping", request)
} else {
cmd := []string{"--config", s.signalCliConfig, "-u", number, "sendTyping", "--stop"}
if !isGroup {
cmd = append(cmd, recp)
} else {
cmd = append(cmd, []string{"-g", recp}...)
}
_, err = runSignalCli(true, cmd, "", s.signalCliMode)
}
return err
}

103
src/docs/docs.go
View File

@@ -876,6 +876,98 @@ var doc = `{
}
}
},
"/v1/typing-indicator/{number}": {
"put": {
"description": "Show Typing Indicator.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Messages"
],
"summary": "Show Typing Indicator.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Type",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.TypingIndicatorRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
},
"delete": {
"description": "Hide Typing Indicator.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Messages"
],
"summary": "Hide Typing Indicator.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Type",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.TypingIndicatorRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v2/send": {
"post": {
"description": "Send a signal message",
@@ -1072,6 +1164,14 @@ var doc = `{
}
}
},
"api.TypingIndicatorRequest": {
"type": "object",
"properties": {
"recipient": {
"type": "string"
}
}
},
"api.UpdateProfileRequest": {
"type": "object",
"properties": {
@@ -1097,6 +1197,9 @@ var doc = `{
"build": {
"type": "integer"
},
"mode": {
"type": "string"
},
"versions": {
"type": "array",
"items": {

103
src/docs/swagger.json
View File

@@ -861,6 +861,98 @@
}
}
},
"/v1/typing-indicator/{number}": {
"put": {
"description": "Show Typing Indicator.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Messages"
],
"summary": "Show Typing Indicator.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Type",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.TypingIndicatorRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
},
"delete": {
"description": "Hide Typing Indicator.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Messages"
],
"summary": "Hide Typing Indicator.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Type",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.TypingIndicatorRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v2/send": {
"post": {
"description": "Send a signal message",
@@ -1057,6 +1149,14 @@
}
}
},
"api.TypingIndicatorRequest": {
"type": "object",
"properties": {
"recipient": {
"type": "string"
}
}
},
"api.UpdateProfileRequest": {
"type": "object",
"properties": {
@@ -1082,6 +1182,9 @@
"build": {
"type": "integer"
},
"mode": {
"type": "string"
},
"versions": {
"type": "array",
"items": {

68
src/docs/swagger.yaml
View File

@@ -101,6 +101,11 @@ definitions:
verified_safety_number:
type: string
type: object
api.TypingIndicatorRequest:
properties:
recipient:
type: string
type: object
api.UpdateProfileRequest:
properties:
base64_avatar:
@@ -117,6 +122,8 @@ definitions:
properties:
build:
type: integer
mode:
type: string
versions:
items:
type: string
@@ -731,6 +738,67 @@ paths:
summary: Send a signal message.
tags:
- Messages
/v1/typing-indicator/{number}:
delete:
consumes:
- application/json
description: Hide Typing Indicator.
parameters:
- description: Registered Phone Number
in: path
name: number
required: true
type: string
- description: Type
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.TypingIndicatorRequest'
produces:
- application/json
responses:
"201":
description: Created
schema:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Hide Typing Indicator.
tags:
- Messages
put:
consumes:
- application/json
description: Show Typing Indicator.
parameters:
- description: Registered Phone Number
in: path
name: number
required: true
type: string
- description: Type
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.TypingIndicatorRequest'
produces:
- application/json
responses:
"201":
description: Created
schema:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Show Typing Indicator.
tags:
- Messages
/v2/send:
post:
consumes:

6
src/main.go
View File

@@ -190,6 +190,12 @@ func main() {
identities.GET(":number", api.ListIdentities)
identities.PUT(":number/trust/:numbertotrust", api.TrustIdentity)
}
typingIndicator := v1.Group("typing-indicator")
{
typingIndicator.PUT(":number", api.SendStartTyping)
typingIndicator.DELETE(":number", api.SendStopTyping)
}
}
v2 := router.Group("/v2")