Skip to content

Send and receive SMS messages using your Android phone programmatically via a simple HTTP API

Add ability to bulk delete messages and threads. closes #434

Acho Arnold4cb1c0254874
diff --git a/api/docs/docs.go b/api/docs/docs.go
index 6665cb2c..fa55086e 100644
--- a/api/docs/docs.go
+++ b/api/docs/docs.go
@@ -1313,6 +1313,89 @@ const docTemplate = `{
}
}
},
+ "/messages/search": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "This returns the list of all messages based on the filter criteria including missed calls",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Search all messages of a user",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "+18005550199,+18005550100",
+ "description": "the owner's phone numbers",
+ "name": "owners",
+ "in": "query",
+ "required": true
+ },
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of messages to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter messages containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 200,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of messages to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessagesResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
+ },
"/messages/send": {
"post": {
"security": [
@@ -1930,6 +2013,68 @@ const docTemplate = `{
}
}
},
+ "/users/{userID}/api-keys": {
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Rotate the user's API key in case the current API Key is compromised",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Rotate the user's API Key",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the user to update",
+ "name": "userID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.UserResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
+ },
"/users/{userID}/notifications": {
"put": {
"security": [
@@ -3133,7 +3278,7 @@ const docTemplate = `{
},
"missed_call_auto_reply": {
"type": "string",
- "example": "e.g This phone cannot receive calls. Please send an SMS instead."
+ "example": "e.g. This phone cannot receive calls. Please send an SMS instead."
},
"phone_number": {
"type": "string",
@@ -3724,7 +3869,7 @@ var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "api.httpsms.com",
BasePath: "/v1",
- Schemes: []string{"http", "https"},
+ Schemes: []string{"https"},
Title: "HTTP SMS API",
Description: "API to send SMS messages using android [SmsManager](https://developer.android.com/reference/android/telephony/SmsManager) via HTTP",
InfoInstanceName: "swagger",
diff --git a/api/docs/swagger.json b/api/docs/swagger.json
index a7fff945..16182844 100644
--- a/api/docs/swagger.json
+++ b/api/docs/swagger.json
@@ -1,5 +1,5 @@
{
- "schemes": ["http", "https"],
+ "schemes": ["https"],
"swagger": "2.0",
"info": {
"description": "API to send SMS messages using android [SmsManager](https://developer.android.com/reference/android/telephony/SmsManager) via HTTP",
@@ -1187,6 +1187,83 @@
}
}
},
+ "/messages/search": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "This returns the list of all messages based on the filter criteria including missed calls",
+ "consumes": ["application/json"],
+ "produces": ["application/json"],
+ "tags": ["Messages"],
+ "summary": "Search all messages of a user",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "+18005550199,+18005550100",
+ "description": "the owner's phone numbers",
+ "name": "owners",
+ "in": "query",
+ "required": true
+ },
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of messages to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter messages containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 200,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of messages to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessagesResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
+ },
"/messages/send": {
"post": {
"security": [
@@ -1748,6 +1825,62 @@
}
}
},
+ "/users/{userID}/api-keys": {
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Rotate the user's API key in case the current API Key is compromised",
+ "consumes": ["application/json"],
+ "produces": ["application/json"],
+ "tags": ["Users"],
+ "summary": "Rotate the user's API Key",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the user to update",
+ "name": "userID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.UserResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
+ },
"/users/{userID}/notifications": {
"put": {
"security": [
@@ -2868,7 +3001,7 @@
},
"missed_call_auto_reply": {
"type": "string",
- "example": "e.g This phone cannot receive calls. Please send an SMS instead."
+ "example": "e.g. This phone cannot receive calls. Please send an SMS instead."
},
"phone_number": {
"type": "string",
diff --git a/api/docs/swagger.yaml b/api/docs/swagger.yaml
index 564e8c22..86853745 100644
--- a/api/docs/swagger.yaml
+++ b/api/docs/swagger.yaml
@@ -682,7 +682,7 @@ definitions:
example: 1
type: integer
missed_call_auto_reply:
- example: e.g This phone cannot receive calls. Please send an SMS instead.
+ example: e.g. This phone cannot receive calls. Please send an SMS instead.
type: string
phone_number:
example: "+18005550199"
@@ -2068,6 +2068,63 @@ paths:
summary: Receive a new SMS message from a mobile phone
tags:
- Messages
+ /messages/search:
+ get:
+ consumes:
+ - application/json
+ description:
+ This returns the list of all messages based on the filter criteria
+ including missed calls
+ parameters:
+ - default: +18005550199,+18005550100
+ description: the owner's phone numbers
+ in: query
+ name: owners
+ required: true
+ type: string
+ - description: number of messages to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: filter messages containing query
+ in: query
+ name: query
+ type: string
+ - description: number of messages to return
+ in: query
+ maximum: 200
+ minimum: 1
+ name: limit
+ type: integer
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: OK
+ schema:
+ $ref: "#/definitions/responses.MessagesResponse"
+ "400":
+ description: Bad Request
+ schema:
+ $ref: "#/definitions/responses.BadRequest"
+ "401":
+ description: Unauthorized
+ schema:
+ $ref: "#/definitions/responses.Unauthorized"
+ "422":
+ description: Unprocessable Entity
+ schema:
+ $ref: "#/definitions/responses.UnprocessableEntity"
+ "500":
+ description: Internal Server Error
+ schema:
+ $ref: "#/definitions/responses.InternalServerError"
+ security:
+ - ApiKeyAuth: []
+ summary: Search all messages of a user
+ tags:
+ - Messages
/messages/send:
post:
consumes:
@@ -2240,6 +2297,46 @@ paths:
summary: Delete Phone
tags:
- Phones
+ /users/{userID}/api-keys:
+ delete:
+ consumes:
+ - application/json
+ description: Rotate the user's API key in case the current API Key is compromised
+ parameters:
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the user to update
+ in: path
+ name: userID
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: OK
+ schema:
+ $ref: "#/definitions/responses.UserResponse"
+ "400":
+ description: Bad Request
+ schema:
+ $ref: "#/definitions/responses.BadRequest"
+ "401":
+ description: Unauthorized
+ schema:
+ $ref: "#/definitions/responses.Unauthorized"
+ "422":
+ description: Unprocessable Entity
+ schema:
+ $ref: "#/definitions/responses.UnprocessableEntity"
+ "500":
+ description: Internal Server Error
+ schema:
+ $ref: "#/definitions/responses.InternalServerError"
+ security:
+ - ApiKeyAuth: []
+ summary: Rotate the user's API Key
+ tags:
+ - Users
/users/{userID}/notifications:
put:
consumes:
@@ -2594,7 +2691,6 @@ paths:
tags:
- Webhooks
schemes:
- - http
- https
securityDefinitions:
ApiKeyAuth:
diff --git a/api/pkg/di/container.go b/api/pkg/di/container.go
index 6af05934..c724e6d4 100644
--- a/api/pkg/di/container.go
+++ b/api/pkg/di/container.go
@@ -21,7 +21,7 @@ import (
mexporter "github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric"
cloudtrace "github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace"
"github.com/NdoleStudio/httpsms/pkg/cache"
- lemonsqueezy "github.com/NdoleStudio/lemonsqueezy-go"
+ "github.com/NdoleStudio/lemonsqueezy-go"
"github.com/hashicorp/go-retryablehttp"
"github.com/redis/go-redis/extra/redisotel/v9"
"github.com/redis/go-redis/v9"
diff --git a/api/pkg/events/message_api_deleted_event.go b/api/pkg/events/message_api_deleted_event.go
index 49842830..e0de354f 100644
--- a/api/pkg/events/message_api_deleted_event.go
+++ b/api/pkg/events/message_api_deleted_event.go
@@ -13,13 +13,16 @@ const MessageAPIDeleted = "message.api.deleted"
// MessageAPIDeletedPayload is the payload of the MessageAPIDeleted event
type MessageAPIDeletedPayload struct {
- MessageID uuid.UUID `json:"message_id"`
- UserID entities.UserID `json:"user_id"`
- Owner string `json:"owner"`
- RequestID *string `json:"request_id"`
- Contact string `json:"contact"`
- Timestamp time.Time `json:"timestamp"`
- Content string `json:"content"`
- Encrypted bool `json:"encrypted"`
- SIM entities.SIM `json:"sim"`
+ MessageID uuid.UUID `json:"message_id"`
+ UserID entities.UserID `json:"user_id"`
+ Owner string `json:"owner"`
+ RequestID *string `json:"request_id"`
+ Contact string `json:"contact"`
+ Timestamp time.Time `json:"timestamp"`
+ Content string `json:"content"`
+ Encrypted bool `json:"encrypted"`
+ PreviousMessageID *uuid.UUID `json:"previous_message_id"`
+ PreviousMessageStatus *entities.MessageStatus `json:"previous_message_status"`
+ PreviousMessageContent *string `json:"previous_message_content"`
+ SIM entities.SIM `json:"sim"`
}
diff --git a/api/pkg/handlers/message_handler.go b/api/pkg/handlers/message_handler.go
index d7502281..e7729499 100644
--- a/api/pkg/handlers/message_handler.go
+++ b/api/pkg/handlers/message_handler.go
@@ -55,6 +55,7 @@ func (h *MessageHandler) RegisterRoutes(router fiber.Router) {
router.Post("/messages/calls/missed", h.PostCallMissed)
router.Get("/messages/outstanding", h.GetOutstanding)
router.Get("/messages", h.Index)
+ router.Get("/messages/search", h.Search)
router.Post("/messages/:messageID/events", h.PostEvent)
router.Delete("/messages/:messageID", h.Delete)
}
@@ -462,3 +463,49 @@ func (h *MessageHandler) PostCallMissed(c *fiber.Ctx) error {
return h.responseOK(c, "missed call event stored successfully", message)
}
+
+// Search returns a filtered list of messages of a user
+// @Summary Search all messages of a user
+// @Description This returns the list of all messages based on the filter criteria including missed calls
+// @Security ApiKeyAuth
+// @Tags Messages
+// @Accept json
+// @Produce json
+// @Param owners query string true "the owner's phone numbers" default(+18005550199,+18005550100)
+// @Param skip query int false "number of messages to skip" minimum(0)
+// @Param query query string false "filter messages containing query"
+// @Param limit query int false "number of messages to return" minimum(1) maximum(200)
+// @Success 200 {object} responses.MessagesResponse
+// @Failure 400 {object} responses.BadRequest
+// @Failure 401 {object} responses.Unauthorized
+// @Failure 422 {object} responses.UnprocessableEntity
+// @Failure 500 {object} responses.InternalServerError
+// @Router /messages/search [get]
+func (h *MessageHandler) Search(c *fiber.Ctx) error {
+ ctx, span := h.tracer.StartFromFiberCtx(c)
+ defer span.End()
+
+ ctxLogger := h.tracer.CtxLogger(h.logger, span)
+
+ var request requests.MessageSearch
+ if err := c.QueryParser(&request); err != nil {
+ msg := fmt.Sprintf("cannot marshall params in [%s] into [%T]", c.OriginalURL(), request)
+ ctxLogger.Warn(stacktrace.Propagate(err, msg))
+ return h.responseBadRequest(c, err)
+ }
+
+ if errors := h.validator.ValidateMessageSearch(ctx, request.Sanitize()); len(errors) != 0 {
+ msg := fmt.Sprintf("validation errors [%s], while searching messages [%+#v]", spew.Sdump(errors), request)
+ ctxLogger.Warn(stacktrace.NewError(msg))
+ return h.responseUnprocessableEntity(c, errors, "validation errors while searching messages")
+ }
+
+ messages, err := h.service.SearchMessages(ctx, request.ToSearchParams(h.userIDFomContext(c)))
+ if err != nil {
+ msg := fmt.Sprintf("cannot search messages with params [%+#v]", request)
+ ctxLogger.Error(stacktrace.Propagate(err, msg))
+ return h.responseInternalServerError(c)
+ }
+
+ return h.responseOK(c, fmt.Sprintf("found %d %s", len(messages), h.pluralize("message", len(messages))), messages)
+}
diff --git a/api/pkg/listeners/message_thread_listener.go b/api/pkg/listeners/message_thread_listener.go
index 4bad67d1..2fb9f5a0 100644
--- a/api/pkg/listeners/message_thread_listener.go
+++ b/api/pkg/listeners/message_thread_listener.go
@@ -79,13 +79,13 @@ func (listener *MessageThreadListener) onMessageDeleted(ctx context.Context, eve
ctx, span := listener.tracer.Start(ctx)
defer span.End()
- var payload events.MessageAPIDeletedPayload
- if err := event.DataAs(&payload); err != nil {
+ payload := new(events.MessageAPIDeletedPayload)
+ if err := event.DataAs(payload); err != nil {
msg := fmt.Sprintf("cannot decode [%s] into [%T]", event.Data(), payload)
return listener.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
- if err := listener.service.UpdateAfterDeletedMessage(ctx, payload.UserID, payload.MessageID); err != nil {
+ if err := listener.service.UpdateAfterDeletedMessage(ctx, payload); err != nil {
msg := fmt.Sprintf("cannot update thread for message with ID [%s] for event with ID [%s]", payload.MessageID, event.ID())
return listener.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
diff --git a/api/pkg/repositories/gorm_message_repository.go b/api/pkg/repositories/gorm_message_repository.go
index 60a0284e..0fc4e7e0 100644
--- a/api/pkg/repositories/gorm_message_repository.go
+++ b/api/pkg/repositories/gorm_message_repository.go
@@ -92,6 +92,78 @@ func (repository *gormMessageRepository) Index(ctx context.Context, userID entit
return messages, nil
}
+func (repository *gormMessageRepository) LastMessage(ctx context.Context, userID entities.UserID, owner string, contact string) (*entities.Message, error) {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ query := repository.db.
+ WithContext(ctx).
+ Where("user_id = ?", userID).
+ Where("owner = ?", owner).
+ Where("contact = ?", contact)
+
+ message := new(entities.Message)
+
+ err := query.Order("order_timestamp DESC").First(&message).Error
+ if errors.Is(err, gorm.ErrRecordNotFound) {
+ msg := fmt.Sprintf("cannot get last message for [%s] with owner [%s] and contact [%s]", userID, owner, contact)
+ return nil, repository.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCode(err, ErrCodeNotFound, msg))
+ }
+
+ if err != nil {
+ msg := fmt.Sprintf("cannot get last message for [%s] with owner [%s] and contact [%s]", userID, owner, contact)
+ return nil, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return message, nil
+}
+
+func (repository *gormMessageRepository) Search(ctx context.Context, userID entities.UserID, owners []string, types []entities.MessageType, statuses []entities.MessageStatus, params IndexParams) ([]*entities.Message, error) {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ query := repository.db.
+ WithContext(ctx).
+ Where("user_id = ?", userID)
+
+ if len(owners) > 0 {
+ query = query.Where("owner IN ?", owners)
+ }
+ if len(types) > 0 {
+ query = query.Where("type IN ?", types)
+ }
+ if len(statuses) > 0 {
+ query = query.Where("status IN ?", statuses)
+ }
+
+ if len(params.Query) > 0 {
+ queryPattern := "%" + params.Query + "%"
+ subQuery := repository.db.Where("content ILIKE ?", queryPattern).
+ Or("contact ILIKE ?", queryPattern).
+ Or("failure_reason ILIKE ?", queryPattern).
+ Or("request_id ILIKE ?", queryPattern)
+
+ if _, err := uuid.Parse(params.Query); err == nil {
+ subQuery = subQuery.Or("id = ?", params.Query)
+ }
+
+ query = query.Where(subQuery)
+ }
+
+ messages := make([]*entities.Message, 0, params.Limit)
+ err := query.Order(repository.order(params, "created_at")).
+ Limit(params.Limit).
+ Offset(params.Skip).
+ Find(&messages).
+ Error
+ if err != nil {
+ msg := fmt.Sprintf("cannot search messages with for user [%s] params [%+#v]", userID, params)
+ return nil, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return messages, nil
+}
+
// Store a new entities.Message
func (repository *gormMessageRepository) Store(ctx context.Context, message *entities.Message) error {
ctx, span := repository.tracer.Start(ctx)
@@ -171,3 +243,17 @@ func (repository *gormMessageRepository) GetOutstanding(ctx context.Context, use
return message, nil
}
+
+func (repository *gormMessageRepository) order(params IndexParams, defaultSortBy string) string {
+ sortBy := defaultSortBy
+ if len(params.SortBy) > 0 {
+ sortBy = params.SortBy
+ }
+
+ direction := "ASC"
+ if params.SortDescending {
+ direction = "DESC"
+ }
+
+ return fmt.Sprintf("%s %s", sortBy, direction)
+}
diff --git a/api/pkg/repositories/message_repository.go b/api/pkg/repositories/message_repository.go
index fced76ca..971aecde 100644
--- a/api/pkg/repositories/message_repository.go
+++ b/api/pkg/repositories/message_repository.go
@@ -21,6 +21,12 @@ type MessageRepository interface {
// Index entities.Message between 2 phone numbers
Index(ctx context.Context, userID entities.UserID, owner string, contact string, params IndexParams) (*[]entities.Message, error)
+ // LastMessage fetches the last message between an owner and a contact
+ LastMessage(ctx context.Context, userID entities.UserID, owner string, contact string) (*entities.Message, error)
+
+ // Search entities.Message for a user
+ Search(ctx context.Context, userID entities.UserID, owners []string, types []entities.MessageType, statuses []entities.MessageStatus, params IndexParams) ([]*entities.Message, error)
+
// GetOutstanding fetches an entities.Message which is outstanding
GetOutstanding(ctx context.Context, userID entities.UserID, messageID uuid.UUID) (*entities.Message, error)
diff --git a/api/pkg/repositories/repository.go b/api/pkg/repositories/repository.go
index 88dd8660..32ba4337 100644
--- a/api/pkg/repositories/repository.go
+++ b/api/pkg/repositories/repository.go
@@ -8,9 +8,11 @@ import (
// IndexParams parameters for indexing a database table
type IndexParams struct {
- Skip int `json:"skip"`
- Query string `json:"query"`
- Limit int `json:"take"`
+ Skip int `json:"skip"`
+ SortBy string `json:"sort"`
+ SortDescending bool `json:"sort_descending"`
+ Query string `json:"query"`
+ Limit int `json:"take"`
}
const (
diff --git a/api/pkg/requests/message_search_request.go b/api/pkg/requests/message_search_request.go
new file mode 100644
index 00000000..358f9350
--- /dev/null
+++ b/api/pkg/requests/message_search_request.go
@@ -0,0 +1,67 @@
+package requests
+
+import (
+ "strings"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+
+ "github.com/NdoleStudio/httpsms/pkg/repositories"
+
+ "github.com/NdoleStudio/httpsms/pkg/services"
+)
+
+// MessageSearch is the payload fetching entities.Message
+type MessageSearch struct {
+ request
+ Skip string `json:"skip" query:"skip"`
+ Owners []string `json:"owners" query:"owners"`
+ Types []string `json:"types" query:"types"`
+ Statuses []string `json:"statuses" query:"statuses"`
+ Query string `json:"query" query:"query"`
+ SortBy string `json:"sort_by" query:"sort_by"`
+ SortDescending bool `json:"sort_descending" query:"sort_descending"`
+ Limit string `json:"limit" query:"limit"`
+}
+
+// Sanitize sets defaults to MessageSearch
+func (input *MessageSearch) Sanitize() MessageSearch {
+ if strings.TrimSpace(input.Limit) == "" {
+ input.Limit = "100"
+ }
+
+ input.Query = strings.TrimSpace(input.Query)
+
+ input.Skip = strings.TrimSpace(input.Skip)
+ if input.Skip == "" {
+ input.Skip = "0"
+ }
+
+ return *input
+}
+
+// ToSearchParams converts request to services.MessageSearchParams
+func (input *MessageSearch) ToSearchParams(userID entities.UserID) *services.MessageSearchParams {
+ var types []entities.MessageType
+ for _, t := range input.Types {
+ types = append(types, entities.MessageType(t))
+ }
+
+ var statuses []entities.MessageStatus
+ for _, s := range input.Statuses {
+ statuses = append(statuses, entities.MessageStatus(s))
+ }
+
+ return &services.MessageSearchParams{
+ IndexParams: repositories.IndexParams{
+ Skip: input.getInt(input.Skip),
+ Query: input.Query,
+ SortBy: input.SortBy,
+ SortDescending: input.SortDescending,
+ Limit: input.getInt(input.Limit),
+ },
+ UserID: userID,
+ Owners: input.Owners,
+ Types: types,
+ Statuses: statuses,
+ }
+}
diff --git a/api/pkg/services/message_service.go b/api/pkg/services/message_service.go
index d28f3124..155a4d0a 100644
--- a/api/pkg/services/message_service.go
+++ b/api/pkg/services/message_service.go
@@ -106,16 +106,29 @@ func (service *MessageService) DeleteMessage(ctx context.Context, source string,
return service.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCode(err, stacktrace.GetCode(err), msg))
}
+ var prevID *uuid.UUID
+ var prevStatus *entities.MessageStatus
+ var prevContent *string
+ previousMessage, err := service.repository.LastMessage(ctx, message.UserID, message.Owner, message.Contact)
+ if err == nil {
+ prevID = &previousMessage.ID
+ prevStatus = &previousMessage.Status
+ prevContent = &previousMessage.Content
+ }
+
event, err := service.createEvent(events.MessageAPIDeleted, source, &events.MessageAPIDeletedPayload{
- MessageID: message.ID,
- UserID: message.UserID,
- Owner: message.Owner,
- Encrypted: message.Encrypted,
- RequestID: message.RequestID,
- Contact: message.Contact,
- Timestamp: time.Now().UTC(),
- Content: message.Content,
- SIM: message.SIM,
+ MessageID: message.ID,
+ UserID: message.UserID,
+ Owner: message.Owner,
+ Encrypted: message.Encrypted,
+ RequestID: message.RequestID,
+ Contact: message.Contact,
+ Timestamp: time.Now().UTC(),
+ Content: message.Content,
+ PreviousMessageID: prevID,
+ PreviousMessageStatus: prevStatus,
+ PreviousMessageContent: prevContent,
+ SIM: message.SIM,
})
if err != nil {
msg := fmt.Sprintf("cannot create [%T] for message with ID [%s]", event, message.ID)
@@ -880,6 +893,32 @@ func (service *MessageService) CheckExpired(ctx context.Context, params MessageC
return nil
}
+// MessageSearchParams are parameters for searching messages
+type MessageSearchParams struct {
+ repositories.IndexParams
+ UserID entities.UserID
+ Owners []string
+ Types []entities.MessageType
+ Statuses []entities.MessageStatus
+}
+
+// SearchMessages fetches all the messages for a user
+func (service *MessageService) SearchMessages(ctx context.Context, params *MessageSearchParams) ([]*entities.Message, error) {
+ ctx, span := service.tracer.Start(ctx)
+ defer span.End()
+
+ ctxLogger := service.tracer.CtxLogger(service.logger, span)
+
+ messages, err := service.repository.Search(ctx, params.UserID, params.Owners, params.Types, params.Statuses, params.IndexParams)
+ if err != nil {
+ msg := fmt.Sprintf("could not search messages with parms [%+#v]", params)
+ return nil, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ ctxLogger.Info(fmt.Sprintf("fetched [%d] messages with prams [%+#v]", len(messages), params))
+ return messages, nil
+}
+
func (service *MessageService) phoneSettings(ctx context.Context, userID entities.UserID, owner string) (uint, entities.SIM) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
diff --git a/api/pkg/services/message_thread_service.go b/api/pkg/services/message_thread_service.go
index cdf1eba6..18553c01 100644
--- a/api/pkg/services/message_thread_service.go
+++ b/api/pkg/services/message_thread_service.go
@@ -117,16 +117,44 @@ func (service *MessageThreadService) UpdateStatus(ctx context.Context, params Me
}
// UpdateAfterDeletedMessage updates a thread after the last message has been deleted
-func (service *MessageThreadService) UpdateAfterDeletedMessage(ctx context.Context, userID entities.UserID, messageID uuid.UUID) error {
+func (service *MessageThreadService) UpdateAfterDeletedMessage(ctx context.Context, payload *events.MessageAPIDeletedPayload) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
- if err := service.repository.UpdateAfterDeletedMessage(ctx, userID, messageID); err != nil {
- msg := fmt.Sprintf("cannot delete last message from thread with messageID [%s] and userID [%s]", messageID, userID)
+ thread, err := service.repository.LoadByOwnerContact(ctx, payload.UserID, payload.Owner, payload.Contact)
+ if err != nil {
+ msg := fmt.Sprintf("cannot find thread for user [%s] with owner [%s], and contact [%s]", payload.UserID, payload.Owner, payload.Contact)
+ return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ if payload.PreviousMessageID == nil {
+ if err = service.repository.Delete(ctx, thread.UserID, thread.ID); err != nil {
+ msg := fmt.Sprintf("cannot delete thread with ID [%s] for user [%s] and owner [%s]", thread.ID, thread.UserID, thread.Owner)
+ ctxLogger.Error(stacktrace.Propagate(err, msg))
+ return nil
+ }
+ msg := fmt.Sprintf("previous message ID is nil for thread with ID [%s] and user [%s]", thread.ID, thread.UserID)
+ ctxLogger.Info(msg)
+ return nil
+ }
+
+ if thread.LastMessageID != nil && *thread.LastMessageID != payload.MessageID {
+ msg := fmt.Sprintf("last message ID [%s] does not match message ID [%s] for thread with ID [%s]", *thread.LastMessageID, payload.MessageID, thread.ID)
+ ctxLogger.Info(msg)
+ return nil
+ }
+
+ thread.LastMessageContent = payload.PreviousMessageContent
+ thread.LastMessageID = payload.PreviousMessageID
+ thread.Status = *payload.PreviousMessageStatus
+ thread.UpdatedAt = time.Now().UTC()
+
+ if err = service.repository.Update(ctx, thread); err != nil {
+ msg := fmt.Sprintf("cannot update thread with ID [%s] for user with ID [%s]", thread.ID, thread.UserID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
- ctxLogger.Info(fmt.Sprintf("last message has been removed from thread with messageID [%s] and userID [%s]", messageID, userID))
+ ctxLogger.Info(fmt.Sprintf("last message has been removed from thread with ID [%s] and userID [%s]", thread.ID, thread.UserID))
return nil
}
diff --git a/api/pkg/validators/message_handler_validator.go b/api/pkg/validators/message_handler_validator.go
index 799a4d33..3d8b5a1d 100644
--- a/api/pkg/validators/message_handler_validator.go
+++ b/api/pkg/validators/message_handler_validator.go
@@ -207,6 +207,59 @@ func (validator MessageHandlerValidator) ValidateMessageIndex(_ context.Context,
return v.ValidateStruct()
}
+// ValidateMessageSearch validates the requests.MessageSearch request
+func (validator MessageHandlerValidator) ValidateMessageSearch(_ context.Context, request requests.MessageSearch) url.Values {
+ v := govalidator.New(govalidator.Options{
+ Data: &request,
+ Rules: govalidator.MapData{
+ "owners": []string{
+ multipleContactPhoneNumberRule,
+ },
+ "types": []string{
+ multipleInRule + ":" + strings.Join([]string{
+ entities.MessageTypeCallMissed,
+ entities.MessageTypeMobileOriginated,
+ entities.MessageTypeMobileTerminated,
+ }, ","),
+ },
+ "statuses": []string{
+ multipleInRule + ":" + strings.Join([]string{
+ entities.MessageStatusPending,
+ entities.MessageStatusSent,
+ entities.MessageStatusDelivered,
+ entities.MessageStatusFailed,
+ entities.MessageStatusExpired,
+ entities.MessageStatusReceived,
+ }, ","),
+ },
+ "sort_by": []string{
+ "in:" + strings.Join([]string{
+ "created_at",
+ "owner",
+ "contact",
+ "type",
+ "status",
+ }, ","),
+ },
+ "limit": []string{
+ "required",
+ "numeric",
+ "min:1",
+ "max:200",
+ },
+ "skip": []string{
+ "required",
+ "numeric",
+ "min:0",
+ },
+ "query": []string{
+ "max:100",
+ },
+ },
+ })
+ return v.ValidateStruct()
+}
+
// ValidateMessageEvent validates the requests.MessageEvent request
func (validator MessageHandlerValidator) ValidateMessageEvent(_ context.Context, request requests.MessageEvent) url.Values {
v := govalidator.New(govalidator.Options{
diff --git a/api/pkg/validators/validator.go b/api/pkg/validators/validator.go
index d6f8cb01..12a1a015 100644
--- a/api/pkg/validators/validator.go
+++ b/api/pkg/validators/validator.go
@@ -5,6 +5,7 @@ import (
"fmt"
"net/url"
"regexp"
+ "strings"
"github.com/NdoleStudio/httpsms/pkg/events"
@@ -18,6 +19,7 @@ const (
phoneNumberRule = "phoneNumber"
contactPhoneNumberRule = "contactPhoneNumber"
multipleContactPhoneNumberRule = "multipleContactPhoneNumber"
+ multipleInRule = "multipleIn"
webhookEventsRule = "webhookEvents"
)
@@ -68,6 +70,31 @@ func init() {
return nil
})
+ govalidator.AddCustomRule(multipleInRule, func(field string, rule string, message string, value interface{}) error {
+ values, ok := value.([]string)
+ if !ok {
+ return fmt.Errorf("the %s field must be a string array", field)
+ }
+
+ allowlist := strings.Split(strings.TrimPrefix(rule, multipleInRule+":"), ",")
+ contains := func(str string) bool {
+ for _, a := range allowlist {
+ if a == str {
+ return true
+ }
+ }
+ return false
+ }
+
+ for index, item := range values {
+ if !contains(item) {
+ return fmt.Errorf("the %s field in contains an invalid value [%s] at index [%d] ", field, item, index)
+ }
+ }
+
+ return nil
+ })
+
govalidator.AddCustomRule(webhookEventsRule, func(field string, rule string, message string, value interface{}) error {
input, ok := value.([]string)
if !ok {
diff --git a/web/components/MessageThreadHeader.vue b/web/components/MessageThreadHeader.vue
index 2086354d..f41e7509 100644
--- a/web/components/MessageThreadHeader.vue
+++ b/web/components/MessageThreadHeader.vue
@@ -135,6 +135,22 @@
</v-list-item-title>
</v-list-item-content>
</v-list-item>
+ <v-list-item
+ v-if="$store.getters.getOwner"
+ :to="{ name: 'search-messages' }"
+ exact
+ >
+ <v-list-item-icon class="pl-2">
+ <v-icon dense>{{ mdiMagnify }}</v-icon>
+ </v-list-item-icon>
+ <v-list-item-content class="ml-n3">
+ <v-list-item-title class="pr-16 py-1">
+ <span :class="{ 'pr-16': $vuetify.breakpoint.mdAndUp }">
+ Search Messages
+ </span>
+ </v-list-item-title>
+ </v-list-item-content>
+ </v-list-item>
<v-list-item :to="{ name: 'settings' }" exact>
<v-list-item-icon class="pl-2">
<v-icon dense>{{ mdiAccountCog }}</v-icon>
@@ -211,6 +227,7 @@ import {
mdiPackageUp,
mdiPackageDown,
mdiDotsVertical,
+ mdiMagnify,
mdiCommentTextMultipleOutline,
mdiCircle,
} from '@mdi/js'
@@ -231,6 +248,7 @@ export default class MessageThreadHeader extends Vue {
mdiDotsVertical = mdiDotsVertical
mdiCircle = mdiCircle
mdiBatteryCharging = mdiBatteryChargingHigh
+ mdiMagnify = mdiMagnify
get owners(): Array<SelectItem> {
return this.$store.getters.getPhones.map(
diff --git a/web/models/message.ts b/web/models/message.ts
index b8948f93..fa06e4b4 100644
--- a/web/models/message.ts
+++ b/web/models/message.ts
@@ -15,3 +15,14 @@ export interface Message {
type: string
updated_at: string
}
+
+export interface SearchMessagesRequest {
+ owners: string[]
+ types: string[]
+ statuses: string[]
+ query: string
+ sort_by: string
+ sort_descending: boolean
+ skip: number
+ limit: number
+}
diff --git a/web/pages/search-messages/index.vue b/web/pages/search-messages/index.vue
new file mode 100644
index 00000000..4e50e01a
--- /dev/null
+++ b/web/pages/search-messages/index.vue
@@ -0,0 +1,482 @@
+<template>
+ <v-container
+ fluid
+ class="px-0 pt-0"
+ :fill-height="$vuetify.breakpoint.lgAndUp"
+ >
+ <div class="w-full h-full">
+ <v-app-bar height="60" :dense="$vuetify.breakpoint.mdAndDown">
+ <v-btn icon to="/threads">
+ <v-icon>{{ mdiArrowLeft }}</v-icon>
+ </v-btn>
+ <v-toolbar-title>
+ <div class="py-16">Search Messages</div>
+ </v-toolbar-title>
+ <v-progress-linear
+ :active="loading"
+ :indeterminate="loading"
+ absolute
+ bottom
+ ></v-progress-linear>
+ </v-app-bar>
+ <v-container>
+ <v-row>
+ <v-col cols="12">
+ <h5 class="text-h4 mb-3 mt-3">Search Messages</h5>
+ <p>
+ On this page, you can search all your messages by phone number,
+ message type, and message status and even using the content of the
+ SMS message. You will also be able to bulk delete messages and
+ even export your messages in a CSV file.
+ </p>
+ <v-alert v-if="errorTitle" text prominent type="warning">
+ <h6 class="subtitle-1 font-weight-bold">{{ errorTitle }}</h6>
+ </v-alert>
+ </v-col>
+ </v-row>
+ <v-card>
+ <v-card-text class="pt-4 pb-0">
+ <v-row>
+ <v-col cols="4">
+ <v-select
+ v-model="formOwners"
+ :error="errorMessages.has('owners')"
+ :error-messages="errorMessages.get('owners')"
+ :items="phoneNumberSelectItems"
+ multiple
+ dense
+ label="Phone Numbers"
+ outlined
+ ></v-select>
+ </v-col>
+ <v-col cols="4">
+ <v-select
+ v-model="formTypes"
+ :error="errorMessages.has('types')"
+ :error-messages="errorMessages.get('types')"
+ :items="messageTypeSelectItems"
+ dense
+ multiple
+ label="Message Types"
+ outlined
+ ></v-select>
+ </v-col>
+ <v-col cols="4">
+ <v-select
+ v-model="formStatuses"
+ :error="errorMessages.has('statuses')"
+ :error-messages="errorMessages.get('statuses')"
+ :items="messageStatusSelectItems"
+ dense
+ multiple
+ label="Message Status"
+ outlined
+ ></v-select>
+ </v-col>
+ </v-row>
+ <v-row class="mt-n3">
+ <v-col cols="8">
+ <v-text-field
+ v-model="formQuery"
+ :error="errorMessages.has('query')"
+ :error-messages="errorMessages.get('query')"
+ label="Search Query"
+ outlined
+ dense
+ clearable
+ ></v-text-field>
+ </v-col>
+ <v-col cols="4">
+ <v-btn
+ :loading="loading"
+ :disabled="loading"
+ color="primary"
+ class="py-5"
+ @click="fetchMessages"
+ >
+ <v-icon left>{{ mdiMagnify }}</v-icon>
+ Search Messages
+ </v-btn>
+ </v-col>
+ </v-row>
+ </v-card-text>
+ </v-card>
+ <v-row>
+ <v-col cols="12" class="mt-16 mb-n2 d-flex">
+ <h2 class="text-h4">Search Results</h2>
+ <v-dialog
+ v-model="showDeleteDialog"
+ overlay-opacity="0.9"
+ max-width="550"
+ >
+ <template #activator="{ on, attrs }">
+ <v-btn
+ :loading="loading"
+ :disabled="loading || selectedMessages.length < 1"
+ small
+ class="ml-2 mt-2"
+ color="error"
+ v-bind="attrs"
+ v-on="on"
+ >
+ <v-icon left>{{ mdiDelete }}</v-icon>
+ Delete messages
+ </v-btn>
+ </template>
+ <v-card>
+ <v-card-title class="text-h5 text-break">
+ Are you sure you want to delete the
+ {{ selectedMessages.length }} selected messages?
+ </v-card-title>
+ <v-card-text>
+ The messages will be deleted permanently from the httpSMS
+ server and cannot be recovered.
+ </v-card-text>
+ <v-card-actions class="pb-4">
+ <v-btn
+ color="primary"
+ :loading="loading"
+ @click="deleteMessages"
+ >
+ <v-icon left>{{ mdiDelete }}</v-icon>
+ Yes Delete Messages
+ </v-btn>
+ <v-spacer></v-spacer>
+ <v-btn text @click="showDeleteDialog = false"> Close </v-btn>
+ </v-card-actions>
+ </v-card>
+ </v-dialog>
+ <v-spacer></v-spacer>
+ <v-btn
+ :loading="loading"
+ :disabled="loading || selectedMessages.length < 1"
+ small
+ color="primary"
+ class="mt-2"
+ @click="exportMessages"
+ >
+ <v-icon left>{{ mdiExport }}</v-icon>
+ Export to CSV
+ </v-btn>
+ </v-col>
+ <v-col cols="12">
+ <v-data-table
+ v-model="selectedMessages"
+ item-key="id"
+ :headers="headers"
+ :items="messages"
+ :items-per-page="100"
+ :options.sync="options"
+ :server-items-length="totalMessages"
+ :loading="loading"
+ :footer-props="footerProps"
+ show-select
+ loading-text="Loading... Please wait"
+ no-data-text="You don't have any messages yet"
+ class="elevation-1"
+ >
+ <template #[`item.created_at`]="props">
+ {{ props.item.created_at | timestamp }}
+ </template>
+ <template #[`item.owner`]="props">
+ {{ props.item.owner }}
+ </template>
+ <template #[`item.contact`]="props">
+ {{ props.item.contact }}
+ </template>
+ <template #[`item.type`]="props">
+ <span v-if="props.item.type === 'call/missed'">
+ <v-icon small color="error">{{ mdiCallMissed }}</v-icon>
+ missed call
+ </span>
+ <span v-if="props.item.type === 'mobile-terminated'">
+ <v-icon small>{{ mdiCallReceived }}</v-icon>
+ inbound
+ </span>
+ <span v-if="props.item.type === 'mobile-originated'">
+ <v-icon small color="secondary">{{ mdiCallMade }}</v-icon>
+ outbound
+ </span>
+ </template>
+ <template #[`item.status`]="props">
+ <v-chip
+ v-if="props.item.status === 'expired'"
+ color="warning"
+ small
+ outlined
+ >
+ <v-icon small left>{{ mdiAlert }}</v-icon>
+ Expired
+ </v-chip>
+
+ <v-chip
+ v-else-if="props.item.status === 'delivered'"
+ color="primary"
+ small
+ outlined
+ >
+ <v-icon small left>{{ mdiCheckAll }}</v-icon>
+ Delivered
+ </v-chip>
+
+ <v-chip
+ v-else-if="props.item.status === 'received'"
+ color="success"
+ small
+ outlined
+ >
+ <v-icon small left>{{ mdiCheckAll }}</v-icon>
+ Received
+ </v-chip>
+
+ <v-chip v-else-if="props.item.status === 'sent'" small outlined>
+ <v-icon small left>{{ mdiCheck }}</v-icon>
+ Sent
+ </v-chip>
+
+ <v-chip
+ v-else-if="props.item.status === 'failed'"
+ color="error"
+ small
+ outlined
+ >
+ <v-icon small left>{{ mdiAlert }}</v-icon>
+ Failed
+ </v-chip>
+
+ <v-chip v-else small color="cyan" outlined>
+ <v-icon small left>{{ mdiProgressCheck }}</v-icon>
+ {{ props.item.status | capitalize }}
+ </v-chip>
+ </template>
+ <template #[`item.content`]="props">
+ <pre
+ style="
+ white-space: pre-wrap;
+ max-width: 300px;
+ word-break: break-all;
+ "
+ >{{ props.item.content }}</pre
+ >
+ </template>
+ </v-data-table>
+ </v-col>
+ </v-row>
+ </v-container>
+ </div>
+ </v-container>
+</template>
+
+<script lang="ts">
+import Vue from 'vue'
+import {
+ mdiDelete,
+ mdiMagnify,
+ mdiArrowLeft,
+ mdiCheckAll,
+ mdiCheck,
+ mdiCallMissed,
+ mdiCallReceived,
+ mdiCallMade,
+ mdiExport,
+ mdiProgressCheck,
+ mdiAlert,
+} from '@mdi/js'
+import { AxiosError } from 'axios'
+import { DataOptions } from 'vuetify'
+import { ErrorMessages, getErrorMessages } from '~/plugins/errors'
+import capitalize from '~/plugins/capitalize'
+import {
+ EntitiesMessage,
+ EntitiesPhone,
+ ResponsesUnprocessableEntity,
+} from '~/models/api'
+import { formatPhoneNumber } from '~/plugins/filters'
+import { SearchMessagesRequest } from '~/models/message'
+
+export default Vue.extend({
+ name: 'SearchMessagesIndex',
+ middleware: ['auth'],
+ data() {
+ return {
+ mdiDelete,
+ mdiMagnify,
+ mdiArrowLeft,
+ mdiExport,
+ mdiAlert,
+ mdiCheck,
+ mdiCheckAll,
+ mdiCallMissed,
+ mdiCallReceived,
+ mdiCallMade,
+ mdiProgressCheck,
+ loading: true,
+ errorTitle: '',
+ showDeleteDialog: false,
+ selectedMessages: [] as EntitiesMessage[],
+ errorMessages: new ErrorMessages(),
+ formOwners: [],
+ formTypes: [],
+ formStatuses: [],
+ formQuery: '',
+ footerProps: {
+ itemsPerPage: 100,
+ itemsPerPageOptions: [10, 50, 100, 200],
+ },
+ options: {
+ sortBy: ['created_at'],
+ sortDesc: [true],
+ } as DataOptions,
+ messages: [] as EntitiesMessage[],
+ totalMessages: -1,
+ headers: [
+ { text: 'Created At', value: 'created_at' },
+ { text: 'Owner', value: 'owner' },
+ { text: 'Contact', value: 'contact' },
+ { text: 'Message Type', value: 'type' },
+ { text: 'Status', value: 'status' },
+ { text: 'Message Content', value: 'content', sortable: false },
+ ],
+ }
+ },
+ head() {
+ return {
+ title: 'Search your Messages - httpSMS',
+ }
+ },
+ computed: {
+ phoneNumberSelectItems() {
+ return this.$store.getters.getPhones.map((phone: EntitiesPhone) => {
+ return {
+ text: formatPhoneNumber(phone.phone_number),
+ value: phone.phone_number,
+ }
+ })
+ },
+ messageTypeSelectItems() {
+ return [
+ { text: 'Outbound', value: 'mobile-terminated' },
+ { text: 'Inbound', value: 'mobile-originated' },
+ { text: 'Missed Calls', value: 'call/missed' },
+ ]
+ },
+ messageStatusSelectItems() {
+ return [
+ { value: 'pending', text: 'Pending' },
+ { value: 'sent', text: 'Sent' },
+ { value: 'delivered', text: 'Delivered' },
+ { value: 'failed', text: 'Failed' },
+ { value: 'expired', text: 'Expired' },
+ { value: 'received', text: 'Received' },
+ ]
+ },
+ },
+ watch: {
+ options: {
+ handler() {
+ this.fetchMessages()
+ },
+ deep: true,
+ },
+ },
+ async mounted() {
+ await this.$store.dispatch('loadUser')
+ await this.$store.dispatch('loadPhones')
+ this.loading = false
+ },
+
+ methods: {
+ exportMessages() {
+ let csvContent = 'data:text/csv;charset=utf-8,'
+ csvContent +=
+ 'Message ID,Created At,Owner,Contact,Message Type,Status,Message Content\n'
+ this.selectedMessages.forEach((message) => {
+ csvContent += `${message.id},${new Date(
+ message.created_at,
+ ).toLocaleString()},${message.owner},${message.contact},${
+ message.type
+ },${message.status},${message.content}\n`
+ })
+
+ const encodedUri = encodeURI(csvContent)
+ const link = document.createElement('a')
+ link.setAttribute('href', encodedUri)
+ link.setAttribute(
+ 'download',
+ `httpsms-${new Date().toJSON().slice(0, 10)}.csv`,
+ )
+ document.body.appendChild(link) // Required for FF
+
+ link.click()
+
+ this.$store.dispatch('addNotification', {
+ message: 'The selected messages have been exported successfully',
+ type: 'success',
+ })
+ },
+
+ deleteMessages() {
+ this.loading = true
+ Promise.all(
+ this.selectedMessages.map((message) =>
+ this.$store.dispatch('deleteMessage', message.id),
+ ),
+ )
+ .then(() => {
+ this.$store.dispatch('addNotification', {
+ message: 'The selected messages have been deleted successfully',
+ type: 'success',
+ })
+ this.selectedMessages = []
+ })
+ .catch(() => {
+ this.$store.dispatch('addNotification', {
+ message: 'Error while deleting the selected messages',
+ type: 'error',
+ })
+ })
+ .finally(() => {
+ this.loading = false
+ this.showDeleteDialog = false
+ this.fetchMessages()
+ })
+ },
+
+ fetchMessages() {
+ this.loading = true
+ this.errorMessages = new ErrorMessages()
+ this.errorTitle = ''
+
+ this.$store
+ .dispatch('searchMessages', {
+ owners: this.formOwners,
+ types: this.formTypes,
+ statuses: this.formStatuses,
+ query: this.formQuery,
+ sort_by: this.options.sortBy[0],
+ sort_descending: this.options.sortDesc[0],
+ skip: (this.options.page - 1) * this.options.itemsPerPage,
+ limit: this.options.itemsPerPage,
+ } as SearchMessagesRequest)
+ .then((messages: EntitiesMessage[]) => {
+ this.messages = messages
+ this.totalMessages =
+ (this.options.page - 1) * this.options.itemsPerPage +
+ messages.length
+ if (messages.length === this.options.itemsPerPage) {
+ this.totalMessages = this.totalMessages + 1
+ }
+ })
+ .catch((error: AxiosError<ResponsesUnprocessableEntity>) => {
+ this.errorTitle = capitalize(
+ error.response?.data?.message ?? 'Error while searching messages',
+ )
+ this.errorMessages = getErrorMessages(error)
+ })
+ .finally(() => {
+ this.loading = false
+ })
+ },
+ },
+})
+</script>
diff --git a/web/plugins/filters.ts b/web/plugins/filters.ts
index 5c838046..2a7c1a99 100644
--- a/web/plugins/filters.ts
+++ b/web/plugins/filters.ts
@@ -2,7 +2,7 @@ import Vue from 'vue'
import { intervalToDuration, formatDuration } from 'date-fns'
import { parsePhoneNumber, isValidPhoneNumber } from 'libphonenumber-js'
-Vue.filter('phoneNumber', (value: string): string => {
+export const formatPhoneNumber = (value: string) => {
if (!isValidPhoneNumber(value)) {
return value
}
@@ -11,6 +11,10 @@ Vue.filter('phoneNumber', (value: string): string => {
return phoneNumber.formatInternational()
}
return value
+}
+
+Vue.filter('phoneNumber', (value: string): string => {
+ return formatPhoneNumber(value)
})
Vue.filter('phoneCountry', (value: string): string => {
@@ -56,3 +60,7 @@ Vue.filter('humanizeTime', (value: string): string => {
})
return formatDuration(durations)
})
+
+Vue.filter('capitalize', (value: string): string => {
+ return value.charAt(0).toUpperCase() + value.slice(1)
+})
diff --git a/web/plugins/veutify.ts b/web/plugins/veutify.ts
new file mode 100644
index 00000000..be8b07eb
--- /dev/null
+++ b/web/plugins/veutify.ts
@@ -0,0 +1,67 @@
+import Vue from 'vue'
+import { Route } from 'vue-router'
+import { DataOptions } from 'vuetify'
+
+export type VForm = Vue & {
+ validate: () => boolean
+ resetValidation: () => boolean
+ reset: () => void
+}
+
+export type FormInputType = string | null | File
+
+export type FormValidationRule = (value: FormInputType) => string | boolean
+
+export type FormValidationRules = Array<FormValidationRule>
+
+export interface SelectItem {
+ text: string
+ value: string | number | boolean
+}
+
+export interface DatatableFooterProps {
+ itemsPerPage: number
+ itemsPerPageOptions: Array<number>
+}
+
+export const DefaultFooterProps: DatatableFooterProps = {
+ itemsPerPage: 100,
+ itemsPerPageOptions: [10, 50, 100, 200],
+}
+
+export type ParseParamsResponse = {
+ options: DataOptions
+ query: string | null
+}
+
+export const parseFilterOptionsFromParams = (
+ route: Route,
+ options: DataOptions,
+): ParseParamsResponse => {
+ let query = null
+ Object.keys(route.query).forEach((value: string) => {
+ if (value === 'itemsPerPage') {
+ options.itemsPerPage = parseInt(
+ (route.query[value] as string) ?? options.itemsPerPage.toString(),
+ )
+ }
+
+ if (value === 'sortBy') {
+ options.sortBy = [(route.query[value] as string) ?? options.sortBy[0]]
+ }
+
+ if (value === 'sortDesc') {
+ options.sortDesc = [!(route.query[value] === 'false')]
+ }
+
+ if (value === 'page') {
+ options.page = parseInt(
+ (route.query[value] as string) ?? options.page.toString(),
+ )
+ }
+ if (value === 'query') {
+ query = route.query[value]
+ }
+ })
+ return { options, query }
+}
diff --git a/web/store/index.ts b/web/store/index.ts
index d89ebf4f..53a7cd97 100644
--- a/web/store/index.ts
+++ b/web/store/index.ts
@@ -1,13 +1,14 @@
import { ActionContext } from 'vuex'
import { AxiosError, AxiosResponse } from 'axios'
import { MessageThread } from '~/models/message-thread'
-import { Message } from '~/models/message'
+import { Message, SearchMessagesRequest } from '~/models/message'
import { Heartbeat } from '~/models/heartbeat'
import axios, { setApiKey, setAuthHeader } from '~/plugins/axios'
import { User } from '~/models/user'
import { BillingUsage } from '~/models/billing'
import {
EntitiesDiscord,
+ EntitiesMessage,
EntitiesPhone,
EntitiesUser,
EntitiesWebhook,
@@ -18,6 +19,7 @@ import {
RequestsWebhookUpdate,
ResponsesDiscordResponse,
ResponsesDiscordsResponse,
+ ResponsesMessagesResponse,
ResponsesNoContent,
ResponsesOkString,
ResponsesUnprocessableEntity,
@@ -511,6 +513,24 @@ export const actions = {
})
},
+ searchMessages(
+ _: ActionContext<State, State>,
+ payload: SearchMessagesRequest,
+ ) {
+ return new Promise<EntitiesMessage[]>((resolve, reject) => {
+ axios
+ .get<ResponsesMessagesResponse>(`/v1/messages/search`, {
+ params: payload,
+ })
+ .then((response: AxiosResponse<ResponsesMessagesResponse>) => {
+ resolve(response.data.data)
+ })
+ .catch(async (error: AxiosError) => {
+ reject(error)
+ })
+ })
+ },
+
setThreadId(context: ActionContext<State, State>, threadId: string | null) {
context.commit('setThreadId', threadId)
},