diff --git a/api/docs/docs.go b/api/docs/docs.go
index ab5a4ea6..934cd282 100644
--- a/api/docs/docs.go
+++ b/api/docs/docs.go
@@ -2179,6 +2179,236 @@ const docTemplate = `{
}
}
},
+ "/send-schedules": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "List all send schedules owned by the authenticated user.",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "List send schedules",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.MessageSendSchedule"
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ },
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Create a new send schedule for the authenticated user.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "Create send schedule",
+ "parameters": [
+ {
+ "description": "Payload of new send schedule.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.SendScheduleStore"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/responses.SendScheduleResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "/send-schedules/{scheduleID}": {
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Update a send schedule owned by the authenticated user.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "Update send schedule",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Schedule ID",
+ "name": "scheduleID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "description": "Payload of updated send schedule.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.SendScheduleStore"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.SendScheduleResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a send schedule owned by the authenticated user.",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "Delete send schedule",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Schedule ID",
+ "name": "scheduleID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
+ },
"/users/me": {
"get": {
"security": [
@@ -3288,6 +3518,77 @@ const docTemplate = `{
}
}
},
+ "entities.MessageSendSchedule": {
+ "type": "object",
+ "required": [
+ "created_at",
+ "id",
+ "is_active",
+ "name",
+ "timezone",
+ "updated_at",
+ "user_id",
+ "windows"
+ ],
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "is_active": {
+ "type": "boolean",
+ "example": true
+ },
+ "name": {
+ "type": "string",
+ "example": "Business Hours"
+ },
+ "timezone": {
+ "type": "string",
+ "example": "Europe/Tallinn"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ },
+ "windows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.MessageSendScheduleWindow"
+ }
+ }
+ }
+ },
+ "entities.MessageSendScheduleWindow": {
+ "type": "object",
+ "required": [
+ "day_of_week",
+ "end_minute",
+ "start_minute"
+ ],
+ "properties": {
+ "day_of_week": {
+ "type": "integer",
+ "example": 1
+ },
+ "end_minute": {
+ "type": "integer",
+ "example": 1020
+ },
+ "start_minute": {
+ "type": "integer",
+ "example": 540
+ }
+ }
+ },
"entities.MessageThread": {
"type": "object",
"required": [
@@ -3364,6 +3665,7 @@ const docTemplate = `{
"message_expiration_seconds",
"messages_per_minute",
"phone_number",
+ "schedule_id",
"sim",
"updated_at",
"user_id"
@@ -3402,6 +3704,10 @@ const docTemplate = `{
"type": "string",
"example": "+18005550199"
},
+ "schedule_id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
"sim": {
"$ref": "#/definitions/entities.SIM"
},
@@ -3996,6 +4302,7 @@ const docTemplate = `{
"messages_per_minute",
"missed_call_auto_reply",
"phone_number",
+ "schedule_id",
"sim"
],
"properties": {
@@ -4025,6 +4332,10 @@ const docTemplate = `{
"type": "string",
"example": "+18005550199"
},
+ "schedule_id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
"sim": {
"description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
"type": "string",
@@ -4032,6 +4343,51 @@ const docTemplate = `{
}
}
},
+ "requests.SendScheduleStore": {
+ "type": "object",
+ "required": [
+ "is_active",
+ "name",
+ "timezone",
+ "windows"
+ ],
+ "properties": {
+ "is_active": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "windows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/requests.SendScheduleWindow"
+ }
+ }
+ }
+ },
+ "requests.SendScheduleWindow": {
+ "type": "object",
+ "required": [
+ "day_of_week",
+ "end_minute",
+ "start_minute"
+ ],
+ "properties": {
+ "day_of_week": {
+ "type": "integer"
+ },
+ "end_minute": {
+ "type": "integer"
+ },
+ "start_minute": {
+ "type": "integer"
+ }
+ }
+ },
"requests.UserNotificationUpdate": {
"type": "object",
"required": [
@@ -4572,6 +4928,27 @@ const docTemplate = `{
}
}
},
+ "responses.SendScheduleResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.MessageSendSchedule"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
+ },
"responses.Unauthorized": {
"type": "object",
"required": [
diff --git a/api/docs/swagger.json b/api/docs/swagger.json
index b8bc5739..e48dab66 100644
--- a/api/docs/swagger.json
+++ b/api/docs/swagger.json
@@ -1,4393 +1,5222 @@
{
- "schemes": ["https"],
- "swagger": "2.0",
- "info": {
- "description": "Use your Android phone to send and receive SMS messages via a simple programmable API with end-to-end encryption.",
- "title": "httpSMS API Reference",
- "contact": {
- "name": "support@httpsms.com",
- "email": "support@httpsms.com"
- },
- "license": {
- "name": "AGPL-3.0",
- "url": "https://raw.githubusercontent.com/NdoleStudio/http-sms-manager/main/LICENSE"
- },
- "version": "1.0"
- },
- "host": "api.httpsms.com",
- "basePath": "/v1",
- "paths": {
- "/billing/usage": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get the summary of sent and received messages for a user in the current month",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Billing"],
- "summary": "Get Billing Usage.",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.BillingUsageResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/billing/usage-history": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get billing usage records of sent and received messages for a user in the past. It will be sorted by timestamp in descending order.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Billing"],
- "summary": "Get billing usage history.",
- "parameters": [
- {
- "minimum": 0,
- "type": "integer",
- "description": "number of heartbeats to skip",
- "name": "skip",
- "in": "query"
- },
- {
- "maximum": 100,
- "minimum": 1,
- "type": "integer",
- "description": "number of heartbeats to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.BillingUsagesResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/bulk-messages": {
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Sends bulk SMS messages to multiple users based on our [CSV template](https://httpsms.com/templates/httpsms-bulk.csv) or our [Excel template](https://httpsms.com/templates/httpsms-bulk.xlsx).",
- "consumes": ["multipart/form-data"],
- "produces": ["application/json"],
- "tags": ["BulkSMS"],
- "summary": "Store bulk SMS file",
- "parameters": [
- {
- "type": "file",
- "description": "The Excel or CSV file containing the messages to be sent.",
- "name": "document",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/discord-integrations": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get the discord integrations of a user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["DiscordIntegration"],
- "summary": "Get discord integrations of a user",
- "parameters": [
- {
- "minimum": 0,
- "type": "integer",
- "description": "number of discord integrations to skip",
- "name": "skip",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter discord integrations containing query",
- "name": "query",
- "in": "query"
- },
- {
- "maximum": 20,
- "minimum": 1,
- "type": "integer",
- "description": "number of discord integrations to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.DiscordsResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Store a discord integration for the authenticated user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["DiscordIntegration"],
- "summary": "Store discord integration",
- "parameters": [
- {
- "description": "Payload of the discord integration request",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.DiscordStore"
- }
- }
- ],
- "responses": {
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/responses.DiscordResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/discord-integrations/{discordID}": {
- "put": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Update a discord integration for the currently authenticated user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["DiscordIntegration"],
- "summary": "Update a discord integration",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the discord integration",
- "name": "discordID",
- "in": "path",
- "required": true
- },
- {
- "description": "Payload of discord integration to update",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.DiscordUpdate"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.DiscordResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Delete a discord integration for a user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Webhooks"],
- "summary": "Delete discord integration",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the discord integration",
- "name": "discordID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/discord/event": {
- "post": {
- "description": "Publish a discord event to the registered listeners",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Discord"],
- "summary": "Consume a discord event",
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/heartbeats": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get the last time a phone number requested for outstanding messages. It will be sorted by timestamp in descending order.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Heartbeats"],
- "summary": "Get heartbeats of an owner phone number",
- "parameters": [
- {
- "type": "string",
- "default": "+18005550199",
- "description": "the owner's phone number",
- "name": "owner",
- "in": "query",
- "required": true
- },
- {
- "minimum": 0,
- "type": "integer",
- "description": "number of heartbeats to skip",
- "name": "skip",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter containing query",
- "name": "query",
- "in": "query"
- },
- {
- "maximum": 20,
- "minimum": 1,
- "type": "integer",
- "description": "number of heartbeats to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.HeartbeatsResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Store the heartbeat to make notify that a phone number is still active",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Heartbeats"],
- "summary": "Register heartbeat of an owner phone number",
- "parameters": [
- {
- "description": "Payload of the heartbeat request",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.HeartbeatStore"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.HeartbeatResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/integration/3cx/messages": {
- "post": {
- "description": "Sends an SMS message from the 3CX platform",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["3CXIntegration"],
- "summary": "Sends a 3CX SMS message",
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/message-threads": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get list of contacts which a phone number has communicated with (threads). It will be sorted by timestamp in descending order.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["MessageThreads"],
- "summary": "Get message threads for a phone number",
- "parameters": [
- {
- "type": "string",
- "default": "+18005550199",
- "description": "owner phone number",
- "name": "owner",
- "in": "query",
- "required": true
- },
- {
- "minimum": 0,
- "type": "integer",
- "description": "number of messages to skip",
- "name": "skip",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter message threads containing query",
- "name": "query",
- "in": "query"
- },
- {
- "maximum": 20,
- "minimum": 1,
- "type": "integer",
- "description": "number of messages to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.MessageThreadsResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/message-threads/{messageThreadID}": {
- "put": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Updates the details of a message thread",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["MessageThreads"],
- "summary": "Update a message thread",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the message thread",
- "name": "messageThreadID",
- "in": "path",
- "required": true
- },
- {
- "description": "Payload of message thread details to update",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.MessageThreadUpdate"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.PhoneResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Delete a message thread from the database and also deletes all the messages in the thread.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["MessageThreads"],
- "summary": "Delete a message thread from the database.",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the message thread",
- "name": "messageThreadID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/messages": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get list of messages which are sent between 2 phone numbers. It will be sorted by timestamp in descending order.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Get messages which are sent between 2 phone numbers",
- "parameters": [
- {
- "type": "string",
- "default": "+18005550199",
- "description": "the owner's phone number",
- "name": "owner",
- "in": "query",
- "required": true
- },
- {
- "type": "string",
- "default": "+18005550100",
- "description": "the contact's phone number",
- "name": "contact",
- "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": 20,
- "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/bulk-send": {
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Add bulk SMS messages to be sent by the android phone",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Send bulk SMS messages",
- "parameters": [
- {
- "description": "Bulk send message request payload",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.MessageBulkSend"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$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/calls/missed": {
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "This endpoint is called by the httpSMS android app to register a missed call event on the mobile phone.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Register a missed call event on the mobile phone",
- "parameters": [
- {
- "description": "Payload of the missed call event.",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.MessageCallMissed"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.MessageResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/messages/outstanding": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get an outstanding message to be sent by an android phone",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Get an outstanding message",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703cb",
- "description": "The ID of the message",
- "name": "message_id",
- "in": "query",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.MessageResponse"
- }
- },
- "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/receive": {
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Add a new message received from a mobile phone",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Receive a new SMS message from a mobile phone",
- "parameters": [
- {
- "description": "Received message request payload",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.MessageReceive"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.MessageResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/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",
- "description": "Cloudflare turnstile token https://www.cloudflare.com/en-gb/application-services/products/turnstile/",
- "name": "token",
- "in": "header",
- "required": true
- },
- {
- "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": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Add a new SMS message to be sent by your Android phone",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Send an SMS message",
- "parameters": [
- {
- "description": "Send message request payload",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.MessageSend"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.MessageResponse"
- }
- },
- "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/{messageID}": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get a message from the database by the message ID.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Get a message from the database.",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the message",
- "name": "messageID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.MessageResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- },
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Delete a message from the database and removes the message content from the list of threads.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Delete a message from the database.",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the message",
- "name": "messageID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/messages/{messageID}/events": {
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Use this endpoint to send events for a message when it is failed, sent or delivered by the mobile phone.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Messages"],
- "summary": "Upsert an event for a message on the mobile phone",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the message",
- "name": "messageID",
- "in": "path",
- "required": true
- },
- {
- "description": "Payload of the event emitted.",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.MessageEvent"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.MessageResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/phone-api-keys": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get list phone API keys which a user has registered on the httpSMS application",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["PhoneAPIKeys"],
- "summary": "Get the phone API keys of a user",
- "parameters": [
- {
- "minimum": 0,
- "type": "integer",
- "description": "number of phone api keys to skip",
- "name": "skip",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter phone api keys with name containing query",
- "name": "query",
- "in": "query"
- },
- {
- "maximum": 100,
- "minimum": 1,
- "type": "integer",
- "description": "number of phone api keys to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.PhoneAPIKeysResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Creates a new phone API key which can be used to log in to the httpSMS app on your Android phone",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["PhoneAPIKeys"],
- "summary": "Store phone API key",
- "parameters": [
- {
- "description": "Payload of new phone API key.",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.PhoneAPIKeyStoreRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.PhoneAPIKeyResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/phone-api-keys/{phoneAPIKeyID}": {
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Delete a phone API Key from the database and cannot be used for authentication anymore.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["PhoneAPIKeys"],
- "summary": "Delete a phone API key from the database.",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the phone API key",
- "name": "phoneAPIKeyID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/phone-api-keys/{phoneAPIKeyID}/phones/{phoneID}": {
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "You will need to login again to the httpSMS app on your Android phone with a new phone API key.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["PhoneAPIKeys"],
- "summary": "Remove the association of a phone from the phone API key.",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the phone API key",
- "name": "phoneAPIKeyID",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the phone",
- "name": "phoneID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/responses.BadRequest"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "schema": {
- "$ref": "#/definitions/responses.UnprocessableEntity"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/phones": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get list of phones which a user has registered on the http sms application",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Phones"],
- "summary": "Get phones of a user",
- "parameters": [
- {
- "minimum": 0,
- "type": "integer",
- "description": "number of heartbeats to skip",
- "name": "skip",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter phones containing query",
- "name": "query",
- "in": "query"
- },
- {
- "maximum": 20,
- "minimum": 1,
- "type": "integer",
- "description": "number of phones to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.PhonesResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "put": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Updates properties of a user's phone. If the phone with this number does not exist, a new one will be created. Think of this method like an 'upsert'",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Phones"],
- "summary": "Upsert Phone",
- "parameters": [
- {
- "description": "Payload of new phone number.",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.PhoneUpsert"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.PhoneResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/phones/fcm-token": {
- "put": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Updates the FCM token of a phone. If the phone with this number does not exist, a new one will be created. Think of this method like an 'upsert'",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Phones"],
- "summary": "Upserts the FCM token of a phone",
- "parameters": [
- {
- "description": "Payload of new FCM token.",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.PhoneFCMToken"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.PhoneResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/phones/{phoneID}": {
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Delete a phone that has been sored in the database",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Phones"],
- "summary": "Delete Phone",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the phone",
- "name": "phoneID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "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/me": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get details of the currently authenticated user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Users"],
- "summary": "Get current user",
- "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"
- }
- }
- }
- },
- "put": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Updates the details of the currently authenticated user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Users"],
- "summary": "Update a user",
- "parameters": [
- {
- "description": "Payload of user details to update",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.UserUpdate"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.PhoneResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Deletes the currently authenticated user together with all their data.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Users"],
- "summary": "Delete a user",
- "responses": {
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "401": {
- "description": "Unauthorized",
- "schema": {
- "$ref": "#/definitions/responses.Unauthorized"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/users/subscription": {
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Cancel the subscription of the authenticated user.",
- "produces": ["application/json"],
- "tags": ["Users"],
- "summary": "Cancel the user's subscription",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "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/subscription-update-url": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Fetches the subscription URL of the authenticated user.",
- "produces": ["application/json"],
- "tags": ["Users"],
- "summary": "Currently authenticated user subscription update URL",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.OkString"
- }
- },
- "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/subscription/invoices/{subscriptionInvoiceID}": {
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Generates a new invoice PDF file for the given subscription payment with given parameters.",
- "consumes": ["application/json"],
- "produces": ["application/pdf"],
- "tags": ["Users"],
- "summary": "Generate a subscription payment invoice",
- "parameters": [
- {
- "description": "Generate subscription payment invoice parameters",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.UserPaymentInvoice"
- }
- },
- {
- "type": "string",
- "description": "ID of the subscription invoice to generate the PDF for",
- "name": "subscriptionInvoiceID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "file"
- }
- },
- "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/subscription/payments": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Subscription payments are generated throughout the lifecycle of a subscription, typically there is one at the time of purchase and then one for each renewal.",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Users"],
- "summary": "Get the last 10 subscription payments.",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.UserSubscriptionPaymentsResponse"
- }
- },
- "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}/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": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Update the email notification settings for a user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Users"],
- "summary": "Update notification settings",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the user to update",
- "name": "userID",
- "in": "path",
- "required": true
- },
- {
- "description": "User notification details to update",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.UserNotificationUpdate"
- }
- }
- ],
- "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"
- }
- }
- }
- }
- },
- "/v1/attachments/{userID}/{messageID}/{attachmentIndex}/{filename}": {
- "get": {
- "description": "Download an MMS attachment by its path components",
- "produces": ["application/octet-stream"],
- "tags": ["Attachments"],
- "summary": "Download a message attachment",
- "parameters": [
- {
- "type": "string",
- "description": "User ID",
- "name": "userID",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "Message ID",
- "name": "messageID",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "Attachment index",
- "name": "attachmentIndex",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "Filename with extension",
- "name": "filename",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "file"
- }
- },
- "404": {
- "description": "Not Found",
- "schema": {
- "$ref": "#/definitions/responses.NotFound"
- }
- },
- "500": {
- "description": "Internal Server Error",
- "schema": {
- "$ref": "#/definitions/responses.InternalServerError"
- }
- }
- }
- }
- },
- "/webhooks": {
- "get": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Get the webhooks of a user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Webhooks"],
- "summary": "Get webhooks of a user",
- "parameters": [
- {
- "minimum": 0,
- "type": "integer",
- "description": "number of webhooks to skip",
- "name": "skip",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter webhooks containing query",
- "name": "query",
- "in": "query"
- },
- {
- "maximum": 20,
- "minimum": 1,
- "type": "integer",
- "description": "number of webhooks to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.WebhooksResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Store a webhook for the authenticated user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Webhooks"],
- "summary": "Store a webhook",
- "parameters": [
- {
- "description": "Payload of the webhook request",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.WebhookStore"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.WebhookResponse"
- }
- },
- "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"
- }
- }
- }
- }
- },
- "/webhooks/{webhookID}": {
- "put": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Update a webhook for the currently authenticated user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Webhooks"],
- "summary": "Update a webhook",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the webhook",
- "name": "webhookID",
- "in": "path",
- "required": true
- },
- {
- "description": "Payload of webhook details to update",
- "name": "payload",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/requests.WebhookUpdate"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/responses.WebhookResponse"
- }
- },
- "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"
- }
- }
- }
- },
- "delete": {
- "security": [
- {
- "ApiKeyAuth": []
- }
- ],
- "description": "Delete a webhook for a user",
- "consumes": ["application/json"],
- "produces": ["application/json"],
- "tags": ["Webhooks"],
- "summary": "Delete webhook",
- "parameters": [
- {
- "type": "string",
- "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
- "description": "ID of the webhook",
- "name": "webhookID",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "No Content",
- "schema": {
- "$ref": "#/definitions/responses.NoContent"
- }
- },
- "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"
- }
- }
- }
- }
- }
- },
- "definitions": {
- "entities.BillingUsage": {
- "type": "object",
- "required": [
- "created_at",
- "end_timestamp",
- "id",
- "received_messages",
- "sent_messages",
- "start_timestamp",
- "total_cost",
- "updated_at",
- "user_id"
- ],
- "properties": {
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "end_timestamp": {
- "type": "string",
- "example": "2022-01-31T23:59:59+00:00"
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
- },
- "received_messages": {
- "type": "integer",
- "example": 465
- },
- "sent_messages": {
- "type": "integer",
- "example": 321
- },
- "start_timestamp": {
- "type": "string",
- "example": "2022-01-01T00:00:00+00:00"
- },
- "total_cost": {
- "type": "integer",
- "example": 0
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:10.303278+03:00"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- }
- }
- },
- "entities.Discord": {
- "type": "object",
- "required": [
- "created_at",
- "id",
- "incoming_channel_id",
- "name",
- "server_id",
- "updated_at",
- "user_id"
- ],
- "properties": {
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
- },
- "incoming_channel_id": {
- "type": "string",
- "example": "1095780203256627291"
- },
- "name": {
- "type": "string",
- "example": "Game Server"
- },
- "server_id": {
- "type": "string",
- "example": "1095778291488653372"
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:10.303278+03:00"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- }
- }
- },
- "entities.Heartbeat": {
- "type": "object",
- "required": [
- "charging",
- "id",
- "owner",
- "timestamp",
- "user_id",
- "version"
- ],
- "properties": {
- "charging": {
- "type": "boolean",
- "example": true
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
- },
- "owner": {
- "type": "string",
- "example": "+18005550199"
- },
- "timestamp": {
- "type": "string",
- "example": "2022-06-05T14:26:01.520828+03:00"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- },
- "version": {
- "type": "string",
- "example": "344c10f"
- }
- }
- },
- "entities.Message": {
- "type": "object",
- "required": [
- "attachments",
- "contact",
- "content",
- "created_at",
- "encrypted",
- "id",
- "max_send_attempts",
- "order_timestamp",
- "owner",
- "request_received_at",
- "send_attempt_count",
- "sim",
- "status",
- "type",
- "updated_at",
- "user_id"
- ],
- "properties": {
- "attachments": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://example.com/image.jpg",
- "https://example.com/video.mp4"
- ]
- },
- "contact": {
- "type": "string",
- "example": "+18005550100"
- },
- "content": {
- "type": "string",
- "example": "This is a sample text message"
- },
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "delivered_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "encrypted": {
- "type": "boolean",
- "example": false
- },
- "expired_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "failed_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "failure_reason": {
- "type": "string",
- "example": "UNKNOWN"
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
- },
- "last_attempted_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "max_send_attempts": {
- "type": "integer",
- "example": 1
- },
- "order_timestamp": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "owner": {
- "type": "string",
- "example": "+18005550199"
- },
- "received_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "request_id": {
- "type": "string",
- "example": "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
- },
- "request_received_at": {
- "type": "string",
- "example": "2022-06-05T14:26:01.520828+03:00"
- },
- "scheduled_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "scheduled_send_time": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "send_attempt_count": {
- "type": "integer",
- "example": 0
- },
- "send_time": {
- "description": "SendDuration is the number of nanoseconds from when the request was received until when the mobile phone send the message",
- "type": "integer",
- "example": 133414
- },
- "sent_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "sim": {
- "description": "SIM is the SIM card to use to send the message\n* SMS1: use the SIM card in slot 1\n* SMS2: use the SIM card in slot 2\n* DEFAULT: used the default communication SIM card",
- "allOf": [
- {
- "$ref": "#/definitions/entities.SIM"
- }
- ],
- "example": "DEFAULT"
- },
- "status": {
- "type": "string",
- "example": "pending"
- },
- "type": {
- "type": "string",
- "example": "mobile-terminated"
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:10.303278+03:00"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- }
- }
- },
- "entities.MessageThread": {
- "type": "object",
- "required": [
- "color",
- "contact",
- "created_at",
- "id",
- "is_archived",
- "last_message_content",
- "last_message_id",
- "order_timestamp",
- "owner",
- "status",
- "updated_at",
- "user_id"
- ],
- "properties": {
- "color": {
- "type": "string",
- "example": "indigo"
- },
+ "schemes": [
+ "https"
+ ],
+ "swagger": "2.0",
+ "info": {
+ "description": "Use your Android phone to send and receive SMS messages via a simple programmable API with end-to-end encryption.",
+ "title": "httpSMS API Reference",
"contact": {
- "type": "string",
- "example": "+18005550100"
- },
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703ca"
- },
- "is_archived": {
- "type": "boolean",
- "example": false
- },
- "last_message_content": {
- "type": "string",
- "example": "This is a sample message content"
- },
- "last_message_id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703ca"
- },
- "order_timestamp": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "owner": {
- "type": "string",
- "example": "+18005550199"
- },
- "status": {
- "type": "string",
- "example": "PENDING"
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- }
- }
- },
- "entities.Phone": {
- "type": "object",
- "required": [
- "created_at",
- "id",
- "max_send_attempts",
- "message_expiration_seconds",
- "messages_per_minute",
- "phone_number",
- "sim",
- "updated_at",
- "user_id"
- ],
- "properties": {
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "fcm_token": {
- "type": "string",
- "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....."
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
- },
- "max_send_attempts": {
- "description": "MaxSendAttempts determines how many times to retry sending an SMS message",
- "type": "integer",
- "example": 2
- },
- "message_expiration_seconds": {
- "description": "MessageExpirationSeconds is the duration in seconds after sending a message when it is considered to be expired.",
- "type": "integer"
- },
- "messages_per_minute": {
- "type": "integer",
- "example": 1
- },
- "missed_call_auto_reply": {
- "type": "string",
- "example": "This phone cannot receive calls. Please send an SMS instead."
- },
- "phone_number": {
- "type": "string",
- "example": "+18005550199"
- },
- "sim": {
- "$ref": "#/definitions/entities.SIM"
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:10.303278+03:00"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- }
- }
- },
- "entities.PhoneAPIKey": {
- "type": "object",
- "required": [
- "api_key",
- "created_at",
- "id",
- "name",
- "phone_ids",
- "phone_numbers",
- "updated_at",
- "user_email",
- "user_id"
- ],
- "properties": {
- "api_key": {
- "type": "string",
- "example": "pk_DGW8NwQp7mxKaSZ72Xq9v6xxxxx"
- },
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ "name": "support@httpsms.com",
+ "email": "support@httpsms.com"
},
- "name": {
- "type": "string",
- "example": "Business Phone Key"
+ "license": {
+ "name": "AGPL-3.0",
+ "url": "https://raw.githubusercontent.com/NdoleStudio/http-sms-manager/main/LICENSE"
},
- "phone_ids": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "32343a19-da5e-4b1b-a767-3298a73703cb",
- "32343a19-da5e-4b1b-a767-3298a73703cc"
- ]
- },
- "phone_numbers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": ["+18005550199", "+18005550100"]
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "user_email": {
- "type": "string",
- "example": "user@gmail.com"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- }
- }
- },
- "entities.SIM": {
- "type": "string",
- "enum": ["SIM1", "SIM2"],
- "x-enum-varnames": ["SIM1", "SIM2"]
+ "version": "1.0"
},
- "entities.SubscriptionName": {
- "type": "string",
- "enum": [
- "free",
- "pro-monthly",
- "pro-yearly",
- "ultra-monthly",
- "ultra-yearly",
- "pro-lifetime",
- "20k-monthly",
- "100k-monthly",
- "50k-monthly",
- "200k-monthly",
- "20k-yearly"
- ],
- "x-enum-varnames": [
- "SubscriptionNameFree",
- "SubscriptionNameProMonthly",
- "SubscriptionNameProYearly",
- "SubscriptionNameUltraMonthly",
- "SubscriptionNameUltraYearly",
- "SubscriptionNameProLifetime",
- "SubscriptionName20KMonthly",
- "SubscriptionName100KMonthly",
- "SubscriptionName50KMonthly",
- "SubscriptionName200KMonthly",
- "SubscriptionName20KYearly"
- ]
- },
- "entities.User": {
- "type": "object",
- "required": [
- "api_key",
- "created_at",
- "email",
- "id",
- "notification_heartbeat_enabled",
- "notification_message_status_enabled",
- "notification_newsletter_enabled",
- "notification_webhook_enabled",
- "subscription_id",
- "subscription_name",
- "timezone",
- "updated_at"
- ],
- "properties": {
- "active_phone_id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
- },
- "api_key": {
- "type": "string",
- "example": "x-api-key"
- },
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "email": {
- "type": "string",
- "example": "name@email.com"
- },
- "id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- },
- "notification_heartbeat_enabled": {
- "type": "boolean",
- "example": true
- },
- "notification_message_status_enabled": {
- "type": "boolean",
- "example": true
- },
- "notification_newsletter_enabled": {
- "type": "boolean",
- "example": true
- },
- "notification_webhook_enabled": {
- "type": "boolean",
- "example": true
- },
- "subscription_ends_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "subscription_id": {
- "type": "string",
- "example": "8f9c71b8-b84e-4417-8408-a62274f65a08"
- },
- "subscription_name": {
- "allOf": [
- {
- "$ref": "#/definitions/entities.SubscriptionName"
+ "host": "api.httpsms.com",
+ "basePath": "/v1",
+ "paths": {
+ "/billing/usage": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get the summary of sent and received messages for a user in the current month",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Billing"
+ ],
+ "summary": "Get Billing Usage.",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.BillingUsageResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
}
- ],
- "example": "free"
- },
- "subscription_renews_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "subscription_status": {
- "type": "string",
- "example": "on_trial"
- },
- "timezone": {
- "type": "string",
- "example": "Europe/Helsinki"
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:10.303278+03:00"
- }
- }
- },
- "entities.Webhook": {
- "type": "object",
- "required": [
- "created_at",
- "events",
- "id",
- "phone_numbers",
- "signing_key",
- "updated_at",
- "url",
- "user_id"
- ],
- "properties": {
- "created_at": {
- "type": "string",
- "example": "2022-06-05T14:26:02.302718+03:00"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": ["message.phone.received"]
- },
- "id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
- },
- "phone_numbers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": ["+18005550199", "+18005550100"]
},
- "signing_key": {
- "type": "string",
- "example": "DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY"
- },
- "updated_at": {
- "type": "string",
- "example": "2022-06-05T14:26:10.303278+03:00"
- },
- "url": {
- "type": "string",
- "example": "https://example.com"
- },
- "user_id": {
- "type": "string",
- "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
- }
- }
- },
- "requests.DiscordStore": {
- "type": "object",
- "required": ["incoming_channel_id", "name", "server_id"],
- "properties": {
- "incoming_channel_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "server_id": {
- "type": "string"
- }
- }
- },
- "requests.DiscordUpdate": {
- "type": "object",
- "required": ["incoming_channel_id", "name", "server_id"],
- "properties": {
- "incoming_channel_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "server_id": {
- "type": "string"
- }
- }
- },
- "requests.HeartbeatStore": {
- "type": "object",
- "required": ["charging", "phone_numbers"],
- "properties": {
- "charging": {
- "type": "boolean"
- },
- "phone_numbers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "requests.MessageAttachment": {
- "type": "object",
- "required": ["content", "content_type", "name"],
- "properties": {
- "content": {
- "description": "Content is the base64-encoded attachment data",
- "type": "string",
- "example": "base64data..."
+ "/billing/usage-history": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get billing usage records of sent and received messages for a user in the past. It will be sorted by timestamp in descending order.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Billing"
+ ],
+ "summary": "Get billing usage history.",
+ "parameters": [
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of heartbeats to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "maximum": 100,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of heartbeats to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.BillingUsagesResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "content_type": {
- "description": "ContentType is the MIME type of the attachment",
- "type": "string",
- "example": "image/jpeg"
+ "/bulk-messages": {
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Sends bulk SMS messages to multiple users based on our [CSV template](https://httpsms.com/templates/httpsms-bulk.csv) or our [Excel template](https://httpsms.com/templates/httpsms-bulk.xlsx).",
+ "consumes": [
+ "multipart/form-data"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "BulkSMS"
+ ],
+ "summary": "Store bulk SMS file",
+ "parameters": [
+ {
+ "type": "file",
+ "description": "The Excel or CSV file containing the messages to be sent.",
+ "name": "document",
+ "in": "formData",
+ "required": true
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "name": {
- "description": "Name is the original filename of the attachment",
- "type": "string",
- "example": "photo.jpg"
- }
- }
- },
- "requests.MessageBulkSend": {
- "type": "object",
- "required": ["content", "from", "to"],
- "properties": {
- "attachments": {
- "description": "Attachments are optional. When you provide a list of attachments, the message will be sent out as an MMS",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "/discord-integrations": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get the discord integrations of a user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "DiscordIntegration"
+ ],
+ "summary": "Get discord integrations of a user",
+ "parameters": [
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of discord integrations to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter discord integrations containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 20,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of discord integrations to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.DiscordsResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Store a discord integration for the authenticated user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "DiscordIntegration"
+ ],
+ "summary": "Store discord integration",
+ "parameters": [
+ {
+ "description": "Payload of the discord integration request",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.DiscordStore"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/responses.DiscordResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "content": {
- "type": "string",
- "example": "This is a sample text message"
+ "/discord-integrations/{discordID}": {
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Update a discord integration for the currently authenticated user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "DiscordIntegration"
+ ],
+ "summary": "Update a discord integration",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the discord integration",
+ "name": "discordID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "description": "Payload of discord integration to update",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.DiscordUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.DiscordResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a discord integration for a user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Webhooks"
+ ],
+ "summary": "Delete discord integration",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the discord integration",
+ "name": "discordID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "encrypted": {
- "description": "Encrypted is used to determine if the content is end-to-end encrypted. Make sure to set the encryption key on the httpSMS mobile app",
- "type": "boolean",
- "example": false
+ "/discord/event": {
+ "post": {
+ "description": "Publish a discord event to the registered listeners",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Discord"
+ ],
+ "summary": "Consume a discord event",
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "from": {
- "type": "string",
- "example": "+18005550199"
+ "/heartbeats": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get the last time a phone number requested for outstanding messages. It will be sorted by timestamp in descending order.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Heartbeats"
+ ],
+ "summary": "Get heartbeats of an owner phone number",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "+18005550199",
+ "description": "the owner's phone number",
+ "name": "owner",
+ "in": "query",
+ "required": true
+ },
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of heartbeats to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 20,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of heartbeats to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.HeartbeatsResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Store the heartbeat to make notify that a phone number is still active",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Heartbeats"
+ ],
+ "summary": "Register heartbeat of an owner phone number",
+ "parameters": [
+ {
+ "description": "Payload of the heartbeat request",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.HeartbeatStore"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.HeartbeatResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "request_id": {
- "description": "RequestID is an optional parameter used to track a request from the client's perspective",
- "type": "string",
- "example": "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
+ "/integration/3cx/messages": {
+ "post": {
+ "description": "Sends an SMS message from the 3CX platform",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "3CXIntegration"
+ ],
+ "summary": "Sends a 3CX SMS message",
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "to": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": ["+18005550100", "+18005550100"]
- }
- }
- },
- "requests.MessageCallMissed": {
- "type": "object",
- "required": ["from", "sim", "timestamp", "to"],
- "properties": {
- "from": {
- "type": "string",
- "example": "+18005550199"
+ "/message-threads": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get list of contacts which a phone number has communicated with (threads). It will be sorted by timestamp in descending order.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "MessageThreads"
+ ],
+ "summary": "Get message threads for a phone number",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "+18005550199",
+ "description": "owner phone number",
+ "name": "owner",
+ "in": "query",
+ "required": true
+ },
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of messages to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter message threads containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 20,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of messages to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessageThreadsResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "sim": {
- "type": "string",
- "example": "SIM1"
+ "/message-threads/{messageThreadID}": {
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Updates the details of a message thread",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "MessageThreads"
+ ],
+ "summary": "Update a message thread",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the message thread",
+ "name": "messageThreadID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "description": "Payload of message thread details to update",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.MessageThreadUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.PhoneResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a message thread from the database and also deletes all the messages in the thread.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "MessageThreads"
+ ],
+ "summary": "Delete a message thread from the database.",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the message thread",
+ "name": "messageThreadID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "timestamp": {
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
+ "/messages": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get list of messages which are sent between 2 phone numbers. It will be sorted by timestamp in descending order.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Get messages which are sent between 2 phone numbers",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "+18005550199",
+ "description": "the owner's phone number",
+ "name": "owner",
+ "in": "query",
+ "required": true
+ },
+ {
+ "type": "string",
+ "default": "+18005550100",
+ "description": "the contact's phone number",
+ "name": "contact",
+ "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": 20,
+ "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"
+ }
+ }
+ }
+ }
},
- "to": {
- "type": "string",
- "example": "+18005550100"
- }
- }
- },
- "requests.MessageEvent": {
- "type": "object",
- "required": ["event_name", "reason", "timestamp"],
- "properties": {
- "event_name": {
- "description": "EventName is the type of event\n* SENT: is emitted when a message is sent by the mobile phone\n* FAILED: is event is emitted when the message could not be sent by the mobile phone\n* DELIVERED: is event is emitted when a delivery report has been received by the mobile phone",
- "type": "string",
- "example": "SENT"
+ "/messages/bulk-send": {
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Add bulk SMS messages to be sent by the android phone",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Send bulk SMS messages",
+ "parameters": [
+ {
+ "description": "Bulk send message request payload",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.MessageBulkSend"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$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"
+ }
+ }
+ }
+ }
},
- "reason": {
- "description": "Reason is the exact error message in case the event is an error",
- "type": "string"
+ "/messages/calls/missed": {
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "This endpoint is called by the httpSMS android app to register a missed call event on the mobile phone.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Register a missed call event on the mobile phone",
+ "parameters": [
+ {
+ "description": "Payload of the missed call event.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.MessageCallMissed"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessageResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "timestamp": {
- "description": "Timestamp is the time when the event was emitted, Please send the timestamp in UTC with as much precision as possible",
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
- }
- }
- },
- "requests.MessageReceive": {
- "type": "object",
- "required": ["content", "encrypted", "from", "sim", "timestamp", "to"],
- "properties": {
- "attachments": {
- "description": "Attachments is the list of MMS attachments received with the message",
- "type": "array",
- "items": {
- "$ref": "#/definitions/requests.MessageAttachment"
- }
+ "/messages/outstanding": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get an outstanding message to be sent by an android phone",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Get an outstanding message",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703cb",
+ "description": "The ID of the message",
+ "name": "message_id",
+ "in": "query",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessageResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "content": {
- "type": "string",
- "example": "This is a sample text message received on a phone"
+ "/messages/receive": {
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Add a new message received from a mobile phone",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Receive a new SMS message from a mobile phone",
+ "parameters": [
+ {
+ "description": "Received message request payload",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.MessageReceive"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessageResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "encrypted": {
- "description": "Encrypted is used to determine if the content is end-to-end encrypted. Make sure to set the encryption key on the httpSMS mobile app",
- "type": "boolean",
- "example": false
+ "/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",
+ "description": "Cloudflare turnstile token https://www.cloudflare.com/en-gb/application-services/products/turnstile/",
+ "name": "token",
+ "in": "header",
+ "required": true
+ },
+ {
+ "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"
+ }
+ }
+ }
+ }
},
- "from": {
- "type": "string",
- "example": "+18005550199"
+ "/messages/send": {
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Add a new SMS message to be sent by your Android phone",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Send an SMS message",
+ "parameters": [
+ {
+ "description": "Send message request payload",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.MessageSend"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessageResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "sim": {
- "description": "SIM card that received the message",
- "allOf": [
- {
- "$ref": "#/definitions/entities.SIM"
+ "/messages/{messageID}": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get a message from the database by the message ID.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Get a message from the database.",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the message",
+ "name": "messageID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.MessageResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a message from the database and removes the message content from the list of threads.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Delete a message from the database.",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the message",
+ "name": "messageID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
}
- ],
- "example": "SIM1"
},
- "timestamp": {
- "description": "Timestamp is the time when the event was emitted, Please send the timestamp in UTC with as much precision as possible",
- "type": "string",
- "example": "2022-06-05T14:26:09.527976+03:00"
+ "/messages/{messageID}/events": {
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Use this endpoint to send events for a message when it is failed, sent or delivered by the mobile phone.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Messages"
+ ],
+ "summary": "Upsert an event for a message on the mobile phone",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the message",
+ "name": "messageID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "description": "Payload of the event emitted.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.MessageEvent"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.MessageResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "to": {
- "type": "string",
- "example": "+18005550100"
- }
- }
- },
- "requests.MessageSend": {
- "type": "object",
- "required": ["content", "from", "to"],
- "properties": {
- "attachments": {
- "description": "Attachments are optional. When you provide a list of attachments, the message will be sent out as an MMS",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "https://example.com/image.jpg",
- "https://example.com/video.mp4"
- ]
+ "/phone-api-keys": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get list phone API keys which a user has registered on the httpSMS application",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "PhoneAPIKeys"
+ ],
+ "summary": "Get the phone API keys of a user",
+ "parameters": [
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of phone api keys to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter phone api keys with name containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 100,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of phone api keys to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.PhoneAPIKeysResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Creates a new phone API key which can be used to log in to the httpSMS app on your Android phone",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "PhoneAPIKeys"
+ ],
+ "summary": "Store phone API key",
+ "parameters": [
+ {
+ "description": "Payload of new phone API key.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.PhoneAPIKeyStoreRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.PhoneAPIKeyResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "content": {
- "type": "string",
- "example": "This is a sample text message"
+ "/phone-api-keys/{phoneAPIKeyID}": {
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a phone API Key from the database and cannot be used for authentication anymore.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "PhoneAPIKeys"
+ ],
+ "summary": "Delete a phone API key from the database.",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the phone API key",
+ "name": "phoneAPIKeyID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "encrypted": {
- "description": "Encrypted is an optional parameter used to determine if the content is end-to-end encrypted. Make sure to set the encryption key on the httpSMS mobile app",
- "type": "boolean",
- "example": false
+ "/phone-api-keys/{phoneAPIKeyID}/phones/{phoneID}": {
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "You will need to login again to the httpSMS app on your Android phone with a new phone API key.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "PhoneAPIKeys"
+ ],
+ "summary": "Remove the association of a phone from the phone API key.",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the phone API key",
+ "name": "phoneAPIKeyID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the phone",
+ "name": "phoneID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "from": {
- "type": "string",
- "example": "+18005550199"
+ "/phones": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get list of phones which a user has registered on the http sms application",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Phones"
+ ],
+ "summary": "Get phones of a user",
+ "parameters": [
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of heartbeats to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter phones containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 20,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of phones to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.PhonesResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Updates properties of a user's phone. If the phone with this number does not exist, a new one will be created. Think of this method like an 'upsert'",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Phones"
+ ],
+ "summary": "Upsert Phone",
+ "parameters": [
+ {
+ "description": "Payload of new phone number.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.PhoneUpsert"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.PhoneResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "request_id": {
- "description": "RequestID is an optional parameter used to track a request from the client's perspective",
- "type": "string",
- "example": "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
+ "/phones/fcm-token": {
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Updates the FCM token of a phone. If the phone with this number does not exist, a new one will be created. Think of this method like an 'upsert'",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Phones"
+ ],
+ "summary": "Upserts the FCM token of a phone",
+ "parameters": [
+ {
+ "description": "Payload of new FCM token.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.PhoneFCMToken"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.PhoneResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "send_at": {
- "description": "SendAt is an optional parameter used to schedule a message to be sent in the future. The time is considered to be in your profile's local timezone and you can queue messages for up to 20 days (480 hours) in the future.",
- "type": "string",
- "example": "2025-12-19T16:39:57-08:00"
+ "/phones/{phoneID}": {
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a phone that has been sored in the database",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Phones"
+ ],
+ "summary": "Delete Phone",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the phone",
+ "name": "phoneID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "to": {
- "type": "string",
- "example": "+18005550100"
- }
- }
- },
- "requests.MessageThreadUpdate": {
- "type": "object",
- "required": ["is_archived"],
- "properties": {
- "is_archived": {
- "type": "boolean",
- "example": true
- }
- }
- },
- "requests.PhoneAPIKeyStoreRequest": {
- "type": "object",
- "required": ["name"],
- "properties": {
- "name": {
- "type": "string",
- "example": "My Phone API Key"
- }
- }
- },
- "requests.PhoneFCMToken": {
- "type": "object",
- "required": ["fcm_token", "phone_number", "sim"],
- "properties": {
- "fcm_token": {
- "type": "string",
- "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....."
+ "/send-schedules": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "List all send schedules owned by the authenticated user.",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "List send schedules",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.MessageSendSchedule"
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ },
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Create a new send schedule for the authenticated user.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "Create send schedule",
+ "parameters": [
+ {
+ "description": "Payload of new send schedule.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.SendScheduleStore"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/responses.SendScheduleResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "phone_number": {
- "type": "string",
- "example": "[+18005550199]"
+ "/send-schedules/{scheduleID}": {
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Update a send schedule owned by the authenticated user.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "Update send schedule",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Schedule ID",
+ "name": "scheduleID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "description": "Payload of updated send schedule.",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.SendScheduleStore"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.SendScheduleResponse"
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "422": {
+ "description": "Unprocessable Entity",
+ "schema": {
+ "$ref": "#/definitions/responses.UnprocessableEntity"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a send schedule owned by the authenticated user.",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Send Schedules"
+ ],
+ "summary": "Delete send schedule",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Schedule ID",
+ "name": "scheduleID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/responses.BadRequest"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "sim": {
- "description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
- "type": "string",
- "example": "SIM1"
- }
- }
- },
- "requests.PhoneUpsert": {
- "type": "object",
- "required": [
- "fcm_token",
- "max_send_attempts",
- "message_expiration_seconds",
- "messages_per_minute",
- "missed_call_auto_reply",
- "phone_number",
- "sim"
- ],
- "properties": {
- "fcm_token": {
- "type": "string",
- "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....."
+ "/users/me": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get details of the currently authenticated user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Get current user",
+ "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"
+ }
+ }
+ }
+ },
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Updates the details of the currently authenticated user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Update a user",
+ "parameters": [
+ {
+ "description": "Payload of user details to update",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.UserUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.PhoneResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Deletes the currently authenticated user together with all their data.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Delete a user",
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "schema": {
+ "$ref": "#/definitions/responses.Unauthorized"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "max_send_attempts": {
- "description": "MaxSendAttempts is the number of attempts when sending an SMS message to handle the case where the phone is offline.",
- "type": "integer",
- "example": 2
+ "/users/subscription": {
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Cancel the subscription of the authenticated user.",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Cancel the user's subscription",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "message_expiration_seconds": {
- "description": "MessageExpirationSeconds is the duration in seconds after sending a message when it is considered to be expired.",
- "type": "integer",
- "example": 12345
+ "/users/subscription-update-url": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Fetches the subscription URL of the authenticated user.",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Currently authenticated user subscription update URL",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.OkString"
+ }
+ },
+ "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_per_minute": {
- "type": "integer",
- "example": 1
+ "/users/subscription/invoices/{subscriptionInvoiceID}": {
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Generates a new invoice PDF file for the given subscription payment with given parameters.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/pdf"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Generate a subscription payment invoice",
+ "parameters": [
+ {
+ "description": "Generate subscription payment invoice parameters",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.UserPaymentInvoice"
+ }
+ },
+ {
+ "type": "string",
+ "description": "ID of the subscription invoice to generate the PDF for",
+ "name": "subscriptionInvoiceID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "missed_call_auto_reply": {
- "type": "string",
- "example": "e.g. This phone cannot receive calls. Please send an SMS instead."
+ "/users/subscription/payments": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Subscription payments are generated throughout the lifecycle of a subscription, typically there is one at the time of purchase and then one for each renewal.",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Get the last 10 subscription payments.",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.UserSubscriptionPaymentsResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "phone_number": {
- "type": "string",
- "example": "+18005550199"
+ "/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"
+ }
+ }
+ }
+ }
},
- "sim": {
- "description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
- "type": "string",
- "example": "SIM1"
- }
- }
- },
- "requests.UserNotificationUpdate": {
- "type": "object",
- "required": [
- "heartbeat_enabled",
- "message_status_enabled",
- "newsletter_enabled",
- "webhook_enabled"
- ],
- "properties": {
- "heartbeat_enabled": {
- "type": "boolean",
- "example": true
+ "/users/{userID}/notifications": {
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Update the email notification settings for a user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Users"
+ ],
+ "summary": "Update notification settings",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the user to update",
+ "name": "userID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "description": "User notification details to update",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.UserNotificationUpdate"
+ }
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ }
},
- "message_status_enabled": {
- "type": "boolean",
- "example": true
+ "/v1/attachments/{userID}/{messageID}/{attachmentIndex}/{filename}": {
+ "get": {
+ "description": "Download an MMS attachment by its path components",
+ "produces": [
+ "application/octet-stream"
+ ],
+ "tags": [
+ "Attachments"
+ ],
+ "summary": "Download a message attachment",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "User ID",
+ "name": "userID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "Message ID",
+ "name": "messageID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "Attachment index",
+ "name": "attachmentIndex",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "Filename with extension",
+ "name": "filename",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "schema": {
+ "$ref": "#/definitions/responses.NotFound"
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "schema": {
+ "$ref": "#/definitions/responses.InternalServerError"
+ }
+ }
+ }
+ }
},
- "newsletter_enabled": {
- "type": "boolean",
- "example": true
+ "/webhooks": {
+ "get": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Get the webhooks of a user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Webhooks"
+ ],
+ "summary": "Get webhooks of a user",
+ "parameters": [
+ {
+ "minimum": 0,
+ "type": "integer",
+ "description": "number of webhooks to skip",
+ "name": "skip",
+ "in": "query"
+ },
+ {
+ "type": "string",
+ "description": "filter webhooks containing query",
+ "name": "query",
+ "in": "query"
+ },
+ {
+ "maximum": 20,
+ "minimum": 1,
+ "type": "integer",
+ "description": "number of webhooks to return",
+ "name": "limit",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.WebhooksResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "post": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Store a webhook for the authenticated user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Webhooks"
+ ],
+ "summary": "Store a webhook",
+ "parameters": [
+ {
+ "description": "Payload of the webhook request",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.WebhookStore"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.WebhookResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
},
- "webhook_enabled": {
- "type": "boolean",
- "example": true
+ "/webhooks/{webhookID}": {
+ "put": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Update a webhook for the currently authenticated user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Webhooks"
+ ],
+ "summary": "Update a webhook",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the webhook",
+ "name": "webhookID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "description": "Payload of webhook details to update",
+ "name": "payload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/requests.WebhookUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/responses.WebhookResponse"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "delete": {
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "description": "Delete a webhook for a user",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "Webhooks"
+ ],
+ "summary": "Delete webhook",
+ "parameters": [
+ {
+ "type": "string",
+ "default": "32343a19-da5e-4b1b-a767-3298a73703ca",
+ "description": "ID of the webhook",
+ "name": "webhookID",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content",
+ "schema": {
+ "$ref": "#/definitions/responses.NoContent"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
}
- }
},
- "requests.UserPaymentInvoice": {
- "type": "object",
- "required": [
- "address",
- "city",
- "country",
- "name",
- "notes",
- "state",
- "zip_code"
- ],
- "properties": {
- "address": {
- "type": "string",
- "example": "221B Baker Street, London"
- },
- "city": {
- "type": "string",
- "example": "Los Angeles"
+ "definitions": {
+ "entities.BillingUsage": {
+ "type": "object",
+ "required": [
+ "created_at",
+ "end_timestamp",
+ "id",
+ "received_messages",
+ "sent_messages",
+ "start_timestamp",
+ "total_cost",
+ "updated_at",
+ "user_id"
+ ],
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "end_timestamp": {
+ "type": "string",
+ "example": "2022-01-31T23:59:59+00:00"
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "received_messages": {
+ "type": "integer",
+ "example": 465
+ },
+ "sent_messages": {
+ "type": "integer",
+ "example": 321
+ },
+ "start_timestamp": {
+ "type": "string",
+ "example": "2022-01-01T00:00:00+00:00"
+ },
+ "total_cost": {
+ "type": "integer",
+ "example": 0
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ }
+ }
},
- "country": {
- "type": "string",
- "example": "US"
+ "entities.Discord": {
+ "type": "object",
+ "required": [
+ "created_at",
+ "id",
+ "incoming_channel_id",
+ "name",
+ "server_id",
+ "updated_at",
+ "user_id"
+ ],
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "incoming_channel_id": {
+ "type": "string",
+ "example": "1095780203256627291"
+ },
+ "name": {
+ "type": "string",
+ "example": "Game Server"
+ },
+ "server_id": {
+ "type": "string",
+ "example": "1095778291488653372"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ }
+ }
},
- "name": {
- "type": "string",
- "example": "Acme Corp"
+ "entities.Heartbeat": {
+ "type": "object",
+ "required": [
+ "charging",
+ "id",
+ "owner",
+ "timestamp",
+ "user_id",
+ "version"
+ ],
+ "properties": {
+ "charging": {
+ "type": "boolean",
+ "example": true
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "owner": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "timestamp": {
+ "type": "string",
+ "example": "2022-06-05T14:26:01.520828+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ },
+ "version": {
+ "type": "string",
+ "example": "344c10f"
+ }
+ }
},
- "notes": {
- "type": "string",
- "example": "Thank you for your business!"
+ "entities.Message": {
+ "type": "object",
+ "required": [
+ "attachments",
+ "contact",
+ "content",
+ "created_at",
+ "encrypted",
+ "id",
+ "max_send_attempts",
+ "order_timestamp",
+ "owner",
+ "request_received_at",
+ "send_attempt_count",
+ "sim",
+ "status",
+ "type",
+ "updated_at",
+ "user_id"
+ ],
+ "properties": {
+ "attachments": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "https://example.com/image.jpg",
+ "https://example.com/video.mp4"
+ ]
+ },
+ "contact": {
+ "type": "string",
+ "example": "+18005550100"
+ },
+ "content": {
+ "type": "string",
+ "example": "This is a sample text message"
+ },
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "delivered_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "encrypted": {
+ "type": "boolean",
+ "example": false
+ },
+ "expired_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "failed_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "failure_reason": {
+ "type": "string",
+ "example": "UNKNOWN"
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "last_attempted_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "max_send_attempts": {
+ "type": "integer",
+ "example": 1
+ },
+ "order_timestamp": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "owner": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "received_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "request_id": {
+ "type": "string",
+ "example": "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
+ },
+ "request_received_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:01.520828+03:00"
+ },
+ "scheduled_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "scheduled_send_time": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "send_attempt_count": {
+ "type": "integer",
+ "example": 0
+ },
+ "send_time": {
+ "description": "SendDuration is the number of nanoseconds from when the request was received until when the mobile phone send the message",
+ "type": "integer",
+ "example": 133414
+ },
+ "sent_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "sim": {
+ "description": "SIM is the SIM card to use to send the message\n* SMS1: use the SIM card in slot 1\n* SMS2: use the SIM card in slot 2\n* DEFAULT: used the default communication SIM card",
+ "allOf": [
+ {
+ "$ref": "#/definitions/entities.SIM"
+ }
+ ],
+ "example": "DEFAULT"
+ },
+ "status": {
+ "type": "string",
+ "example": "pending"
+ },
+ "type": {
+ "type": "string",
+ "example": "mobile-terminated"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ }
+ }
},
- "state": {
- "type": "string",
- "example": "CA"
+ "entities.MessageSendSchedule": {
+ "type": "object",
+ "required": [
+ "created_at",
+ "id",
+ "is_active",
+ "name",
+ "timezone",
+ "updated_at",
+ "user_id",
+ "windows"
+ ],
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "is_active": {
+ "type": "boolean",
+ "example": true
+ },
+ "name": {
+ "type": "string",
+ "example": "Business Hours"
+ },
+ "timezone": {
+ "type": "string",
+ "example": "Europe/Tallinn"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ },
+ "windows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.MessageSendScheduleWindow"
+ }
+ }
+ }
},
- "zip_code": {
- "type": "string",
- "example": "9800"
- }
- }
- },
- "requests.UserUpdate": {
- "type": "object",
- "required": ["active_phone_id", "timezone"],
- "properties": {
- "active_phone_id": {
- "type": "string",
- "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ "entities.MessageSendScheduleWindow": {
+ "type": "object",
+ "required": [
+ "day_of_week",
+ "end_minute",
+ "start_minute"
+ ],
+ "properties": {
+ "day_of_week": {
+ "type": "integer",
+ "example": 1
+ },
+ "end_minute": {
+ "type": "integer",
+ "example": 1020
+ },
+ "start_minute": {
+ "type": "integer",
+ "example": 540
+ }
+ }
},
- "timezone": {
- "type": "string",
- "example": "Europe/Helsinki"
- }
- }
- },
- "requests.WebhookStore": {
- "type": "object",
- "required": ["events", "phone_numbers", "signing_key", "url"],
- "properties": {
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "entities.MessageThread": {
+ "type": "object",
+ "required": [
+ "color",
+ "contact",
+ "created_at",
+ "id",
+ "is_archived",
+ "last_message_content",
+ "last_message_id",
+ "order_timestamp",
+ "owner",
+ "status",
+ "updated_at",
+ "user_id"
+ ],
+ "properties": {
+ "color": {
+ "type": "string",
+ "example": "indigo"
+ },
+ "contact": {
+ "type": "string",
+ "example": "+18005550100"
+ },
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703ca"
+ },
+ "is_archived": {
+ "type": "boolean",
+ "example": false
+ },
+ "last_message_content": {
+ "type": "string",
+ "example": "This is a sample message content"
+ },
+ "last_message_id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703ca"
+ },
+ "order_timestamp": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "owner": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "status": {
+ "type": "string",
+ "example": "PENDING"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ }
+ }
},
- "phone_numbers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": ["+18005550100", "+18005550100"]
+ "entities.Phone": {
+ "type": "object",
+ "required": [
+ "created_at",
+ "id",
+ "max_send_attempts",
+ "message_expiration_seconds",
+ "messages_per_minute",
+ "phone_number",
+ "schedule_id",
+ "sim",
+ "updated_at",
+ "user_id"
+ ],
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "fcm_token": {
+ "type": "string",
+ "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....."
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "max_send_attempts": {
+ "description": "MaxSendAttempts determines how many times to retry sending an SMS message",
+ "type": "integer",
+ "example": 2
+ },
+ "message_expiration_seconds": {
+ "description": "MessageExpirationSeconds is the duration in seconds after sending a message when it is considered to be expired.",
+ "type": "integer"
+ },
+ "messages_per_minute": {
+ "type": "integer",
+ "example": 1
+ },
+ "missed_call_auto_reply": {
+ "type": "string",
+ "example": "This phone cannot receive calls. Please send an SMS instead."
+ },
+ "phone_number": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "schedule_id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "sim": {
+ "$ref": "#/definitions/entities.SIM"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ }
+ }
},
- "signing_key": {
- "type": "string"
+ "entities.PhoneAPIKey": {
+ "type": "object",
+ "required": [
+ "api_key",
+ "created_at",
+ "id",
+ "name",
+ "phone_ids",
+ "phone_numbers",
+ "updated_at",
+ "user_email",
+ "user_id"
+ ],
+ "properties": {
+ "api_key": {
+ "type": "string",
+ "example": "pk_DGW8NwQp7mxKaSZ72Xq9v6xxxxx"
+ },
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "name": {
+ "type": "string",
+ "example": "Business Phone Key"
+ },
+ "phone_ids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "32343a19-da5e-4b1b-a767-3298a73703cb",
+ "32343a19-da5e-4b1b-a767-3298a73703cc"
+ ]
+ },
+ "phone_numbers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "+18005550199",
+ "+18005550100"
+ ]
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "user_email": {
+ "type": "string",
+ "example": "user@gmail.com"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ }
+ }
},
- "url": {
- "type": "string"
- }
- }
- },
- "requests.WebhookUpdate": {
- "type": "object",
- "required": ["events", "phone_numbers", "signing_key", "url"],
- "properties": {
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- }
+ "entities.SIM": {
+ "type": "string",
+ "enum": [
+ "SIM1",
+ "SIM2"
+ ],
+ "x-enum-varnames": [
+ "SIM1",
+ "SIM2"
+ ]
+ },
+ "entities.SubscriptionName": {
+ "type": "string",
+ "enum": [
+ "free",
+ "pro-monthly",
+ "pro-yearly",
+ "ultra-monthly",
+ "ultra-yearly",
+ "pro-lifetime",
+ "20k-monthly",
+ "100k-monthly",
+ "50k-monthly",
+ "200k-monthly",
+ "20k-yearly"
+ ],
+ "x-enum-varnames": [
+ "SubscriptionNameFree",
+ "SubscriptionNameProMonthly",
+ "SubscriptionNameProYearly",
+ "SubscriptionNameUltraMonthly",
+ "SubscriptionNameUltraYearly",
+ "SubscriptionNameProLifetime",
+ "SubscriptionName20KMonthly",
+ "SubscriptionName100KMonthly",
+ "SubscriptionName50KMonthly",
+ "SubscriptionName200KMonthly",
+ "SubscriptionName20KYearly"
+ ]
+ },
+ "entities.User": {
+ "type": "object",
+ "required": [
+ "api_key",
+ "created_at",
+ "email",
+ "id",
+ "notification_heartbeat_enabled",
+ "notification_message_status_enabled",
+ "notification_newsletter_enabled",
+ "notification_webhook_enabled",
+ "subscription_id",
+ "subscription_name",
+ "timezone",
+ "updated_at"
+ ],
+ "properties": {
+ "active_phone_id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "api_key": {
+ "type": "string",
+ "example": "x-api-key"
+ },
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "email": {
+ "type": "string",
+ "example": "name@email.com"
+ },
+ "id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ },
+ "notification_heartbeat_enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "notification_message_status_enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "notification_newsletter_enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "notification_webhook_enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "subscription_ends_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "subscription_id": {
+ "type": "string",
+ "example": "8f9c71b8-b84e-4417-8408-a62274f65a08"
+ },
+ "subscription_name": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/entities.SubscriptionName"
+ }
+ ],
+ "example": "free"
+ },
+ "subscription_renews_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "subscription_status": {
+ "type": "string",
+ "example": "on_trial"
+ },
+ "timezone": {
+ "type": "string",
+ "example": "Europe/Helsinki"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ }
+ }
},
- "phone_numbers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": ["+18005550100", "+18005550100"]
+ "entities.Webhook": {
+ "type": "object",
+ "required": [
+ "created_at",
+ "events",
+ "id",
+ "phone_numbers",
+ "signing_key",
+ "updated_at",
+ "url",
+ "user_id"
+ ],
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:02.302718+03:00"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "message.phone.received"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "phone_numbers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "+18005550199",
+ "+18005550100"
+ ]
+ },
+ "signing_key": {
+ "type": "string",
+ "example": "DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY"
+ },
+ "updated_at": {
+ "type": "string",
+ "example": "2022-06-05T14:26:10.303278+03:00"
+ },
+ "url": {
+ "type": "string",
+ "example": "https://example.com"
+ },
+ "user_id": {
+ "type": "string",
+ "example": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
+ }
+ }
},
- "signing_key": {
- "type": "string"
+ "requests.DiscordStore": {
+ "type": "object",
+ "required": [
+ "incoming_channel_id",
+ "name",
+ "server_id"
+ ],
+ "properties": {
+ "incoming_channel_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "server_id": {
+ "type": "string"
+ }
+ }
},
- "url": {
- "type": "string"
- }
- }
- },
- "responses.BadRequest": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "string",
- "example": "The request body is not a valid JSON string"
+ "requests.DiscordUpdate": {
+ "type": "object",
+ "required": [
+ "incoming_channel_id",
+ "name",
+ "server_id"
+ ],
+ "properties": {
+ "incoming_channel_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "server_id": {
+ "type": "string"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "The request isn't properly formed"
+ "requests.HeartbeatStore": {
+ "type": "object",
+ "required": [
+ "charging",
+ "phone_numbers"
+ ],
+ "properties": {
+ "charging": {
+ "type": "boolean"
+ },
+ "phone_numbers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "error"
- }
- }
- },
- "responses.BillingUsageResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.BillingUsage"
+ "requests.MessageAttachment": {
+ "type": "object",
+ "required": [
+ "content",
+ "content_type",
+ "name"
+ ],
+ "properties": {
+ "content": {
+ "description": "Content is the base64-encoded attachment data",
+ "type": "string",
+ "example": "base64data..."
+ },
+ "content_type": {
+ "description": "ContentType is the MIME type of the attachment",
+ "type": "string",
+ "example": "image/jpeg"
+ },
+ "name": {
+ "description": "Name is the original filename of the attachment",
+ "type": "string",
+ "example": "photo.jpg"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.MessageBulkSend": {
+ "type": "object",
+ "required": [
+ "content",
+ "from",
+ "to"
+ ],
+ "properties": {
+ "attachments": {
+ "description": "Attachments are optional. When you provide a list of attachments, the message will be sent out as an MMS",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "content": {
+ "type": "string",
+ "example": "This is a sample text message"
+ },
+ "encrypted": {
+ "description": "Encrypted is used to determine if the content is end-to-end encrypted. Make sure to set the encryption key on the httpSMS mobile app",
+ "type": "boolean",
+ "example": false
+ },
+ "from": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "request_id": {
+ "description": "RequestID is an optional parameter used to track a request from the client's perspective",
+ "type": "string",
+ "example": "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
+ },
+ "to": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "+18005550100",
+ "+18005550100"
+ ]
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.BillingUsagesResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.BillingUsage"
- }
+ "requests.MessageCallMissed": {
+ "type": "object",
+ "required": [
+ "from",
+ "sim",
+ "timestamp",
+ "to"
+ ],
+ "properties": {
+ "from": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "sim": {
+ "type": "string",
+ "example": "SIM1"
+ },
+ "timestamp": {
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "to": {
+ "type": "string",
+ "example": "+18005550100"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.MessageEvent": {
+ "type": "object",
+ "required": [
+ "event_name",
+ "reason",
+ "timestamp"
+ ],
+ "properties": {
+ "event_name": {
+ "description": "EventName is the type of event\n* SENT: is emitted when a message is sent by the mobile phone\n* FAILED: is event is emitted when the message could not be sent by the mobile phone\n* DELIVERED: is event is emitted when a delivery report has been received by the mobile phone",
+ "type": "string",
+ "example": "SENT"
+ },
+ "reason": {
+ "description": "Reason is the exact error message in case the event is an error",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Timestamp is the time when the event was emitted, Please send the timestamp in UTC with as much precision as possible",
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.DiscordResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.Discord"
+ "requests.MessageReceive": {
+ "type": "object",
+ "required": [
+ "content",
+ "encrypted",
+ "from",
+ "sim",
+ "timestamp",
+ "to"
+ ],
+ "properties": {
+ "attachments": {
+ "description": "Attachments is the list of MMS attachments received with the message",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/requests.MessageAttachment"
+ }
+ },
+ "content": {
+ "type": "string",
+ "example": "This is a sample text message received on a phone"
+ },
+ "encrypted": {
+ "description": "Encrypted is used to determine if the content is end-to-end encrypted. Make sure to set the encryption key on the httpSMS mobile app",
+ "type": "boolean",
+ "example": false
+ },
+ "from": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "sim": {
+ "description": "SIM card that received the message",
+ "allOf": [
+ {
+ "$ref": "#/definitions/entities.SIM"
+ }
+ ],
+ "example": "SIM1"
+ },
+ "timestamp": {
+ "description": "Timestamp is the time when the event was emitted, Please send the timestamp in UTC with as much precision as possible",
+ "type": "string",
+ "example": "2022-06-05T14:26:09.527976+03:00"
+ },
+ "to": {
+ "type": "string",
+ "example": "+18005550100"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.MessageSend": {
+ "type": "object",
+ "required": [
+ "content",
+ "from",
+ "to"
+ ],
+ "properties": {
+ "attachments": {
+ "description": "Attachments are optional. When you provide a list of attachments, the message will be sent out as an MMS",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "https://example.com/image.jpg",
+ "https://example.com/video.mp4"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "example": "This is a sample text message"
+ },
+ "encrypted": {
+ "description": "Encrypted is an optional parameter used to determine if the content is end-to-end encrypted. Make sure to set the encryption key on the httpSMS mobile app",
+ "type": "boolean",
+ "example": false
+ },
+ "from": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "request_id": {
+ "description": "RequestID is an optional parameter used to track a request from the client's perspective",
+ "type": "string",
+ "example": "153554b5-ae44-44a0-8f4f-7bbac5657ad4"
+ },
+ "send_at": {
+ "description": "SendAt is an optional parameter used to schedule a message to be sent in the future. The time is considered to be in your profile's local timezone and you can queue messages for up to 20 days (480 hours) in the future.",
+ "type": "string",
+ "example": "2025-12-19T16:39:57-08:00"
+ },
+ "to": {
+ "type": "string",
+ "example": "+18005550100"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.DiscordsResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.Discord"
- }
+ "requests.MessageThreadUpdate": {
+ "type": "object",
+ "required": [
+ "is_archived"
+ ],
+ "properties": {
+ "is_archived": {
+ "type": "boolean",
+ "example": true
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.PhoneAPIKeyStoreRequest": {
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "example": "My Phone API Key"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.HeartbeatResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.Heartbeat"
+ "requests.PhoneFCMToken": {
+ "type": "object",
+ "required": [
+ "fcm_token",
+ "phone_number",
+ "sim"
+ ],
+ "properties": {
+ "fcm_token": {
+ "type": "string",
+ "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....."
+ },
+ "phone_number": {
+ "type": "string",
+ "example": "[+18005550199]"
+ },
+ "sim": {
+ "description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
+ "type": "string",
+ "example": "SIM1"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.PhoneUpsert": {
+ "type": "object",
+ "required": [
+ "fcm_token",
+ "max_send_attempts",
+ "message_expiration_seconds",
+ "messages_per_minute",
+ "missed_call_auto_reply",
+ "phone_number",
+ "schedule_id",
+ "sim"
+ ],
+ "properties": {
+ "fcm_token": {
+ "type": "string",
+ "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....."
+ },
+ "max_send_attempts": {
+ "description": "MaxSendAttempts is the number of attempts when sending an SMS message to handle the case where the phone is offline.",
+ "type": "integer",
+ "example": 2
+ },
+ "message_expiration_seconds": {
+ "description": "MessageExpirationSeconds is the duration in seconds after sending a message when it is considered to be expired.",
+ "type": "integer",
+ "example": 12345
+ },
+ "messages_per_minute": {
+ "type": "integer",
+ "example": 1
+ },
+ "missed_call_auto_reply": {
+ "type": "string",
+ "example": "e.g. This phone cannot receive calls. Please send an SMS instead."
+ },
+ "phone_number": {
+ "type": "string",
+ "example": "+18005550199"
+ },
+ "schedule_id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "sim": {
+ "description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
+ "type": "string",
+ "example": "SIM1"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.HeartbeatsResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.Heartbeat"
- }
+ "requests.SendScheduleStore": {
+ "type": "object",
+ "required": [
+ "is_active",
+ "name",
+ "timezone",
+ "windows"
+ ],
+ "properties": {
+ "is_active": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "windows": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/requests.SendScheduleWindow"
+ }
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.SendScheduleWindow": {
+ "type": "object",
+ "required": [
+ "day_of_week",
+ "end_minute",
+ "start_minute"
+ ],
+ "properties": {
+ "day_of_week": {
+ "type": "integer"
+ },
+ "end_minute": {
+ "type": "integer"
+ },
+ "start_minute": {
+ "type": "integer"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.InternalServerError": {
- "type": "object",
- "required": ["message", "status"],
- "properties": {
- "message": {
- "type": "string",
- "example": "We ran into an internal error while handling the request."
+ "requests.UserNotificationUpdate": {
+ "type": "object",
+ "required": [
+ "heartbeat_enabled",
+ "message_status_enabled",
+ "newsletter_enabled",
+ "webhook_enabled"
+ ],
+ "properties": {
+ "heartbeat_enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "message_status_enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "newsletter_enabled": {
+ "type": "boolean",
+ "example": true
+ },
+ "webhook_enabled": {
+ "type": "boolean",
+ "example": true
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "error"
- }
- }
- },
- "responses.MessageResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.Message"
+ "requests.UserPaymentInvoice": {
+ "type": "object",
+ "required": [
+ "address",
+ "city",
+ "country",
+ "name",
+ "notes",
+ "state",
+ "zip_code"
+ ],
+ "properties": {
+ "address": {
+ "type": "string",
+ "example": "221B Baker Street, London"
+ },
+ "city": {
+ "type": "string",
+ "example": "Los Angeles"
+ },
+ "country": {
+ "type": "string",
+ "example": "US"
+ },
+ "name": {
+ "type": "string",
+ "example": "Acme Corp"
+ },
+ "notes": {
+ "type": "string",
+ "example": "Thank you for your business!"
+ },
+ "state": {
+ "type": "string",
+ "example": "CA"
+ },
+ "zip_code": {
+ "type": "string",
+ "example": "9800"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.UserUpdate": {
+ "type": "object",
+ "required": [
+ "active_phone_id",
+ "timezone"
+ ],
+ "properties": {
+ "active_phone_id": {
+ "type": "string",
+ "example": "32343a19-da5e-4b1b-a767-3298a73703cb"
+ },
+ "timezone": {
+ "type": "string",
+ "example": "Europe/Helsinki"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.MessageThreadsResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.MessageThread"
- }
+ "requests.WebhookStore": {
+ "type": "object",
+ "required": [
+ "events",
+ "phone_numbers",
+ "signing_key",
+ "url"
+ ],
+ "properties": {
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "phone_numbers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "+18005550100",
+ "+18005550100"
+ ]
+ },
+ "signing_key": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "requests.WebhookUpdate": {
+ "type": "object",
+ "required": [
+ "events",
+ "phone_numbers",
+ "signing_key",
+ "url"
+ ],
+ "properties": {
+ "events": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "phone_numbers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "+18005550100",
+ "+18005550100"
+ ]
+ },
+ "signing_key": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.MessagesResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.Message"
- }
+ "responses.BadRequest": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "string",
+ "example": "The request body is not a valid JSON string"
+ },
+ "message": {
+ "type": "string",
+ "example": "The request isn't properly formed"
+ },
+ "status": {
+ "type": "string",
+ "example": "error"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.BillingUsageResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.BillingUsage"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.NoContent": {
- "type": "object",
- "required": ["message", "status"],
- "properties": {
- "message": {
- "type": "string",
- "example": "action performed successfully"
+ "responses.BillingUsagesResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.BillingUsage"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.NotFound": {
- "type": "object",
- "required": ["message", "status"],
- "properties": {
- "message": {
- "type": "string",
- "example": "cannot find message with ID [32343a19-da5e-4b1b-a767-3298a73703ca]"
+ "responses.DiscordResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.Discord"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "error"
- }
- }
- },
- "responses.OkString": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "string"
+ "responses.DiscordsResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.Discord"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.HeartbeatResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.Heartbeat"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.PhoneAPIKeyResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.PhoneAPIKey"
+ "responses.HeartbeatsResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.Heartbeat"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.InternalServerError": {
+ "type": "object",
+ "required": [
+ "message",
+ "status"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "We ran into an internal error while handling the request."
+ },
+ "status": {
+ "type": "string",
+ "example": "error"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.PhoneAPIKeysResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.PhoneAPIKey"
- }
+ "responses.MessageResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.Message"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.MessageThreadsResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.MessageThread"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.PhoneResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.Phone"
+ "responses.MessagesResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.Message"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.NoContent": {
+ "type": "object",
+ "required": [
+ "message",
+ "status"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "action performed successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.PhonesResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.Phone"
- }
+ "responses.NotFound": {
+ "type": "object",
+ "required": [
+ "message",
+ "status"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "example": "cannot find message with ID [32343a19-da5e-4b1b-a767-3298a73703ca]"
+ },
+ "status": {
+ "type": "string",
+ "example": "error"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.OkString": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.Unauthorized": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "string",
- "example": "Make sure your API key is set in the [X-API-Key] header in the request"
+ "responses.PhoneAPIKeyResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.PhoneAPIKey"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "You are not authorized to carry out this request."
+ "responses.PhoneAPIKeysResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.PhoneAPIKey"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "error"
- }
- }
- },
- "responses.UnprocessableEntity": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string"
+ "responses.PhoneResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.Phone"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
}
- }
},
- "message": {
- "type": "string",
- "example": "validation errors while handling request"
+ "responses.PhonesResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.Phone"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "error"
- }
- }
- },
- "responses.UserResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.User"
+ "responses.SendScheduleResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.MessageSendSchedule"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.Unauthorized": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "string",
+ "example": "Make sure your API key is set in the [X-API-Key] header in the request"
+ },
+ "message": {
+ "type": "string",
+ "example": "You are not authorized to carry out this request."
+ },
+ "status": {
+ "type": "string",
+ "example": "error"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.UserSubscriptionPaymentsResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
+ "responses.UnprocessableEntity": {
"type": "object",
- "required": ["attributes", "id", "type"],
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
"properties": {
- "attributes": {
- "type": "object",
- "required": [
- "billing_reason",
- "card_brand",
- "card_last_four",
- "created_at",
- "currency",
- "currency_rate",
- "discount_total",
- "discount_total_formatted",
- "discount_total_usd",
- "refunded",
- "refunded_amount",
- "refunded_amount_formatted",
- "refunded_amount_usd",
- "refunded_at",
- "status",
- "status_formatted",
- "subtotal",
- "subtotal_formatted",
- "subtotal_usd",
- "tax",
- "tax_formatted",
- "tax_inclusive",
- "tax_usd",
- "total",
- "total_formatted",
- "total_usd",
- "updated_at"
- ],
- "properties": {
- "billing_reason": {
- "type": "string"
- },
- "card_brand": {
- "type": "string"
- },
- "card_last_four": {
- "type": "string"
- },
- "created_at": {
- "type": "string"
- },
- "currency": {
- "type": "string"
- },
- "currency_rate": {
- "type": "string"
- },
- "discount_total": {
- "type": "integer"
- },
- "discount_total_formatted": {
- "type": "string"
- },
- "discount_total_usd": {
- "type": "integer"
- },
- "refunded": {
- "type": "boolean"
- },
- "refunded_amount": {
- "type": "integer"
- },
- "refunded_amount_formatted": {
- "type": "string"
- },
- "refunded_amount_usd": {
- "type": "integer"
- },
- "refunded_at": {},
- "status": {
- "type": "string"
- },
- "status_formatted": {
- "type": "string"
- },
- "subtotal": {
- "type": "integer"
- },
- "subtotal_formatted": {
- "type": "string"
- },
- "subtotal_usd": {
- "type": "integer"
- },
- "tax": {
- "type": "integer"
- },
- "tax_formatted": {
- "type": "string"
- },
- "tax_inclusive": {
- "type": "boolean"
- },
- "tax_usd": {
- "type": "integer"
- },
- "total": {
- "type": "integer"
- },
- "total_formatted": {
- "type": "string"
- },
- "total_usd": {
- "type": "integer"
- },
- "updated_at": {
- "type": "string"
- }
+ "data": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "validation errors while handling request"
+ },
+ "status": {
+ "type": "string",
+ "example": "error"
}
- },
- "id": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
}
- }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.UserResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.User"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
- }
- }
- },
- "responses.WebhookResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "$ref": "#/definitions/entities.Webhook"
+ "responses.UserSubscriptionPaymentsResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "attributes",
+ "id",
+ "type"
+ ],
+ "properties": {
+ "attributes": {
+ "type": "object",
+ "required": [
+ "billing_reason",
+ "card_brand",
+ "card_last_four",
+ "created_at",
+ "currency",
+ "currency_rate",
+ "discount_total",
+ "discount_total_formatted",
+ "discount_total_usd",
+ "refunded",
+ "refunded_amount",
+ "refunded_amount_formatted",
+ "refunded_amount_usd",
+ "refunded_at",
+ "status",
+ "status_formatted",
+ "subtotal",
+ "subtotal_formatted",
+ "subtotal_usd",
+ "tax",
+ "tax_formatted",
+ "tax_inclusive",
+ "tax_usd",
+ "total",
+ "total_formatted",
+ "total_usd",
+ "updated_at"
+ ],
+ "properties": {
+ "billing_reason": {
+ "type": "string"
+ },
+ "card_brand": {
+ "type": "string"
+ },
+ "card_last_four": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "string"
+ },
+ "currency": {
+ "type": "string"
+ },
+ "currency_rate": {
+ "type": "string"
+ },
+ "discount_total": {
+ "type": "integer"
+ },
+ "discount_total_formatted": {
+ "type": "string"
+ },
+ "discount_total_usd": {
+ "type": "integer"
+ },
+ "refunded": {
+ "type": "boolean"
+ },
+ "refunded_amount": {
+ "type": "integer"
+ },
+ "refunded_amount_formatted": {
+ "type": "string"
+ },
+ "refunded_amount_usd": {
+ "type": "integer"
+ },
+ "refunded_at": {},
+ "status": {
+ "type": "string"
+ },
+ "status_formatted": {
+ "type": "string"
+ },
+ "subtotal": {
+ "type": "integer"
+ },
+ "subtotal_formatted": {
+ "type": "string"
+ },
+ "subtotal_usd": {
+ "type": "integer"
+ },
+ "tax": {
+ "type": "integer"
+ },
+ "tax_formatted": {
+ "type": "string"
+ },
+ "tax_inclusive": {
+ "type": "boolean"
+ },
+ "tax_usd": {
+ "type": "integer"
+ },
+ "total": {
+ "type": "integer"
+ },
+ "total_formatted": {
+ "type": "string"
+ },
+ "total_usd": {
+ "type": "integer"
+ },
+ "updated_at": {
+ "type": "string"
+ }
+ }
+ },
+ "id": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "message": {
- "type": "string",
- "example": "Request handled successfully"
+ "responses.WebhookResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/entities.Webhook"
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
},
- "status": {
- "type": "string",
- "example": "success"
+ "responses.WebhooksResponse": {
+ "type": "object",
+ "required": [
+ "data",
+ "message",
+ "status"
+ ],
+ "properties": {
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/entities.Webhook"
+ }
+ },
+ "message": {
+ "type": "string",
+ "example": "Request handled successfully"
+ },
+ "status": {
+ "type": "string",
+ "example": "success"
+ }
+ }
}
- }
},
- "responses.WebhooksResponse": {
- "type": "object",
- "required": ["data", "message", "status"],
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/entities.Webhook"
- }
- },
- "message": {
- "type": "string",
- "example": "Request handled successfully"
- },
- "status": {
- "type": "string",
- "example": "success"
+ "securityDefinitions": {
+ "ApiKeyAuth": {
+ "type": "apiKey",
+ "name": "x-api-Key",
+ "in": "header"
}
- }
- }
- },
- "securityDefinitions": {
- "ApiKeyAuth": {
- "type": "apiKey",
- "name": "x-api-Key",
- "in": "header"
}
- }
-}
+}
\ No newline at end of file
diff --git a/api/docs/swagger.yaml b/api/docs/swagger.yaml
index f5563f2a..118671d8 100644
--- a/api/docs/swagger.yaml
+++ b/api/docs/swagger.yaml
@@ -30,15 +30,15 @@ definitions:
example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
type: string
required:
- - created_at
- - end_timestamp
- - id
- - received_messages
- - sent_messages
- - start_timestamp
- - total_cost
- - updated_at
- - user_id
+ - created_at
+ - end_timestamp
+ - id
+ - received_messages
+ - sent_messages
+ - start_timestamp
+ - total_cost
+ - updated_at
+ - user_id
type: object
entities.Discord:
properties:
@@ -64,13 +64,13 @@ definitions:
example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
type: string
required:
- - created_at
- - id
- - incoming_channel_id
- - name
- - server_id
- - updated_at
- - user_id
+ - created_at
+ - id
+ - incoming_channel_id
+ - name
+ - server_id
+ - updated_at
+ - user_id
type: object
entities.Heartbeat:
properties:
@@ -93,19 +93,19 @@ definitions:
example: 344c10f
type: string
required:
- - charging
- - id
- - owner
- - timestamp
- - user_id
- - version
+ - charging
+ - id
+ - owner
+ - timestamp
+ - user_id
+ - version
type: object
entities.Message:
properties:
attachments:
example:
- - https://example.com/image.jpg
- - https://example.com/video.mp4
+ - https://example.com/image.jpg
+ - https://example.com/video.mp4
items:
type: string
type: array
@@ -167,8 +167,7 @@ definitions:
example: 0
type: integer
send_time:
- description:
- SendDuration is the number of nanoseconds from when the request
+ description: SendDuration is the number of nanoseconds from when the request
was received until when the mobile phone send the message
example: 133414
type: integer
@@ -177,7 +176,7 @@ definitions:
type: string
sim:
allOf:
- - $ref: "#/definitions/entities.SIM"
+ - $ref: '#/definitions/entities.SIM'
description: |-
SIM is the SIM card to use to send the message
* SMS1: use the SIM card in slot 1
@@ -197,22 +196,75 @@ definitions:
example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
type: string
required:
- - attachments
- - contact
- - content
- - created_at
- - encrypted
- - id
- - max_send_attempts
- - order_timestamp
- - owner
- - request_received_at
- - send_attempt_count
- - sim
- - status
- - type
- - updated_at
- - user_id
+ - attachments
+ - contact
+ - content
+ - created_at
+ - encrypted
+ - id
+ - max_send_attempts
+ - order_timestamp
+ - owner
+ - request_received_at
+ - send_attempt_count
+ - sim
+ - status
+ - type
+ - updated_at
+ - user_id
+ type: object
+ entities.MessageSendSchedule:
+ properties:
+ created_at:
+ example: "2022-06-05T14:26:02.302718+03:00"
+ type: string
+ id:
+ example: 32343a19-da5e-4b1b-a767-3298a73703cb
+ type: string
+ is_active:
+ example: true
+ type: boolean
+ name:
+ example: Business Hours
+ type: string
+ timezone:
+ example: Europe/Tallinn
+ type: string
+ updated_at:
+ example: "2022-06-05T14:26:10.303278+03:00"
+ type: string
+ user_id:
+ example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
+ type: string
+ windows:
+ items:
+ $ref: '#/definitions/entities.MessageSendScheduleWindow'
+ type: array
+ required:
+ - created_at
+ - id
+ - is_active
+ - name
+ - timezone
+ - updated_at
+ - user_id
+ - windows
+ type: object
+ entities.MessageSendScheduleWindow:
+ properties:
+ day_of_week:
+ example: 1
+ type: integer
+ end_minute:
+ example: 1020
+ type: integer
+ start_minute:
+ example: 540
+ type: integer
+ required:
+ - day_of_week
+ - end_minute
+ - start_minute
type: object
entities.MessageThread:
properties:
@@ -253,18 +305,18 @@ definitions:
example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
type: string
required:
- - color
- - contact
- - created_at
- - id
- - is_archived
- - last_message_content
- - last_message_id
- - order_timestamp
- - owner
- - status
- - updated_at
- - user_id
+ - color
+ - contact
+ - created_at
+ - id
+ - is_archived
+ - last_message_content
+ - last_message_id
+ - order_timestamp
+ - owner
+ - status
+ - updated_at
+ - user_id
type: object
entities.Phone:
properties:
@@ -278,14 +330,12 @@ definitions:
example: 32343a19-da5e-4b1b-a767-3298a73703cb
type: string
max_send_attempts:
- description:
- MaxSendAttempts determines how many times to retry sending an
+ description: MaxSendAttempts determines how many times to retry sending an
SMS message
example: 2
type: integer
message_expiration_seconds:
- description:
- MessageExpirationSeconds is the duration in seconds after sending
+ description: MessageExpirationSeconds is the duration in seconds after sending
a message when it is considered to be expired.
type: integer
messages_per_minute:
@@ -297,8 +347,11 @@ definitions:
phone_number:
example: "+18005550199"
type: string
+ schedule_id:
+ example: 32343a19-da5e-4b1b-a767-3298a73703cb
+ type: string
sim:
- $ref: "#/definitions/entities.SIM"
+ $ref: '#/definitions/entities.SIM'
updated_at:
example: "2022-06-05T14:26:10.303278+03:00"
type: string
@@ -306,15 +359,16 @@ definitions:
example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
type: string
required:
- - created_at
- - id
- - max_send_attempts
- - message_expiration_seconds
- - messages_per_minute
- - phone_number
- - sim
- - updated_at
- - user_id
+ - created_at
+ - id
+ - max_send_attempts
+ - message_expiration_seconds
+ - messages_per_minute
+ - phone_number
+ - schedule_id
+ - sim
+ - updated_at
+ - user_id
type: object
entities.PhoneAPIKey:
properties:
@@ -332,15 +386,15 @@ definitions:
type: string
phone_ids:
example:
- - 32343a19-da5e-4b1b-a767-3298a73703cb
- - 32343a19-da5e-4b1b-a767-3298a73703cc
+ - 32343a19-da5e-4b1b-a767-3298a73703cb
+ - 32343a19-da5e-4b1b-a767-3298a73703cc
items:
type: string
type: array
phone_numbers:
example:
- - "+18005550199"
- - "+18005550100"
+ - "+18005550199"
+ - "+18005550100"
items:
type: string
type: array
@@ -354,50 +408,50 @@ definitions:
example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
type: string
required:
- - api_key
- - created_at
- - id
- - name
- - phone_ids
- - phone_numbers
- - updated_at
- - user_email
- - user_id
+ - api_key
+ - created_at
+ - id
+ - name
+ - phone_ids
+ - phone_numbers
+ - updated_at
+ - user_email
+ - user_id
type: object
entities.SIM:
enum:
- - SIM1
- - SIM2
+ - SIM1
+ - SIM2
type: string
x-enum-varnames:
- - SIM1
- - SIM2
+ - SIM1
+ - SIM2
entities.SubscriptionName:
enum:
- - free
- - pro-monthly
- - pro-yearly
- - ultra-monthly
- - ultra-yearly
- - pro-lifetime
- - 20k-monthly
- - 100k-monthly
- - 50k-monthly
- - 200k-monthly
- - 20k-yearly
+ - free
+ - pro-monthly
+ - pro-yearly
+ - ultra-monthly
+ - ultra-yearly
+ - pro-lifetime
+ - 20k-monthly
+ - 100k-monthly
+ - 50k-monthly
+ - 200k-monthly
+ - 20k-yearly
type: string
x-enum-varnames:
- - SubscriptionNameFree
- - SubscriptionNameProMonthly
- - SubscriptionNameProYearly
- - SubscriptionNameUltraMonthly
- - SubscriptionNameUltraYearly
- - SubscriptionNameProLifetime
- - SubscriptionName20KMonthly
- - SubscriptionName100KMonthly
- - SubscriptionName50KMonthly
- - SubscriptionName200KMonthly
- - SubscriptionName20KYearly
+ - SubscriptionNameFree
+ - SubscriptionNameProMonthly
+ - SubscriptionNameProYearly
+ - SubscriptionNameUltraMonthly
+ - SubscriptionNameUltraYearly
+ - SubscriptionNameProLifetime
+ - SubscriptionName20KMonthly
+ - SubscriptionName100KMonthly
+ - SubscriptionName50KMonthly
+ - SubscriptionName200KMonthly
+ - SubscriptionName20KYearly
entities.User:
properties:
active_phone_id:
@@ -435,7 +489,7 @@ definitions:
type: string
subscription_name:
allOf:
- - $ref: "#/definitions/entities.SubscriptionName"
+ - $ref: '#/definitions/entities.SubscriptionName'
example: free
subscription_renews_at:
example: "2022-06-05T14:26:02.302718+03:00"
@@ -450,18 +504,18 @@ definitions:
example: "2022-06-05T14:26:10.303278+03:00"
type: string
required:
- - api_key
- - created_at
- - email
- - id
- - notification_heartbeat_enabled
- - notification_message_status_enabled
- - notification_newsletter_enabled
- - notification_webhook_enabled
- - subscription_id
- - subscription_name
- - timezone
- - updated_at
+ - api_key
+ - created_at
+ - email
+ - id
+ - notification_heartbeat_enabled
+ - notification_message_status_enabled
+ - notification_newsletter_enabled
+ - notification_webhook_enabled
+ - subscription_id
+ - subscription_name
+ - timezone
+ - updated_at
type: object
entities.Webhook:
properties:
@@ -470,7 +524,7 @@ definitions:
type: string
events:
example:
- - message.phone.received
+ - message.phone.received
items:
type: string
type: array
@@ -479,8 +533,8 @@ definitions:
type: string
phone_numbers:
example:
- - "+18005550199"
- - "+18005550100"
+ - "+18005550199"
+ - "+18005550100"
items:
type: string
type: array
@@ -497,14 +551,14 @@ definitions:
example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC
type: string
required:
- - created_at
- - events
- - id
- - phone_numbers
- - signing_key
- - updated_at
- - url
- - user_id
+ - created_at
+ - events
+ - id
+ - phone_numbers
+ - signing_key
+ - updated_at
+ - url
+ - user_id
type: object
requests.DiscordStore:
properties:
@@ -515,9 +569,9 @@ definitions:
server_id:
type: string
required:
- - incoming_channel_id
- - name
- - server_id
+ - incoming_channel_id
+ - name
+ - server_id
type: object
requests.DiscordUpdate:
properties:
@@ -528,9 +582,9 @@ definitions:
server_id:
type: string
required:
- - incoming_channel_id
- - name
- - server_id
+ - incoming_channel_id
+ - name
+ - server_id
type: object
requests.HeartbeatStore:
properties:
@@ -541,8 +595,8 @@ definitions:
type: string
type: array
required:
- - charging
- - phone_numbers
+ - charging
+ - phone_numbers
type: object
requests.MessageAttachment:
properties:
@@ -559,15 +613,14 @@ definitions:
example: photo.jpg
type: string
required:
- - content
- - content_type
- - name
+ - content
+ - content_type
+ - name
type: object
requests.MessageBulkSend:
properties:
attachments:
- description:
- Attachments are optional. When you provide a list of attachments,
+ description: Attachments are optional. When you provide a list of attachments,
the message will be sent out as an MMS
items:
type: string
@@ -576,8 +629,7 @@ definitions:
example: This is a sample text message
type: string
encrypted:
- description:
- Encrypted is used to determine if the content is end-to-end encrypted.
+ description: Encrypted is used to determine if the content is end-to-end encrypted.
Make sure to set the encryption key on the httpSMS mobile app
example: false
type: boolean
@@ -585,22 +637,21 @@ definitions:
example: "+18005550199"
type: string
request_id:
- description:
- RequestID is an optional parameter used to track a request from
+ description: RequestID is an optional parameter used to track a request from
the client's perspective
example: 153554b5-ae44-44a0-8f4f-7bbac5657ad4
type: string
to:
example:
- - "+18005550100"
- - "+18005550100"
+ - "+18005550100"
+ - "+18005550100"
items:
type: string
type: array
required:
- - content
- - from
- - to
+ - content
+ - from
+ - to
type: object
requests.MessageCallMissed:
properties:
@@ -617,10 +668,10 @@ definitions:
example: "+18005550100"
type: string
required:
- - from
- - sim
- - timestamp
- - to
+ - from
+ - sim
+ - timestamp
+ - to
type: object
requests.MessageEvent:
properties:
@@ -636,31 +687,28 @@ definitions:
description: Reason is the exact error message in case the event is an error
type: string
timestamp:
- description:
- Timestamp is the time when the event was emitted, Please send
+ description: Timestamp is the time when the event was emitted, Please send
the timestamp in UTC with as much precision as possible
example: "2022-06-05T14:26:09.527976+03:00"
type: string
required:
- - event_name
- - reason
- - timestamp
+ - event_name
+ - reason
+ - timestamp
type: object
requests.MessageReceive:
properties:
attachments:
- description:
- Attachments is the list of MMS attachments received with the
+ description: Attachments is the list of MMS attachments received with the
message
items:
- $ref: "#/definitions/requests.MessageAttachment"
+ $ref: '#/definitions/requests.MessageAttachment'
type: array
content:
example: This is a sample text message received on a phone
type: string
encrypted:
- description:
- Encrypted is used to determine if the content is end-to-end encrypted.
+ description: Encrypted is used to determine if the content is end-to-end encrypted.
Make sure to set the encryption key on the httpSMS mobile app
example: false
type: boolean
@@ -669,12 +717,11 @@ definitions:
type: string
sim:
allOf:
- - $ref: "#/definitions/entities.SIM"
+ - $ref: '#/definitions/entities.SIM'
description: SIM card that received the message
example: SIM1
timestamp:
- description:
- Timestamp is the time when the event was emitted, Please send
+ description: Timestamp is the time when the event was emitted, Please send
the timestamp in UTC with as much precision as possible
example: "2022-06-05T14:26:09.527976+03:00"
type: string
@@ -682,22 +729,21 @@ definitions:
example: "+18005550100"
type: string
required:
- - content
- - encrypted
- - from
- - sim
- - timestamp
- - to
+ - content
+ - encrypted
+ - from
+ - sim
+ - timestamp
+ - to
type: object
requests.MessageSend:
properties:
attachments:
- description:
- Attachments are optional. When you provide a list of attachments,
+ description: Attachments are optional. When you provide a list of attachments,
the message will be sent out as an MMS
example:
- - https://example.com/image.jpg
- - https://example.com/video.mp4
+ - https://example.com/image.jpg
+ - https://example.com/video.mp4
items:
type: string
type: array
@@ -705,8 +751,7 @@ definitions:
example: This is a sample text message
type: string
encrypted:
- description:
- Encrypted is an optional parameter used to determine if the content
+ description: Encrypted is an optional parameter used to determine if the content
is end-to-end encrypted. Make sure to set the encryption key on the httpSMS
mobile app
example: false
@@ -715,14 +760,12 @@ definitions:
example: "+18005550199"
type: string
request_id:
- description:
- RequestID is an optional parameter used to track a request from
+ description: RequestID is an optional parameter used to track a request from
the client's perspective
example: 153554b5-ae44-44a0-8f4f-7bbac5657ad4
type: string
send_at:
- description:
- SendAt is an optional parameter used to schedule a message to
+ description: SendAt is an optional parameter used to schedule a message to
be sent in the future. The time is considered to be in your profile's local
timezone and you can queue messages for up to 20 days (480 hours) in the
future.
@@ -732,9 +775,9 @@ definitions:
example: "+18005550100"
type: string
required:
- - content
- - from
- - to
+ - content
+ - from
+ - to
type: object
requests.MessageThreadUpdate:
properties:
@@ -742,7 +785,7 @@ definitions:
example: true
type: boolean
required:
- - is_archived
+ - is_archived
type: object
requests.PhoneAPIKeyStoreRequest:
properties:
@@ -750,7 +793,7 @@ definitions:
example: My Phone API Key
type: string
required:
- - name
+ - name
type: object
requests.PhoneFCMToken:
properties:
@@ -758,18 +801,17 @@ definitions:
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd.....
type: string
phone_number:
- example: "[+18005550199]"
+ example: '[+18005550199]'
type: string
sim:
- description:
- SIM is the SIM slot of the phone in case the phone has more than
+ description: SIM is the SIM slot of the phone in case the phone has more than
1 SIM slot
example: SIM1
type: string
required:
- - fcm_token
- - phone_number
- - sim
+ - fcm_token
+ - phone_number
+ - sim
type: object
requests.PhoneUpsert:
properties:
@@ -777,14 +819,12 @@ definitions:
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd.....
type: string
max_send_attempts:
- description:
- MaxSendAttempts is the number of attempts when sending an SMS
+ description: MaxSendAttempts is the number of attempts when sending an SMS
message to handle the case where the phone is offline.
example: 2
type: integer
message_expiration_seconds:
- description:
- MessageExpirationSeconds is the duration in seconds after sending
+ description: MessageExpirationSeconds is the duration in seconds after sending
a message when it is considered to be expired.
example: 12345
type: integer
@@ -797,20 +837,54 @@ definitions:
phone_number:
example: "+18005550199"
type: string
+ schedule_id:
+ example: 32343a19-da5e-4b1b-a767-3298a73703cb
+ type: string
sim:
- description:
- SIM is the SIM slot of the phone in case the phone has more than
+ description: SIM is the SIM slot of the phone in case the phone has more than
1 SIM slot
example: SIM1
type: string
required:
- - fcm_token
- - max_send_attempts
- - message_expiration_seconds
- - messages_per_minute
- - missed_call_auto_reply
- - phone_number
- - sim
+ - fcm_token
+ - max_send_attempts
+ - message_expiration_seconds
+ - messages_per_minute
+ - missed_call_auto_reply
+ - phone_number
+ - schedule_id
+ - sim
+ type: object
+ requests.SendScheduleStore:
+ properties:
+ is_active:
+ type: boolean
+ name:
+ type: string
+ timezone:
+ type: string
+ windows:
+ items:
+ $ref: '#/definitions/requests.SendScheduleWindow'
+ type: array
+ required:
+ - is_active
+ - name
+ - timezone
+ - windows
+ type: object
+ requests.SendScheduleWindow:
+ properties:
+ day_of_week:
+ type: integer
+ end_minute:
+ type: integer
+ start_minute:
+ type: integer
+ required:
+ - day_of_week
+ - end_minute
+ - start_minute
type: object
requests.UserNotificationUpdate:
properties:
@@ -827,10 +901,10 @@ definitions:
example: true
type: boolean
required:
- - heartbeat_enabled
- - message_status_enabled
- - newsletter_enabled
- - webhook_enabled
+ - heartbeat_enabled
+ - message_status_enabled
+ - newsletter_enabled
+ - webhook_enabled
type: object
requests.UserPaymentInvoice:
properties:
@@ -856,13 +930,13 @@ definitions:
example: "9800"
type: string
required:
- - address
- - city
- - country
- - name
- - notes
- - state
- - zip_code
+ - address
+ - city
+ - country
+ - name
+ - notes
+ - state
+ - zip_code
type: object
requests.UserUpdate:
properties:
@@ -873,8 +947,8 @@ definitions:
example: Europe/Helsinki
type: string
required:
- - active_phone_id
- - timezone
+ - active_phone_id
+ - timezone
type: object
requests.WebhookStore:
properties:
@@ -884,8 +958,8 @@ definitions:
type: array
phone_numbers:
example:
- - "+18005550100"
- - "+18005550100"
+ - "+18005550100"
+ - "+18005550100"
items:
type: string
type: array
@@ -894,10 +968,10 @@ definitions:
url:
type: string
required:
- - events
- - phone_numbers
- - signing_key
- - url
+ - events
+ - phone_numbers
+ - signing_key
+ - url
type: object
requests.WebhookUpdate:
properties:
@@ -907,8 +981,8 @@ definitions:
type: array
phone_numbers:
example:
- - "+18005550100"
- - "+18005550100"
+ - "+18005550100"
+ - "+18005550100"
items:
type: string
type: array
@@ -917,10 +991,10 @@ definitions:
url:
type: string
required:
- - events
- - phone_numbers
- - signing_key
- - url
+ - events
+ - phone_numbers
+ - signing_key
+ - url
type: object
responses.BadRequest:
properties:
@@ -934,14 +1008,14 @@ definitions:
example: error
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.BillingUsageResponse:
properties:
data:
- $ref: "#/definitions/entities.BillingUsage"
+ $ref: '#/definitions/entities.BillingUsage'
message:
example: Request handled successfully
type: string
@@ -949,15 +1023,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.BillingUsagesResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.BillingUsage"
+ $ref: '#/definitions/entities.BillingUsage'
type: array
message:
example: Request handled successfully
@@ -966,14 +1040,14 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.DiscordResponse:
properties:
data:
- $ref: "#/definitions/entities.Discord"
+ $ref: '#/definitions/entities.Discord'
message:
example: Request handled successfully
type: string
@@ -981,15 +1055,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.DiscordsResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.Discord"
+ $ref: '#/definitions/entities.Discord'
type: array
message:
example: Request handled successfully
@@ -998,14 +1072,14 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.HeartbeatResponse:
properties:
data:
- $ref: "#/definitions/entities.Heartbeat"
+ $ref: '#/definitions/entities.Heartbeat'
message:
example: Request handled successfully
type: string
@@ -1013,15 +1087,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.HeartbeatsResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.Heartbeat"
+ $ref: '#/definitions/entities.Heartbeat'
type: array
message:
example: Request handled successfully
@@ -1030,9 +1104,9 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.InternalServerError:
properties:
@@ -1043,13 +1117,13 @@ definitions:
example: error
type: string
required:
- - message
- - status
+ - message
+ - status
type: object
responses.MessageResponse:
properties:
data:
- $ref: "#/definitions/entities.Message"
+ $ref: '#/definitions/entities.Message'
message:
example: Request handled successfully
type: string
@@ -1057,15 +1131,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.MessageThreadsResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.MessageThread"
+ $ref: '#/definitions/entities.MessageThread'
type: array
message:
example: Request handled successfully
@@ -1074,15 +1148,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.MessagesResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.Message"
+ $ref: '#/definitions/entities.Message'
type: array
message:
example: Request handled successfully
@@ -1091,9 +1165,9 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.NoContent:
properties:
@@ -1104,8 +1178,8 @@ definitions:
example: success
type: string
required:
- - message
- - status
+ - message
+ - status
type: object
responses.NotFound:
properties:
@@ -1116,8 +1190,8 @@ definitions:
example: error
type: string
required:
- - message
- - status
+ - message
+ - status
type: object
responses.OkString:
properties:
@@ -1130,14 +1204,14 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.PhoneAPIKeyResponse:
properties:
data:
- $ref: "#/definitions/entities.PhoneAPIKey"
+ $ref: '#/definitions/entities.PhoneAPIKey'
message:
example: Request handled successfully
type: string
@@ -1145,15 +1219,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.PhoneAPIKeysResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.PhoneAPIKey"
+ $ref: '#/definitions/entities.PhoneAPIKey'
type: array
message:
example: Request handled successfully
@@ -1162,14 +1236,14 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.PhoneResponse:
properties:
data:
- $ref: "#/definitions/entities.Phone"
+ $ref: '#/definitions/entities.Phone'
message:
example: Request handled successfully
type: string
@@ -1177,15 +1251,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.PhonesResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.Phone"
+ $ref: '#/definitions/entities.Phone'
type: array
message:
example: Request handled successfully
@@ -1194,9 +1268,24 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
+ type: object
+ responses.SendScheduleResponse:
+ properties:
+ data:
+ $ref: '#/definitions/entities.MessageSendSchedule'
+ message:
+ example: Request handled successfully
+ type: string
+ status:
+ example: success
+ type: string
+ required:
+ - data
+ - message
+ - status
type: object
responses.Unauthorized:
properties:
@@ -1210,9 +1299,9 @@ definitions:
example: error
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.UnprocessableEntity:
properties:
@@ -1229,14 +1318,14 @@ definitions:
example: error
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.UserResponse:
properties:
data:
- $ref: "#/definitions/entities.User"
+ $ref: '#/definitions/entities.User'
message:
example: Request handled successfully
type: string
@@ -1244,9 +1333,9 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.UserSubscriptionPaymentsResponse:
properties:
@@ -1309,42 +1398,42 @@ definitions:
updated_at:
type: string
required:
- - billing_reason
- - card_brand
- - card_last_four
- - created_at
- - currency
- - currency_rate
- - discount_total
- - discount_total_formatted
- - discount_total_usd
- - refunded
- - refunded_amount
- - refunded_amount_formatted
- - refunded_amount_usd
- - refunded_at
- - status
- - status_formatted
- - subtotal
- - subtotal_formatted
- - subtotal_usd
- - tax
- - tax_formatted
- - tax_inclusive
- - tax_usd
- - total
- - total_formatted
- - total_usd
- - updated_at
+ - billing_reason
+ - card_brand
+ - card_last_four
+ - created_at
+ - currency
+ - currency_rate
+ - discount_total
+ - discount_total_formatted
+ - discount_total_usd
+ - refunded
+ - refunded_amount
+ - refunded_amount_formatted
+ - refunded_amount_usd
+ - refunded_at
+ - status
+ - status_formatted
+ - subtotal
+ - subtotal_formatted
+ - subtotal_usd
+ - tax
+ - tax_formatted
+ - tax_inclusive
+ - tax_usd
+ - total
+ - total_formatted
+ - total_usd
+ - updated_at
type: object
id:
type: string
type:
type: string
required:
- - attributes
- - id
- - type
+ - attributes
+ - id
+ - type
type: object
type: array
message:
@@ -1354,14 +1443,14 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.WebhookResponse:
properties:
data:
- $ref: "#/definitions/entities.Webhook"
+ $ref: '#/definitions/entities.Webhook'
message:
example: Request handled successfully
type: string
@@ -1369,15 +1458,15 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
responses.WebhooksResponse:
properties:
data:
items:
- $ref: "#/definitions/entities.Webhook"
+ $ref: '#/definitions/entities.Webhook'
type: array
message:
example: Request handled successfully
@@ -1386,17 +1475,16 @@ definitions:
example: success
type: string
required:
- - data
- - message
- - status
+ - data
+ - message
+ - status
type: object
host: api.httpsms.com
info:
contact:
email: support@httpsms.com
name: support@httpsms.com
- description:
- Use your Android phone to send and receive SMS messages via a simple
+ description: Use your Android phone to send and receive SMS messages via a simple
programmable API with end-to-end encryption.
license:
name: AGPL-3.0
@@ -1407,1708 +1495,1834 @@ paths:
/billing/usage:
get:
consumes:
- - application/json
- description:
- Get the summary of sent and received messages for a user in the
+ - application/json
+ description: Get the summary of sent and received messages for a user in the
current month
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.BillingUsageResponse"
+ $ref: '#/definitions/responses.BillingUsageResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get Billing Usage.
tags:
- - Billing
+ - Billing
/billing/usage-history:
get:
consumes:
- - application/json
- description:
- Get billing usage records of sent and received messages for a user
+ - application/json
+ description: Get billing usage records of sent and received messages for a user
in the past. It will be sorted by timestamp in descending order.
parameters:
- - description: number of heartbeats to skip
- in: query
- minimum: 0
- name: skip
- type: integer
- - description: number of heartbeats to return
- in: query
- maximum: 100
- minimum: 1
- name: limit
- type: integer
+ - description: number of heartbeats to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: number of heartbeats to return
+ in: query
+ maximum: 100
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.BillingUsagesResponse"
+ $ref: '#/definitions/responses.BillingUsagesResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get billing usage history.
tags:
- - Billing
+ - Billing
/bulk-messages:
post:
consumes:
- - multipart/form-data
- description:
- Sends bulk SMS messages to multiple users based on our [CSV template](https://httpsms.com/templates/httpsms-bulk.csv)
+ - multipart/form-data
+ description: Sends bulk SMS messages to multiple users based on our [CSV template](https://httpsms.com/templates/httpsms-bulk.csv)
or our [Excel template](https://httpsms.com/templates/httpsms-bulk.xlsx).
parameters:
- - description: The Excel or CSV file containing the messages to be sent.
- in: formData
- name: document
- required: true
- type: file
+ - description: The Excel or CSV file containing the messages to be sent.
+ in: formData
+ name: document
+ required: true
+ type: file
produces:
- - application/json
+ - application/json
responses:
"202":
description: Accepted
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Store bulk SMS file
tags:
- - BulkSMS
+ - BulkSMS
/discord-integrations:
get:
consumes:
- - application/json
+ - application/json
description: Get the discord integrations of a user
parameters:
- - description: number of discord integrations to skip
- in: query
- minimum: 0
- name: skip
- type: integer
- - description: filter discord integrations containing query
- in: query
- name: query
- type: string
- - description: number of discord integrations to return
- in: query
- maximum: 20
- minimum: 1
- name: limit
- type: integer
+ - description: number of discord integrations to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: filter discord integrations containing query
+ in: query
+ name: query
+ type: string
+ - description: number of discord integrations to return
+ in: query
+ maximum: 20
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.DiscordsResponse"
+ $ref: '#/definitions/responses.DiscordsResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get discord integrations of a user
tags:
- - DiscordIntegration
+ - DiscordIntegration
post:
consumes:
- - application/json
+ - application/json
description: Store a discord integration for the authenticated user
parameters:
- - description: Payload of the discord integration request
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.DiscordStore"
+ - description: Payload of the discord integration request
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.DiscordStore'
produces:
- - application/json
+ - application/json
responses:
"201":
description: Created
schema:
- $ref: "#/definitions/responses.DiscordResponse"
+ $ref: '#/definitions/responses.DiscordResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Store discord integration
tags:
- - DiscordIntegration
+ - DiscordIntegration
/discord-integrations/{discordID}:
delete:
consumes:
- - application/json
+ - application/json
description: Delete a discord integration for a user
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the discord integration
- in: path
- name: discordID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the discord integration
+ in: path
+ name: discordID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Delete discord integration
tags:
- - Webhooks
+ - Webhooks
put:
consumes:
- - application/json
+ - application/json
description: Update a discord integration for the currently authenticated user
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the discord integration
- in: path
- name: discordID
- required: true
- type: string
- - description: Payload of discord integration to update
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.DiscordUpdate"
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the discord integration
+ in: path
+ name: discordID
+ required: true
+ type: string
+ - description: Payload of discord integration to update
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.DiscordUpdate'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.DiscordResponse"
+ $ref: '#/definitions/responses.DiscordResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Update a discord integration
tags:
- - DiscordIntegration
+ - DiscordIntegration
/discord/event:
post:
consumes:
- - application/json
+ - application/json
description: Publish a discord event to the registered listeners
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
summary: Consume a discord event
tags:
- - Discord
+ - Discord
/heartbeats:
get:
consumes:
- - application/json
- description:
- Get the last time a phone number requested for outstanding messages.
+ - application/json
+ description: Get the last time a phone number requested for outstanding messages.
It will be sorted by timestamp in descending order.
parameters:
- - default: "+18005550199"
- description: the owner's phone number
- in: query
- name: owner
- required: true
- type: string
- - description: number of heartbeats to skip
- in: query
- minimum: 0
- name: skip
- type: integer
- - description: filter containing query
- in: query
- name: query
- type: string
- - description: number of heartbeats to return
- in: query
- maximum: 20
- minimum: 1
- name: limit
- type: integer
+ - default: "+18005550199"
+ description: the owner's phone number
+ in: query
+ name: owner
+ required: true
+ type: string
+ - description: number of heartbeats to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: filter containing query
+ in: query
+ name: query
+ type: string
+ - description: number of heartbeats to return
+ in: query
+ maximum: 20
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.HeartbeatsResponse"
+ $ref: '#/definitions/responses.HeartbeatsResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get heartbeats of an owner phone number
tags:
- - Heartbeats
+ - Heartbeats
post:
consumes:
- - application/json
- description:
- Store the heartbeat to make notify that a phone number is still
+ - application/json
+ description: Store the heartbeat to make notify that a phone number is still
active
parameters:
- - description: Payload of the heartbeat request
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.HeartbeatStore"
+ - description: Payload of the heartbeat request
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.HeartbeatStore'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.HeartbeatResponse"
+ $ref: '#/definitions/responses.HeartbeatResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Register heartbeat of an owner phone number
tags:
- - Heartbeats
+ - Heartbeats
/integration/3cx/messages:
post:
consumes:
- - application/json
+ - application/json
description: Sends an SMS message from the 3CX platform
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
summary: Sends a 3CX SMS message
tags:
- - 3CXIntegration
+ - 3CXIntegration
/message-threads:
get:
consumes:
- - application/json
- description:
- Get list of contacts which a phone number has communicated with
+ - application/json
+ description: Get list of contacts which a phone number has communicated with
(threads). It will be sorted by timestamp in descending order.
parameters:
- - default: "+18005550199"
- description: owner phone number
- in: query
- name: owner
- required: true
- type: string
- - description: number of messages to skip
- in: query
- minimum: 0
- name: skip
- type: integer
- - description: filter message threads containing query
- in: query
- name: query
- type: string
- - description: number of messages to return
- in: query
- maximum: 20
- minimum: 1
- name: limit
- type: integer
+ - default: "+18005550199"
+ description: owner phone number
+ in: query
+ name: owner
+ required: true
+ type: string
+ - description: number of messages to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: filter message threads containing query
+ in: query
+ name: query
+ type: string
+ - description: number of messages to return
+ in: query
+ maximum: 20
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessageThreadsResponse"
+ $ref: '#/definitions/responses.MessageThreadsResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get message threads for a phone number
tags:
- - MessageThreads
+ - MessageThreads
/message-threads/{messageThreadID}:
delete:
consumes:
- - application/json
- description:
- Delete a message thread from the database and also deletes all
+ - application/json
+ description: Delete a message thread from the database and also deletes all
the messages in the thread.
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the message thread
- in: path
- name: messageThreadID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the message thread
+ in: path
+ name: messageThreadID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Delete a message thread from the database.
tags:
- - MessageThreads
+ - MessageThreads
put:
consumes:
- - application/json
+ - application/json
description: Updates the details of a message thread
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the message thread
- in: path
- name: messageThreadID
- required: true
- type: string
- - description: Payload of message thread details to update
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.MessageThreadUpdate"
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the message thread
+ in: path
+ name: messageThreadID
+ required: true
+ type: string
+ - description: Payload of message thread details to update
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.MessageThreadUpdate'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.PhoneResponse"
+ $ref: '#/definitions/responses.PhoneResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Update a message thread
tags:
- - MessageThreads
+ - MessageThreads
/messages:
get:
consumes:
- - application/json
- description:
- Get list of messages which are sent between 2 phone numbers. It
+ - application/json
+ description: Get list of messages which are sent between 2 phone numbers. It
will be sorted by timestamp in descending order.
parameters:
- - default: "+18005550199"
- description: the owner's phone number
- in: query
- name: owner
- required: true
- type: string
- - default: "+18005550100"
- description: the contact's phone number
- in: query
- name: contact
- 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: 20
- minimum: 1
- name: limit
- type: integer
+ - default: "+18005550199"
+ description: the owner's phone number
+ in: query
+ name: owner
+ required: true
+ type: string
+ - default: "+18005550100"
+ description: the contact's phone number
+ in: query
+ name: contact
+ 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: 20
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessagesResponse"
+ $ref: '#/definitions/responses.MessagesResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get messages which are sent between 2 phone numbers
tags:
- - Messages
+ - Messages
/messages/{messageID}:
delete:
consumes:
- - application/json
- description:
- Delete a message from the database and removes the message content
+ - application/json
+ description: Delete a message from the database and removes the message content
from the list of threads.
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the message
- in: path
- name: messageID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the message
+ in: path
+ name: messageID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Delete a message from the database.
tags:
- - Messages
+ - Messages
get:
consumes:
- - application/json
+ - application/json
description: Get a message from the database by the message ID.
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the message
- in: path
- name: messageID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the message
+ in: path
+ name: messageID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.MessageResponse"
+ $ref: '#/definitions/responses.MessageResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get a message from the database.
tags:
- - Messages
+ - Messages
/messages/{messageID}/events:
post:
consumes:
- - application/json
- description:
- Use this endpoint to send events for a message when it is failed,
+ - application/json
+ description: Use this endpoint to send events for a message when it is failed,
sent or delivered by the mobile phone.
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the message
- in: path
- name: messageID
- required: true
- type: string
- - description: Payload of the event emitted.
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.MessageEvent"
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the message
+ in: path
+ name: messageID
+ required: true
+ type: string
+ - description: Payload of the event emitted.
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.MessageEvent'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessageResponse"
+ $ref: '#/definitions/responses.MessageResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Upsert an event for a message on the mobile phone
tags:
- - Messages
+ - Messages
/messages/bulk-send:
post:
consumes:
- - application/json
+ - application/json
description: Add bulk SMS messages to be sent by the android phone
parameters:
- - description: Bulk send message request payload
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.MessageBulkSend"
+ - description: Bulk send message request payload
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.MessageBulkSend'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
items:
- $ref: "#/definitions/responses.MessagesResponse"
+ $ref: '#/definitions/responses.MessagesResponse'
type: array
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Send bulk SMS messages
tags:
- - Messages
+ - Messages
/messages/calls/missed:
post:
consumes:
- - application/json
- description:
- This endpoint is called by the httpSMS android app to register
+ - application/json
+ description: This endpoint is called by the httpSMS android app to register
a missed call event on the mobile phone.
parameters:
- - description: Payload of the missed call event.
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.MessageCallMissed"
+ - description: Payload of the missed call event.
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.MessageCallMissed'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessageResponse"
+ $ref: '#/definitions/responses.MessageResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Register a missed call event on the mobile phone
tags:
- - Messages
+ - Messages
/messages/outstanding:
get:
consumes:
- - application/json
+ - application/json
description: Get an outstanding message to be sent by an android phone
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703cb
- description: The ID of the message
- in: query
- name: message_id
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703cb
+ description: The ID of the message
+ in: query
+ name: message_id
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessageResponse"
+ $ref: '#/definitions/responses.MessageResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get an outstanding message
tags:
- - Messages
+ - Messages
/messages/receive:
post:
consumes:
- - application/json
+ - application/json
description: Add a new message received from a mobile phone
parameters:
- - description: Received message request payload
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.MessageReceive"
+ - description: Received message request payload
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.MessageReceive'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessageResponse"
+ $ref: '#/definitions/responses.MessageResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Receive a new SMS message from a mobile phone
tags:
- - Messages
+ - Messages
/messages/search:
get:
consumes:
- - application/json
- description:
- This returns the list of all messages based on the filter criteria
+ - application/json
+ description: This returns the list of all messages based on the filter criteria
including missed calls
parameters:
- - description: Cloudflare turnstile token https://www.cloudflare.com/en-gb/application-services/products/turnstile/
- in: header
- name: token
- required: true
- type: string
- - 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
+ - description: Cloudflare turnstile token https://www.cloudflare.com/en-gb/application-services/products/turnstile/
+ in: header
+ name: token
+ required: true
+ type: string
+ - 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
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessagesResponse"
+ $ref: '#/definitions/responses.MessagesResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Search all messages of a user
tags:
- - Messages
+ - Messages
/messages/send:
post:
consumes:
- - application/json
+ - application/json
description: Add a new SMS message to be sent by your Android phone
parameters:
- - description: Send message request payload
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.MessageSend"
+ - description: Send message request payload
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.MessageSend'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.MessageResponse"
+ $ref: '#/definitions/responses.MessageResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Send an SMS message
tags:
- - Messages
+ - Messages
/phone-api-keys:
get:
consumes:
- - application/json
- description:
- Get list phone API keys which a user has registered on the httpSMS
+ - application/json
+ description: Get list phone API keys which a user has registered on the httpSMS
application
parameters:
- - description: number of phone api keys to skip
- in: query
- minimum: 0
- name: skip
- type: integer
- - description: filter phone api keys with name containing query
- in: query
- name: query
- type: string
- - description: number of phone api keys to return
- in: query
- maximum: 100
- minimum: 1
- name: limit
- type: integer
+ - description: number of phone api keys to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: filter phone api keys with name containing query
+ in: query
+ name: query
+ type: string
+ - description: number of phone api keys to return
+ in: query
+ maximum: 100
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.PhoneAPIKeysResponse"
+ $ref: '#/definitions/responses.PhoneAPIKeysResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get the phone API keys of a user
tags:
- - PhoneAPIKeys
+ - PhoneAPIKeys
post:
consumes:
- - application/json
- description:
- Creates a new phone API key which can be used to log in to the
+ - application/json
+ description: Creates a new phone API key which can be used to log in to the
httpSMS app on your Android phone
parameters:
- - description: Payload of new phone API key.
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.PhoneAPIKeyStoreRequest"
+ - description: Payload of new phone API key.
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.PhoneAPIKeyStoreRequest'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.PhoneAPIKeyResponse"
+ $ref: '#/definitions/responses.PhoneAPIKeyResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Store phone API key
tags:
- - PhoneAPIKeys
+ - PhoneAPIKeys
/phone-api-keys/{phoneAPIKeyID}:
delete:
consumes:
- - application/json
- description:
- Delete a phone API Key from the database and cannot be used for
+ - application/json
+ description: Delete a phone API Key from the database and cannot be used for
authentication anymore.
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the phone API key
- in: path
- name: phoneAPIKeyID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the phone API key
+ in: path
+ name: phoneAPIKeyID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Delete a phone API key from the database.
tags:
- - PhoneAPIKeys
+ - PhoneAPIKeys
/phone-api-keys/{phoneAPIKeyID}/phones/{phoneID}:
delete:
consumes:
- - application/json
- description:
- You will need to login again to the httpSMS app on your Android
+ - application/json
+ description: You will need to login again to the httpSMS app on your Android
phone with a new phone API key.
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the phone API key
- in: path
- name: phoneAPIKeyID
- required: true
- type: string
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the phone
- in: path
- name: phoneID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the phone API key
+ in: path
+ name: phoneAPIKeyID
+ required: true
+ type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the phone
+ in: path
+ name: phoneID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Remove the association of a phone from the phone API key.
tags:
- - PhoneAPIKeys
+ - PhoneAPIKeys
/phones:
get:
consumes:
- - application/json
- description:
- Get list of phones which a user has registered on the http sms
+ - application/json
+ description: Get list of phones which a user has registered on the http sms
application
parameters:
- - description: number of heartbeats to skip
- in: query
- minimum: 0
- name: skip
- type: integer
- - description: filter phones containing query
- in: query
- name: query
- type: string
- - description: number of phones to return
- in: query
- maximum: 20
- minimum: 1
- name: limit
- type: integer
+ - description: number of heartbeats to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: filter phones containing query
+ in: query
+ name: query
+ type: string
+ - description: number of phones to return
+ in: query
+ maximum: 20
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.PhonesResponse"
+ $ref: '#/definitions/responses.PhonesResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get phones of a user
tags:
- - Phones
+ - Phones
put:
consumes:
- - application/json
- description:
- Updates properties of a user's phone. If the phone with this number
+ - application/json
+ description: Updates properties of a user's phone. If the phone with this number
does not exist, a new one will be created. Think of this method like an 'upsert'
parameters:
- - description: Payload of new phone number.
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.PhoneUpsert"
+ - description: Payload of new phone number.
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.PhoneUpsert'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.PhoneResponse"
+ $ref: '#/definitions/responses.PhoneResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Upsert Phone
tags:
- - Phones
+ - Phones
/phones/{phoneID}:
delete:
consumes:
- - application/json
+ - application/json
description: Delete a phone that has been sored in the database
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the phone
- in: path
- name: phoneID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the phone
+ in: path
+ name: phoneID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Delete Phone
tags:
- - Phones
+ - Phones
/phones/fcm-token:
put:
consumes:
- - application/json
- description:
- Updates the FCM token of a phone. If the phone with this number
+ - application/json
+ description: Updates the FCM token of a phone. If the phone with this number
does not exist, a new one will be created. Think of this method like an 'upsert'
parameters:
- - description: Payload of new FCM token.
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.PhoneFCMToken"
+ - description: Payload of new FCM token.
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.PhoneFCMToken'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.PhoneResponse"
+ $ref: '#/definitions/responses.PhoneResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Upserts the FCM token of a phone
tags:
- - Phones
+ - Phones
+ /send-schedules:
+ get:
+ description: List all send schedules owned by the authenticated user.
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: OK
+ schema:
+ items:
+ $ref: '#/definitions/entities.MessageSendSchedule'
+ type: array
+ "401":
+ description: Unauthorized
+ schema:
+ $ref: '#/definitions/responses.Unauthorized'
+ "500":
+ description: Internal Server Error
+ schema:
+ $ref: '#/definitions/responses.InternalServerError'
+ security:
+ - ApiKeyAuth: []
+ summary: List send schedules
+ tags:
+ - Send Schedules
+ post:
+ consumes:
+ - application/json
+ description: Create a new send schedule for the authenticated user.
+ parameters:
+ - description: Payload of new send schedule.
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.SendScheduleStore'
+ produces:
+ - application/json
+ responses:
+ "201":
+ description: Created
+ schema:
+ $ref: '#/definitions/responses.SendScheduleResponse'
+ "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: Create send schedule
+ tags:
+ - Send Schedules
+ /send-schedules/{scheduleID}:
+ delete:
+ description: Delete a send schedule owned by the authenticated user.
+ parameters:
+ - description: Schedule ID
+ in: path
+ name: scheduleID
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "204":
+ description: No Content
+ "400":
+ description: Bad Request
+ schema:
+ $ref: '#/definitions/responses.BadRequest'
+ "401":
+ description: Unauthorized
+ schema:
+ $ref: '#/definitions/responses.Unauthorized'
+ "404":
+ description: Not Found
+ schema:
+ $ref: '#/definitions/responses.NotFound'
+ "500":
+ description: Internal Server Error
+ schema:
+ $ref: '#/definitions/responses.InternalServerError'
+ security:
+ - ApiKeyAuth: []
+ summary: Delete send schedule
+ tags:
+ - Send Schedules
+ put:
+ consumes:
+ - application/json
+ description: Update a send schedule owned by the authenticated user.
+ parameters:
+ - description: Schedule ID
+ in: path
+ name: scheduleID
+ required: true
+ type: string
+ - description: Payload of updated send schedule.
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.SendScheduleStore'
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: OK
+ schema:
+ $ref: '#/definitions/responses.SendScheduleResponse'
+ "400":
+ description: Bad Request
+ schema:
+ $ref: '#/definitions/responses.BadRequest'
+ "401":
+ description: Unauthorized
+ schema:
+ $ref: '#/definitions/responses.Unauthorized'
+ "404":
+ description: Not Found
+ schema:
+ $ref: '#/definitions/responses.NotFound'
+ "422":
+ description: Unprocessable Entity
+ schema:
+ $ref: '#/definitions/responses.UnprocessableEntity'
+ "500":
+ description: Internal Server Error
+ schema:
+ $ref: '#/definitions/responses.InternalServerError'
+ security:
+ - ApiKeyAuth: []
+ summary: Update send schedule
+ tags:
+ - Send Schedules
/users/{userID}/api-keys:
delete:
consumes:
- - application/json
+ - 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
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the user to update
+ in: path
+ name: userID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.UserResponse"
+ $ref: '#/definitions/responses.UserResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Rotate the user's API Key
tags:
- - Users
+ - Users
/users/{userID}/notifications:
put:
consumes:
- - application/json
+ - application/json
description: Update the email notification settings for a user
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the user to update
- in: path
- name: userID
- required: true
- type: string
- - description: User notification details to update
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.UserNotificationUpdate"
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the user to update
+ in: path
+ name: userID
+ required: true
+ type: string
+ - description: User notification details to update
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.UserNotificationUpdate'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.UserResponse"
+ $ref: '#/definitions/responses.UserResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Update notification settings
tags:
- - Users
+ - Users
/users/me:
delete:
consumes:
- - application/json
- description:
- Deletes the currently authenticated user together with all their
+ - application/json
+ description: Deletes the currently authenticated user together with all their
data.
produces:
- - application/json
+ - application/json
responses:
"201":
description: Created
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Delete a user
tags:
- - Users
+ - Users
get:
consumes:
- - application/json
+ - application/json
description: Get details of the currently authenticated user
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.UserResponse"
+ $ref: '#/definitions/responses.UserResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get current user
tags:
- - Users
+ - Users
put:
consumes:
- - application/json
+ - application/json
description: Updates the details of the currently authenticated user
parameters:
- - description: Payload of user details to update
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.UserUpdate"
+ - description: Payload of user details to update
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.UserUpdate'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.PhoneResponse"
+ $ref: '#/definitions/responses.PhoneResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Update a user
tags:
- - Users
+ - Users
/users/subscription:
delete:
description: Cancel the subscription of the authenticated user.
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Cancel the user's subscription
tags:
- - Users
+ - Users
/users/subscription-update-url:
get:
description: Fetches the subscription URL of the authenticated user.
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.OkString"
+ $ref: '#/definitions/responses.OkString'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Currently authenticated user subscription update URL
tags:
- - Users
+ - Users
/users/subscription/invoices/{subscriptionInvoiceID}:
post:
consumes:
- - application/json
- description:
- Generates a new invoice PDF file for the given subscription payment
+ - application/json
+ description: Generates a new invoice PDF file for the given subscription payment
with given parameters.
parameters:
- - description: Generate subscription payment invoice parameters
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.UserPaymentInvoice"
- - description: ID of the subscription invoice to generate the PDF for
- in: path
- name: subscriptionInvoiceID
- required: true
- type: string
+ - description: Generate subscription payment invoice parameters
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.UserPaymentInvoice'
+ - description: ID of the subscription invoice to generate the PDF for
+ in: path
+ name: subscriptionInvoiceID
+ required: true
+ type: string
produces:
- - application/pdf
+ - application/pdf
responses:
"200":
description: OK
@@ -3117,86 +3331,85 @@ paths:
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Generate a subscription payment invoice
tags:
- - Users
+ - Users
/users/subscription/payments:
get:
consumes:
- - application/json
- description:
- Subscription payments are generated throughout the lifecycle of
+ - application/json
+ description: Subscription payments are generated throughout the lifecycle of
a subscription, typically there is one at the time of purchase and then one
for each renewal.
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.UserSubscriptionPaymentsResponse"
+ $ref: '#/definitions/responses.UserSubscriptionPaymentsResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get the last 10 subscription payments.
tags:
- - Users
+ - Users
/v1/attachments/{userID}/{messageID}/{attachmentIndex}/{filename}:
get:
description: Download an MMS attachment by its path components
parameters:
- - description: User ID
- in: path
- name: userID
- required: true
- type: string
- - description: Message ID
- in: path
- name: messageID
- required: true
- type: string
- - description: Attachment index
- in: path
- name: attachmentIndex
- required: true
- type: string
- - description: Filename with extension
- in: path
- name: filename
- required: true
- type: string
+ - description: User ID
+ in: path
+ name: userID
+ required: true
+ type: string
+ - description: Message ID
+ in: path
+ name: messageID
+ required: true
+ type: string
+ - description: Attachment index
+ in: path
+ name: attachmentIndex
+ required: true
+ type: string
+ - description: Filename with extension
+ in: path
+ name: filename
+ required: true
+ type: string
produces:
- - application/octet-stream
+ - application/octet-stream
responses:
"200":
description: OK
@@ -3205,189 +3418,189 @@ paths:
"404":
description: Not Found
schema:
- $ref: "#/definitions/responses.NotFound"
+ $ref: '#/definitions/responses.NotFound'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
summary: Download a message attachment
tags:
- - Attachments
+ - Attachments
/webhooks:
get:
consumes:
- - application/json
+ - application/json
description: Get the webhooks of a user
parameters:
- - description: number of webhooks to skip
- in: query
- minimum: 0
- name: skip
- type: integer
- - description: filter webhooks containing query
- in: query
- name: query
- type: string
- - description: number of webhooks to return
- in: query
- maximum: 20
- minimum: 1
- name: limit
- type: integer
+ - description: number of webhooks to skip
+ in: query
+ minimum: 0
+ name: skip
+ type: integer
+ - description: filter webhooks containing query
+ in: query
+ name: query
+ type: string
+ - description: number of webhooks to return
+ in: query
+ maximum: 20
+ minimum: 1
+ name: limit
+ type: integer
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.WebhooksResponse"
+ $ref: '#/definitions/responses.WebhooksResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Get webhooks of a user
tags:
- - Webhooks
+ - Webhooks
post:
consumes:
- - application/json
+ - application/json
description: Store a webhook for the authenticated user
parameters:
- - description: Payload of the webhook request
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.WebhookStore"
+ - description: Payload of the webhook request
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.WebhookStore'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.WebhookResponse"
+ $ref: '#/definitions/responses.WebhookResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Store a webhook
tags:
- - Webhooks
+ - Webhooks
/webhooks/{webhookID}:
delete:
consumes:
- - application/json
+ - application/json
description: Delete a webhook for a user
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the webhook
- in: path
- name: webhookID
- required: true
- type: string
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the webhook
+ in: path
+ name: webhookID
+ required: true
+ type: string
produces:
- - application/json
+ - application/json
responses:
"204":
description: No Content
schema:
- $ref: "#/definitions/responses.NoContent"
+ $ref: '#/definitions/responses.NoContent'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Delete webhook
tags:
- - Webhooks
+ - Webhooks
put:
consumes:
- - application/json
+ - application/json
description: Update a webhook for the currently authenticated user
parameters:
- - default: 32343a19-da5e-4b1b-a767-3298a73703ca
- description: ID of the webhook
- in: path
- name: webhookID
- required: true
- type: string
- - description: Payload of webhook details to update
- in: body
- name: payload
- required: true
- schema:
- $ref: "#/definitions/requests.WebhookUpdate"
+ - default: 32343a19-da5e-4b1b-a767-3298a73703ca
+ description: ID of the webhook
+ in: path
+ name: webhookID
+ required: true
+ type: string
+ - description: Payload of webhook details to update
+ in: body
+ name: payload
+ required: true
+ schema:
+ $ref: '#/definitions/requests.WebhookUpdate'
produces:
- - application/json
+ - application/json
responses:
"200":
description: OK
schema:
- $ref: "#/definitions/responses.WebhookResponse"
+ $ref: '#/definitions/responses.WebhookResponse'
"400":
description: Bad Request
schema:
- $ref: "#/definitions/responses.BadRequest"
+ $ref: '#/definitions/responses.BadRequest'
"401":
description: Unauthorized
schema:
- $ref: "#/definitions/responses.Unauthorized"
+ $ref: '#/definitions/responses.Unauthorized'
"422":
description: Unprocessable Entity
schema:
- $ref: "#/definitions/responses.UnprocessableEntity"
+ $ref: '#/definitions/responses.UnprocessableEntity'
"500":
description: Internal Server Error
schema:
- $ref: "#/definitions/responses.InternalServerError"
+ $ref: '#/definitions/responses.InternalServerError'
security:
- - ApiKeyAuth: []
+ - ApiKeyAuth: []
summary: Update a webhook
tags:
- - Webhooks
+ - Webhooks
schemes:
- - https
+- https
securityDefinitions:
ApiKeyAuth:
in: header
diff --git a/api/go.mod b/api/go.mod
index 3c361930..a19a8854 100644
--- a/api/go.mod
+++ b/api/go.mod
@@ -43,7 +43,6 @@ require (
github.com/stretchr/testify v1.11.1
github.com/swaggo/swag v1.16.6
github.com/thedevsaddam/govalidator v1.9.10
- github.com/tursodatabase/libsql-client-go v0.0.0-20251219100830-236aa1ff8acc
github.com/uptrace/uptrace-go v1.41.1
github.com/xuri/excelize/v2 v2.10.1
go.opentelemetry.io/otel v1.43.0
@@ -55,7 +54,6 @@ require (
google.golang.org/api v0.274.0
google.golang.org/protobuf v1.36.11
gorm.io/driver/postgres v1.6.0
- gorm.io/driver/sqlite v1.6.0
gorm.io/gorm v1.31.1
gorm.io/plugin/opentelemetry v0.1.16
)
@@ -94,13 +92,11 @@ require (
github.com/PuerkitoBio/goquery v1.12.0 // indirect
github.com/andybalholm/brotli v1.2.1 // indirect
github.com/andybalholm/cascadia v1.3.3 // indirect
- github.com/antlr4-go/antlr/v4 v4.13.1 // indirect
github.com/cenkalti/backoff/v5 v5.0.3 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/clipperhouse/displaywidth v0.11.0 // indirect
github.com/clipperhouse/uax29/v2 v2.7.0 // indirect
github.com/cncf/xds/go v0.0.0-20260202195803-dba9d589def2 // indirect
- github.com/coder/websocket v1.8.14 // indirect
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
github.com/envoyproxy/go-control-plane/envoy v1.37.0 // indirect
github.com/envoyproxy/protoc-gen-validate v1.3.3 // indirect
@@ -187,7 +183,6 @@ require (
go.uber.org/zap v1.27.1 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.49.0 // indirect
- golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90 // indirect
golang.org/x/mod v0.34.0 // indirect
golang.org/x/net v0.52.0 // indirect
golang.org/x/oauth2 v0.36.0 // indirect
diff --git a/api/go.sum b/api/go.sum
index 60df8733..56cb1417 100644
--- a/api/go.sum
+++ b/api/go.sum
@@ -66,8 +66,6 @@ github.com/andybalholm/brotli v1.2.1 h1:R+f5xP285VArJDRgowrfb9DqL18yVK0gKAW/F+eT
github.com/andybalholm/brotli v1.2.1/go.mod h1:rzTDkvFWvIrjDXZHkuS16NPggd91W3kUSvPlQ1pLaKY=
github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM=
github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA=
-github.com/antlr4-go/antlr/v4 v4.13.1 h1:SqQKkuVZ+zWkMMNkjy5FZe5mr5WURWnlpmOuzYWrPrQ=
-github.com/antlr4-go/antlr/v4 v4.13.1/go.mod h1:GKmUxMtwp6ZgGwZSva4eWPC5mS6vUAmOABFgjdkM7Nw=
github.com/avast/retry-go/v5 v5.0.0 h1:kf1Qc2UsTZ4qq8elDymqfbISvkyMuhgRxuJqX2NHP7k=
github.com/avast/retry-go/v5 v5.0.0/go.mod h1://d+usmKWio1agtZfS1H/ltTqwtIfBnRq9zEwjc3eH8=
github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
@@ -90,8 +88,6 @@ github.com/cncf/xds/go v0.0.0-20260202195803-dba9d589def2 h1:aBangftG7EVZoUb69Os
github.com/cncf/xds/go v0.0.0-20260202195803-dba9d589def2/go.mod h1:qwXFYgsP6T7XnJtbKlf1HP8AjxZZyzxMmc+Lq5GjlU4=
github.com/cockroachdb/cockroach-go/v2 v2.4.3 h1:LJO3K3jC5WXvMePRQSJE1NsIGoFGcEx1LW83W6RAlhw=
github.com/cockroachdb/cockroach-go/v2 v2.4.3/go.mod h1:9U179XbCx4qFWtNhc7BiWLPfuyMVQ7qdAhfrwLz1vH0=
-github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g=
-github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
@@ -324,8 +320,6 @@ github.com/thedevsaddam/govalidator v1.9.10 h1:m3dLRbSZ5Hts3VUWYe+vxLMG+FdyQuWOj
github.com/thedevsaddam/govalidator v1.9.10/go.mod h1:Ilx8u7cg5g3LXbSS943cx5kczyNuUn7LH/cK5MYuE90=
github.com/tiendc/go-deepcopy v1.7.2 h1:Ut2yYR7W9tWjTQitganoIue4UGxZwCcJy3orjrrIj44=
github.com/tiendc/go-deepcopy v1.7.2/go.mod h1:4bKjNC2r7boYOkD2IOuZpYjmlDdzjbpTRyCx+goBCJQ=
-github.com/tursodatabase/libsql-client-go v0.0.0-20251219100830-236aa1ff8acc h1:lzi/5fg2EfinRlh3v//YyIhnc4tY7BTqazQGwb1ar+0=
-github.com/tursodatabase/libsql-client-go v0.0.0-20251219100830-236aa1ff8acc/go.mod h1:08inkKyguB6CGGssc/JzhmQWwBgFQBgjlYFjxjRh7nU=
github.com/uptrace/uptrace-go v1.41.1 h1:EtWkkdOQqtuJMZyzeU0zT5VH6ppVY12yOouQK3VRccw=
github.com/uptrace/uptrace-go v1.41.1/go.mod h1:gdn1eRLG3KCtTyiw+L8tG+tb/wnpiyIfLfTH2qh/5Mw=
github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
@@ -416,8 +410,6 @@ golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v
golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
golang.org/x/crypto v0.49.0 h1:+Ng2ULVvLHnJ/ZFEq4KdcDd/cfjrrjjNSXNzxg0Y4U4=
golang.org/x/crypto v0.49.0/go.mod h1:ErX4dUh2UM+CFYiXZRTcMpEcN8b/1gxEuv3nODoYtCA=
-golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90 h1:jiDhWWeC7jfWqR9c/uplMOqJ0sbNlNWv0UkzE0vX1MA=
-golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90/go.mod h1:xE1HEv6b+1SCZ5/uscMRjUBKtIxworgEcEi+/n9NQDQ=
golang.org/x/image v0.25.0 h1:Y6uW6rH1y5y/LK1J8BPWZtr6yZ7hrsy6hFrXjgsc2fQ=
golang.org/x/image v0.25.0/go.mod h1:tCAmOEGthTtkalusGp1g3xa2gke8J6c2N565dTyl9Rs=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
diff --git a/api/main.go b/api/main.go
index b85c9d66..5b7539c9 100644
--- a/api/main.go
+++ b/api/main.go
@@ -7,7 +7,6 @@ import (
"github.com/NdoleStudio/httpsms/docs"
"github.com/NdoleStudio/httpsms/pkg/di"
- _ "github.com/tursodatabase/libsql-client-go/libsql"
)
// Version is injected at runtime
diff --git a/api/pkg/di/container.go b/api/pkg/di/container.go
index 33d27b01..676cb1dc 100644
--- a/api/pkg/di/container.go
+++ b/api/pkg/di/container.go
@@ -10,11 +10,9 @@ import (
"strings"
"time"
+ "github.com/NdoleStudio/httpsms/docs"
plunk "github.com/NdoleStudio/plunk-go"
"github.com/pusher/pusher-http-go/v5"
- "gorm.io/driver/sqlite"
-
- "github.com/NdoleStudio/httpsms/docs"
otelMetric "go.opentelemetry.io/otel/metric"
@@ -130,6 +128,8 @@ func NewContainer(projectID string, version string) (container *Container) {
container.RegisterHeartbeatListeners()
container.RegisterUserRoutes()
+ container.RegisterSendScheduleRoutes()
+ container.RegisterSendScheduleListeners()
container.RegisterUserListeners()
container.RegisterPhoneRoutes()
@@ -234,12 +234,6 @@ func (container *Container) GormLogger() gormLogger.Interface {
}
func (container *Container) connect(dsn string, config *gorm.Config) (db *gorm.DB, err error) {
- if strings.HasPrefix(dsn, "libsql://") {
- return gorm.Open(sqlite.New(sqlite.Config{
- DriverName: "libsql",
- DSN: dsn,
- }), config)
- }
return gorm.Open(postgres.Open(dsn), config)
}
@@ -364,6 +358,10 @@ ALTER TABLE discords ADD CONSTRAINT IF NOT EXISTS uni_discords_server_id CHECK (
container.logger.Fatal(stacktrace.Propagate(err, fmt.Sprintf("cannot migrate %T", &entities.User{})))
}
+ if err = db.AutoMigrate(&entities.MessageSendSchedule{}); err != nil {
+ container.logger.Fatal(stacktrace.Propagate(err, fmt.Sprintf("cannot migrate %T", &entities.MessageSendSchedule{})))
+ }
+
if err = db.AutoMigrate(&entities.Phone{}); err != nil {
container.logger.Fatal(stacktrace.Propagate(err, fmt.Sprintf("cannot migrate %T", &entities.Phone{})))
}
@@ -753,6 +751,46 @@ func (container *Container) PhoneRepository() (repository repositories.PhoneRepo
)
}
+// SendScheduleRepository creates a new instance of repositories.SendScheduleRepository
+func (container *Container) SendScheduleRepository() repositories.SendScheduleRepository {
+ container.logger.Debug("creating GORM repositories.SendScheduleRepository")
+ return repositories.NewGormSendScheduleRepository(
+ container.Logger(),
+ container.Tracer(),
+ container.DB(),
+ )
+}
+
+// SendScheduleService creates a new instance of services.SendScheduleService
+func (container *Container) SendScheduleService() *services.SendScheduleService {
+ container.logger.Debug("creating services.SendScheduleService")
+ return services.NewSendScheduleService(
+ container.Logger(),
+ container.Tracer(),
+ container.SendScheduleRepository(),
+ )
+}
+
+// SendScheduleHandlerValidator creates a new instance of validators.SendScheduleHandlerValidator
+func (container *Container) SendScheduleHandlerValidator() *validators.SendScheduleHandlerValidator {
+ container.logger.Debug("creating validators.SendScheduleHandlerValidator")
+ return validators.NewSendScheduleHandlerValidator(
+ container.Logger(),
+ container.Tracer(),
+ )
+}
+
+// SendScheduleHandler creates a new instance of handlers.SendScheduleHandler
+func (container *Container) SendScheduleHandler() *handlers.SendScheduleHandler {
+ container.logger.Debug("creating handlers.SendScheduleHandler")
+ return handlers.NewSendScheduleHandler(
+ container.Logger(),
+ container.Tracer(),
+ container.SendScheduleHandlerValidator(),
+ container.SendScheduleService(),
+ )
+}
+
// BillingUsageRepository creates a new instance of repositories.BillingUsageRepository
func (container *Container) BillingUsageRepository() (repository repositories.BillingUsageRepository) {
container.logger.Debug("creating GORM repositories.BillingUsageRepository")
@@ -1097,6 +1135,20 @@ func (container *Container) RegisterMessageListeners() {
}
}
+// RegisterSendScheduleListeners registers event listeners for listeners.SendScheduleListener
+func (container *Container) RegisterSendScheduleListeners() {
+ container.logger.Debug(fmt.Sprintf("registering listeners for %T", listeners.SendScheduleListener{}))
+ _, routes := listeners.NewSendScheduleListener(
+ container.Logger(),
+ container.Tracer(),
+ container.SendScheduleService(),
+ )
+
+ for event, handler := range routes {
+ container.EventDispatcher().Subscribe(event, handler)
+ }
+}
+
// LemonsqueezyService creates a new instance of services.LemonsqueezyService
func (container *Container) LemonsqueezyService() (service *services.LemonsqueezyService) {
container.logger.Debug(fmt.Sprintf("creating %T", service))
@@ -1510,6 +1562,7 @@ func (container *Container) NotificationService() (service *services.PhoneNotifi
container.FirebaseMessagingClient(),
container.PhoneRepository(),
container.PhoneNotificationRepository(),
+ container.SendScheduleRepository(),
container.EventDispatcher(),
)
}
@@ -1565,6 +1618,12 @@ func (container *Container) RegisterUserRoutes() {
container.UserHandler().RegisterRoutes(container.App(), container.AuthenticatedMiddleware())
}
+// RegisterSendScheduleRoutes registers routes for the /send-schedules prefix
+func (container *Container) RegisterSendScheduleRoutes() {
+ container.logger.Debug(fmt.Sprintf("registering %T routes", &handlers.SendScheduleHandler{}))
+ container.SendScheduleHandler().RegisterRoutes(container.App(), container.AuthenticatedMiddleware())
+}
+
// RegisterEventRoutes registers routes for the /events prefix
func (container *Container) RegisterEventRoutes() {
container.logger.Debug(fmt.Sprintf("registering %T routes", &handlers.EventsHandler{}))
diff --git a/api/pkg/entities/phone.go b/api/pkg/entities/phone.go
index 83521759..f97212ce 100644
--- a/api/pkg/entities/phone.go
+++ b/api/pkg/entities/phone.go
@@ -8,12 +8,14 @@ import (
// Phone represents an android phone which has installed the http sms app
type Phone struct {
- ID uuid.UUID `json:"id" gorm:"primaryKey;type:uuid;" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
- UserID UserID `json:"user_id" example:"WB7DRDWrJZRGbYrv2CKGkqbzvqdC"`
- FcmToken *string `json:"fcm_token" example:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....." validate:"optional"`
- PhoneNumber string `json:"phone_number" example:"+18005550199"`
- MessagesPerMinute uint `json:"messages_per_minute" example:"1"`
- SIM SIM `json:"sim" gorm:"default:SIM1"`
+ ID uuid.UUID `json:"id" gorm:"primaryKey;type:uuid;" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
+ UserID UserID `json:"user_id" example:"WB7DRDWrJZRGbYrv2CKGkqbzvqdC"`
+ FcmToken *string `json:"fcm_token" example:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd....." validate:"optional"`
+ PhoneNumber string `json:"phone_number" example:"+18005550199"`
+ MessagesPerMinute uint `json:"messages_per_minute" example:"1"`
+ SIM SIM `json:"sim" gorm:"default:SIM1"`
+ ScheduleID *uuid.UUID `json:"schedule_id" gorm:"type:uuid" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
+ Schedule *MessageSendSchedule `json:"-" gorm:"foreignKey:ScheduleID;constraint:OnDelete:SET NULL"`
// MaxSendAttempts determines how many times to retry sending an SMS message
MaxSendAttempts uint `json:"max_send_attempts" example:"2"`
diff --git a/api/pkg/entities/send_schedule.go b/api/pkg/entities/send_schedule.go
new file mode 100644
index 00000000..9ffbad12
--- /dev/null
+++ b/api/pkg/entities/send_schedule.go
@@ -0,0 +1,103 @@
+package entities
+
+import (
+ "time"
+
+ "github.com/google/uuid"
+)
+
+// MessageSendScheduleWindow represents a single availability window for a day of the week.
+type MessageSendScheduleWindow struct {
+ DayOfWeek int `json:"day_of_week" example:"1"`
+ StartMinute int `json:"start_minute" example:"540"`
+ EndMinute int `json:"end_minute" example:"1020"`
+}
+
+// MessageSendSchedule controls when a phone is allowed to send outgoing SMS messages.
+type MessageSendSchedule struct {
+ ID uuid.UUID `json:"id" gorm:"primaryKey;type:uuid;" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
+ UserID UserID `json:"user_id" example:"WB7DRDWrJZRGbYrv2CKGkqbzvqdC"`
+ Name string `json:"name" example:"Business Hours"`
+ Timezone string `json:"timezone" example:"Europe/Tallinn"`
+ IsActive bool `json:"is_active" gorm:"default:true" example:"true"`
+ Windows []MessageSendScheduleWindow `json:"windows" gorm:"type:jsonb;serializer:json"`
+ CreatedAt time.Time `json:"created_at" example:"2022-06-05T14:26:02.302718+03:00"`
+ UpdatedAt time.Time `json:"updated_at" example:"2022-06-05T14:26:10.303278+03:00"`
+}
+
+// ResolveScheduledAt returns the next allowed send time based on the schedule.
+// If the schedule is inactive, has no windows, or has an invalid timezone,
+// the current time is returned in UTC.
+func (schedule *MessageSendSchedule) ResolveScheduledAt(current time.Time) time.Time {
+ if schedule == nil || !schedule.IsActive || len(schedule.Windows) == 0 {
+ return current.UTC()
+ }
+
+ location, err := time.LoadLocation(schedule.Timezone)
+ if err != nil {
+ return current.UTC()
+ }
+
+ base := current.In(location)
+ var best time.Time
+
+ for dayOffset := 0; dayOffset <= 7; dayOffset++ {
+ day := base.AddDate(0, 0, dayOffset)
+ weekday := int(day.Weekday())
+
+ for _, window := range schedule.Windows {
+ if window.DayOfWeek != weekday {
+ continue
+ }
+
+ start := time.Date(
+ day.Year(),
+ day.Month(),
+ day.Day(),
+ 0,
+ 0,
+ 0,
+ 0,
+ location,
+ ).Add(time.Duration(window.StartMinute) * time.Minute)
+
+ end := time.Date(
+ day.Year(),
+ day.Month(),
+ day.Day(),
+ 0,
+ 0,
+ 0,
+ 0,
+ location,
+ ).Add(time.Duration(window.EndMinute) * time.Minute)
+
+ var candidate time.Time
+
+ switch {
+ case dayOffset == 0 && base.Before(start):
+ candidate = start
+ case dayOffset == 0 && (base.Equal(start) || (base.After(start) && base.Before(end))):
+ candidate = base
+ case dayOffset > 0:
+ candidate = start
+ default:
+ continue
+ }
+
+ if best.IsZero() || candidate.Before(best) {
+ best = candidate
+ }
+ }
+
+ if !best.IsZero() {
+ break
+ }
+ }
+
+ if best.IsZero() {
+ return current.UTC()
+ }
+
+ return best.UTC()
+}
diff --git a/api/pkg/handlers/send_schedule_handler.go b/api/pkg/handlers/send_schedule_handler.go
new file mode 100644
index 00000000..cb636f49
--- /dev/null
+++ b/api/pkg/handlers/send_schedule_handler.go
@@ -0,0 +1,209 @@
+package handlers
+
+import (
+ "fmt"
+
+ "github.com/NdoleStudio/httpsms/pkg/repositories"
+ "github.com/NdoleStudio/httpsms/pkg/requests"
+ "github.com/NdoleStudio/httpsms/pkg/services"
+ "github.com/NdoleStudio/httpsms/pkg/telemetry"
+ "github.com/NdoleStudio/httpsms/pkg/validators"
+ "github.com/davecgh/go-spew/spew"
+ "github.com/gofiber/fiber/v2"
+ "github.com/google/uuid"
+ "github.com/palantir/stacktrace"
+)
+
+// SendScheduleHandler handles HTTP requests for message send schedules.
+type SendScheduleHandler struct {
+ handler
+ logger telemetry.Logger
+ tracer telemetry.Tracer
+ validator *validators.SendScheduleHandlerValidator
+ service *services.SendScheduleService
+}
+
+// NewSendScheduleHandler creates a new SendScheduleHandler.
+func NewSendScheduleHandler(
+ logger telemetry.Logger,
+ tracer telemetry.Tracer,
+ validator *validators.SendScheduleHandlerValidator,
+ service *services.SendScheduleService,
+) *SendScheduleHandler {
+ return &SendScheduleHandler{
+ logger: logger.WithService(fmt.Sprintf("%T", &SendScheduleHandler{})),
+ tracer: tracer,
+ validator: validator,
+ service: service,
+ }
+}
+
+// RegisterRoutes registers send schedule routes.
+func (h *SendScheduleHandler) RegisterRoutes(router fiber.Router, middlewares ...fiber.Handler) {
+ router.Get("/v1/send-schedules", h.computeRoute(middlewares, h.Index)...)
+ router.Post("/v1/send-schedules", h.computeRoute(middlewares, h.Store)...)
+ router.Put("/v1/send-schedules/:scheduleID", h.computeRoute(middlewares, h.Update)...)
+ router.Delete("/v1/send-schedules/:scheduleID", h.computeRoute(middlewares, h.Delete)...)
+}
+
+// Index lists all send schedules for the authenticated user.
+//
+// @Summary List send schedules
+// @Description List all send schedules owned by the authenticated user.
+// @Security ApiKeyAuth
+// @Tags Send Schedules
+// @Produce json
+// @Success 200 {array} entities.MessageSendSchedule
+// @Failure 401 {object} responses.Unauthorized
+// @Failure 500 {object} responses.InternalServerError
+// @Router /send-schedules [get]
+func (h *SendScheduleHandler) Index(c *fiber.Ctx) error {
+ ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
+ defer span.End()
+
+ schedules, err := h.service.Index(ctx, h.userIDFomContext(c))
+ if err != nil {
+ ctxLogger.Error(stacktrace.Propagate(err, "cannot list send schedules"))
+ return h.responseInternalServerError(c)
+ }
+
+ return h.responseOK(c, "send schedules fetched successfully", schedules)
+}
+
+// Store creates a new send schedule for the authenticated user.
+//
+// @Summary Create send schedule
+// @Description Create a new send schedule for the authenticated user.
+// @Security ApiKeyAuth
+// @Tags Send Schedules
+// @Accept json
+// @Produce json
+// @Param payload body requests.SendScheduleStore true "Payload of new send schedule."
+// @Success 201 {object} responses.SendScheduleResponse
+// @Failure 400 {object} responses.BadRequest
+// @Failure 401 {object} responses.Unauthorized
+// @Failure 422 {object} responses.UnprocessableEntity
+// @Failure 500 {object} responses.InternalServerError
+// @Router /send-schedules [post]
+func (h *SendScheduleHandler) Store(c *fiber.Ctx) error {
+ ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
+ defer span.End()
+
+ var request requests.SendScheduleStore
+ if err := c.BodyParser(&request); err != nil {
+ return h.responseBadRequest(c, err)
+ }
+
+ request = request.Sanitize()
+ if errors := h.validator.ValidateStore(ctx, request); len(errors) != 0 {
+ ctxLogger.Warn(stacktrace.NewError(
+ "validation errors [%s], while storing send schedule [%+#v]",
+ spew.Sdump(errors),
+ request,
+ ))
+ return h.responseUnprocessableEntity(c, errors, "validation errors while saving send schedule")
+ }
+
+ schedule, err := h.service.Store(ctx, request.ToParams(h.userFromContext(c)))
+ if err != nil {
+ ctxLogger.Error(stacktrace.Propagate(err, "cannot create send schedule"))
+ return h.responseInternalServerError(c)
+ }
+
+ return h.responseCreated(c, "send schedule created successfully", schedule)
+}
+
+// Update updates a send schedule owned by the authenticated user.
+//
+// @Summary Update send schedule
+// @Description Update a send schedule owned by the authenticated user.
+// @Security ApiKeyAuth
+// @Tags Send Schedules
+// @Accept json
+// @Produce json
+// @Param scheduleID path string true "Schedule ID"
+// @Param payload body requests.SendScheduleStore true "Payload of updated send schedule."
+// @Success 200 {object} responses.SendScheduleResponse
+// @Failure 400 {object} responses.BadRequest
+// @Failure 401 {object} responses.Unauthorized
+// @Failure 404 {object} responses.NotFound
+// @Failure 422 {object} responses.UnprocessableEntity
+// @Failure 500 {object} responses.InternalServerError
+// @Router /send-schedules/{scheduleID} [put]
+func (h *SendScheduleHandler) Update(c *fiber.Ctx) error {
+ ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
+ defer span.End()
+
+ scheduleID, err := uuid.Parse(c.Params("scheduleID"))
+ if err != nil {
+ return h.responseBadRequest(c, err)
+ }
+
+ var request requests.SendScheduleStore
+ if err = c.BodyParser(&request); err != nil {
+ return h.responseBadRequest(c, err)
+ }
+
+ request = request.Sanitize()
+ if errors := h.validator.ValidateStore(ctx, request); len(errors) != 0 {
+ return h.responseUnprocessableEntity(c, errors, "validation errors while updating send schedule")
+ }
+
+ schedule, err := h.service.Update(
+ ctx,
+ h.userIDFomContext(c),
+ scheduleID,
+ request.ToParams(h.userFromContext(c)),
+ )
+ if err != nil {
+ ctxLogger.Error(stacktrace.Propagate(err, "cannot update send schedule"))
+ if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
+ return h.responseNotFound(c, err.Error())
+ }
+ return h.responseInternalServerError(c)
+ }
+
+ return h.responseOK(c, "send schedule updated successfully", schedule)
+}
+
+// Delete removes a send schedule owned by the authenticated user.
+//
+// @Summary Delete send schedule
+// @Description Delete a send schedule owned by the authenticated user.
+// @Security ApiKeyAuth
+// @Tags Send Schedules
+// @Produce json
+// @Param scheduleID path string true "Schedule ID"
+// @Success 204
+// @Failure 400 {object} responses.BadRequest
+// @Failure 401 {object} responses.Unauthorized
+// @Failure 404 {object} responses.NotFound
+// @Failure 500 {object} responses.InternalServerError
+// @Router /send-schedules/{scheduleID} [delete]
+func (h *SendScheduleHandler) Delete(c *fiber.Ctx) error {
+ ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
+ defer span.End()
+
+ scheduleID, err := uuid.Parse(c.Params("scheduleID"))
+ if err != nil {
+ return h.responseBadRequest(c, err)
+ }
+
+ if _, err = h.service.Load(ctx, h.userIDFomContext(c), scheduleID); err != nil {
+ ctxLogger.Error(stacktrace.Propagate(err, "cannot load send schedule for deletion"))
+ if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
+ return h.responseNotFound(c, err.Error())
+ }
+ return h.responseInternalServerError(c)
+ }
+
+ if err = h.service.Delete(ctx, h.userIDFomContext(c), scheduleID); err != nil {
+ ctxLogger.Error(stacktrace.Propagate(err, "cannot delete send schedule"))
+ if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
+ return h.responseNotFound(c, err.Error())
+ }
+ return h.responseInternalServerError(c)
+ }
+
+ return h.responseNoContent(c, "send schedule deleted successfully")
+}
diff --git a/api/pkg/listeners/send_schedule_listener.go b/api/pkg/listeners/send_schedule_listener.go
new file mode 100644
index 00000000..ac65eddd
--- /dev/null
+++ b/api/pkg/listeners/send_schedule_listener.go
@@ -0,0 +1,73 @@
+package listeners
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/NdoleStudio/httpsms/pkg/events"
+ "github.com/NdoleStudio/httpsms/pkg/services"
+ "github.com/NdoleStudio/httpsms/pkg/telemetry"
+ cloudevents "github.com/cloudevents/sdk-go/v2"
+ "github.com/palantir/stacktrace"
+)
+
+// SendScheduleListener handles cloud events related to message send schedules.
+type SendScheduleListener struct {
+ logger telemetry.Logger
+ tracer telemetry.Tracer
+ service *services.SendScheduleService
+}
+
+// NewSendScheduleListener creates a new instance of SendScheduleListener.
+func NewSendScheduleListener(
+ logger telemetry.Logger,
+ tracer telemetry.Tracer,
+ service *services.SendScheduleService,
+) (l *SendScheduleListener, routes map[string]events.EventListener) {
+ l = &SendScheduleListener{
+ logger: logger.WithService(fmt.Sprintf("%T", &SendScheduleListener{})),
+ tracer: tracer,
+ service: service,
+ }
+
+ return l, map[string]events.EventListener{
+ events.UserAccountDeleted: l.onUserAccountDeleted,
+ }
+}
+
+// onUserAccountDeleted removes all message send schedules for a deleted user account.
+func (listener *SendScheduleListener) onUserAccountDeleted(
+ ctx context.Context,
+ event cloudevents.Event,
+) error {
+ ctx, span := listener.tracer.Start(ctx)
+ defer span.End()
+
+ var payload events.UserAccountDeletedPayload
+ if err := event.DataAs(&payload); err != nil {
+ return listener.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ "cannot decode [%s] into [%T]",
+ event.Data(),
+ payload,
+ ),
+ )
+ }
+
+ if err := listener.service.DeleteAllForUser(ctx, payload.UserID); err != nil {
+ return listener.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ "cannot delete [entities.MessageSendSchedule] for user [%s] on [%s] event with ID [%s]",
+ payload.UserID,
+ event.Type(),
+ event.ID(),
+ ),
+ )
+ }
+
+ return nil
+}
diff --git a/api/pkg/repositories/gorm_heartbeat_monitor_repository.go b/api/pkg/repositories/gorm_heartbeat_monitor_repository.go
index fb892d87..e6f5aee5 100644
--- a/api/pkg/repositories/gorm_heartbeat_monitor_repository.go
+++ b/api/pkg/repositories/gorm_heartbeat_monitor_repository.go
@@ -39,13 +39,11 @@ func (repository *gormHeartbeatMonitorRepository) DeleteAllForUser(ctx context.C
ctx, span := repository.tracer.Start(ctx)
defer span.End()
- return executeWithRetry(func() error {
- if err := repository.db.WithContext(ctx).Where("user_id = ?", userID).Delete(&entities.HeartbeatMonitor{}).Error; err != nil {
- msg := fmt.Sprintf("cannot delete all [%T] for user with ID [%s]", &entities.HeartbeatMonitor{}, userID)
- return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
- }
- return nil
- })
+ if err := repository.db.WithContext(ctx).Where("user_id = ?", userID).Delete(&entities.HeartbeatMonitor{}).Error; err != nil {
+ msg := fmt.Sprintf("cannot delete all [%T] for user with ID [%s]", &entities.HeartbeatMonitor{}, userID)
+ return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+ return nil
}
// UpdatePhoneOnline updates the online status of a phone
@@ -56,16 +54,14 @@ func (repository *gormHeartbeatMonitorRepository) UpdatePhoneOnline(ctx context.
ctx, cancel := context.WithTimeout(ctx, dbOperationDuration)
defer cancel()
- err := executeWithRetry(func() error {
- return repository.db.
- Model(&entities.HeartbeatMonitor{}).
- Where("id = ?", monitorID).
- Where("user_id = ?", userID).
- Updates(map[string]any{
- "phone_online": isOnline,
- "updated_at": time.Now().UTC(),
- }).Error
- })
+ err := repository.db.
+ Model(&entities.HeartbeatMonitor{}).
+ Where("id = ?", monitorID).
+ Where("user_id = ?", userID).
+ Updates(map[string]any{
+ "phone_online": isOnline,
+ "updated_at": time.Now().UTC(),
+ }).Error
if err != nil {
msg := fmt.Sprintf("cannot update heartbeat monitor ID [%s] for user [%s]", monitorID, userID)
return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
@@ -81,15 +77,13 @@ func (repository *gormHeartbeatMonitorRepository) UpdateQueueID(ctx context.Cont
ctx, cancel := context.WithTimeout(ctx, dbOperationDuration)
defer cancel()
- err := executeWithRetry(func() error {
- return repository.db.
- Model(&entities.HeartbeatMonitor{}).
- Where("id = ?", monitorID).
- Updates(map[string]any{
- "queue_id": queueID,
- "updated_at": time.Now().UTC(),
- }).Error
- })
+ err := repository.db.
+ Model(&entities.HeartbeatMonitor{}).
+ Where("id = ?", monitorID).
+ Updates(map[string]any{
+ "queue_id": queueID,
+ "updated_at": time.Now().UTC(),
+ }).Error
if err != nil {
msg := fmt.Sprintf("cannot update heartbeat monitor ID [%s]", monitorID)
return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
@@ -104,12 +98,10 @@ func (repository *gormHeartbeatMonitorRepository) Delete(ctx context.Context, us
ctx, cancel := context.WithTimeout(ctx, dbOperationDuration)
defer cancel()
- err := executeWithRetry(func() error {
- return repository.db.WithContext(ctx).
- Where("user_id = ?", userID).
- Where("owner = ?", owner).
- Delete(&entities.HeartbeatMonitor{}).Error
- })
+ err := repository.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Where("owner = ?", owner).
+ Delete(&entities.HeartbeatMonitor{}).Error
if err != nil {
msg := fmt.Sprintf("cannot delete heartbeat monitor with owner [%s] and userID [%s]", owner, userID)
return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
@@ -128,9 +120,7 @@ func (repository *gormHeartbeatMonitorRepository) Index(ctx context.Context, use
query := repository.db.WithContext(ctx).Where("user_id = ?", userID).Where("owner = ?", owner)
heartbeats := new([]entities.Heartbeat)
- if err := executeWithRetry(func() error {
- return query.Order("timestamp DESC").Limit(params.Limit).Offset(params.Skip).Find(&heartbeats).Error
- }); err != nil {
+ if err := query.Order("timestamp DESC").Limit(params.Limit).Offset(params.Skip).Find(&heartbeats).Error; err != nil {
msg := fmt.Sprintf("cannot fetch heartbeats with owner [%s] and params [%+#v]", owner, params)
return nil, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
@@ -146,7 +136,7 @@ func (repository *gormHeartbeatMonitorRepository) Store(ctx context.Context, hea
ctx, cancel := context.WithTimeout(ctx, dbOperationDuration)
defer cancel()
- if err := executeWithRetry(func() error { return repository.db.WithContext(ctx).Create(heartbeatMonitor).Error }); err != nil {
+ if err := repository.db.WithContext(ctx).Create(heartbeatMonitor).Error; err != nil {
msg := fmt.Sprintf("cannot save heartbeatMonitor monitor with ID [%s]", heartbeatMonitor.ID)
return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
@@ -163,12 +153,10 @@ func (repository *gormHeartbeatMonitorRepository) Load(ctx context.Context, user
defer cancel()
phone := new(entities.HeartbeatMonitor)
- err := executeWithRetry(func() error {
- return repository.db.WithContext(ctx).
- Where("user_id = ?", userID).
- Where("owner = ?", owner).
- First(&phone).Error
- })
+ err := repository.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Where("owner = ?", owner).
+ First(&phone).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
msg := fmt.Sprintf("heartbeat monitor with userID [%s] and owner [%s] does not exist", userID, owner)
return nil, repository.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCode(err, ErrCodeNotFound, msg))
@@ -191,14 +179,12 @@ func (repository *gormHeartbeatMonitorRepository) Exists(ctx context.Context, us
defer cancel()
var exists bool
- err := executeWithRetry(func() error {
- return repository.db.WithContext(ctx).
- Model(&entities.HeartbeatMonitor{}).
- Select("count(*) > 0").
- Where("user_id = ?", userID).
- Where("id = ?", monitorID).
- Find(&exists).Error
- })
+ err := repository.db.WithContext(ctx).
+ Model(&entities.HeartbeatMonitor{}).
+ Select("count(*) > 0").
+ Where("user_id = ?", userID).
+ Where("id = ?", monitorID).
+ Find(&exists).Error
if err != nil {
msg := fmt.Sprintf("cannot check if heartbeat monitor exists with userID [%s] and montior ID [%s]", userID, monitorID)
return exists, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
diff --git a/api/pkg/repositories/gorm_heartbeat_repository.go b/api/pkg/repositories/gorm_heartbeat_repository.go
index 5b7794e9..e9ddf7ce 100644
--- a/api/pkg/repositories/gorm_heartbeat_repository.go
+++ b/api/pkg/repositories/gorm_heartbeat_repository.go
@@ -36,9 +36,7 @@ func (repository *gormHeartbeatRepository) DeleteAllForUser(ctx context.Context,
ctx, span := repository.tracer.Start(ctx)
defer span.End()
- err := executeWithRetry(func() error {
- return repository.db.WithContext(ctx).Where("user_id = ?", userID).Delete(&entities.Heartbeat{}).Error
- })
+ err := repository.db.WithContext(ctx).Where("user_id = ?", userID).Delete(&entities.Heartbeat{}).Error
if err != nil {
msg := fmt.Sprintf("cannot delete all [%T] for user with ID [%s]", &entities.Heartbeat{}, userID)
return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
@@ -55,13 +53,11 @@ func (repository *gormHeartbeatRepository) Last(ctx context.Context, userID enti
defer cancel()
heartbeat := new(entities.Heartbeat)
- err := executeWithRetry(func() error {
- return repository.db.WithContext(ctx).
- Where("user_id = ?", userID).
- Where("owner = ?", owner).
- Order("timestamp DESC").
- First(&heartbeat).Error
- })
+ err := repository.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Where("owner = ?", owner).
+ Order("timestamp DESC").
+ First(&heartbeat).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
msg := fmt.Sprintf("heartbeat with userID [%s] and owner [%s] does not exist", userID, owner)
return nil, repository.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCode(err, ErrCodeNotFound, msg))
@@ -90,9 +86,7 @@ func (repository *gormHeartbeatRepository) Index(ctx context.Context, userID ent
}
heartbeats := new([]entities.Heartbeat)
- err := executeWithRetry(func() error {
- return query.Order("timestamp DESC").Limit(params.Limit).Offset(params.Skip).Find(&heartbeats).Error
- })
+ err := query.Order("timestamp DESC").Limit(params.Limit).Offset(params.Skip).Find(&heartbeats).Error
if err != nil {
msg := fmt.Sprintf("cannot fetch heartbeats with owner [%s] and params [%+#v]", owner, params)
return nil, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
@@ -109,7 +103,7 @@ func (repository *gormHeartbeatRepository) Store(ctx context.Context, heartbeat
ctx, cancel := context.WithTimeout(ctx, dbOperationDuration)
defer cancel()
- if err := executeWithRetry(func() error { return repository.db.WithContext(ctx).Create(heartbeat).Error }); err != nil {
+ if err := repository.db.WithContext(ctx).Create(heartbeat).Error; err != nil {
msg := fmt.Sprintf("cannot save heartbeat with ID [%s]", heartbeat.ID)
return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
diff --git a/api/pkg/repositories/gorm_phone_notification_repository.go b/api/pkg/repositories/gorm_phone_notification_repository.go
index f491e4b3..8cc16f1e 100644
--- a/api/pkg/repositories/gorm_phone_notification_repository.go
+++ b/api/pkg/repositories/gorm_phone_notification_repository.go
@@ -15,40 +15,57 @@ import (
"gorm.io/gorm"
)
-// gormPhoneNotificationRepository is responsible for persisting entities.PhoneNotification
+// gormPhoneNotificationRepository persists entities.PhoneNotification records.
type gormPhoneNotificationRepository struct {
logger telemetry.Logger
tracer telemetry.Tracer
db *gorm.DB
}
-// NewGormPhoneNotificationRepository creates the GORM version of the PhoneNotificationRepository
+// NewGormPhoneNotificationRepository creates a GORM-backed PhoneNotificationRepository.
func NewGormPhoneNotificationRepository(
logger telemetry.Logger,
tracer telemetry.Tracer,
db *gorm.DB,
) PhoneNotificationRepository {
return &gormPhoneNotificationRepository{
- logger: logger.WithService(fmt.Sprintf("%T", &gormHeartbeatRepository{})),
+ logger: logger.WithService(fmt.Sprintf("%T", &gormPhoneNotificationRepository{})),
tracer: tracer,
db: db,
}
}
-func (repository *gormPhoneNotificationRepository) DeleteAllForUser(ctx context.Context, userID entities.UserID) error {
+// DeleteAllForUser deletes all phone notifications that belong to a user.
+func (repository *gormPhoneNotificationRepository) DeleteAllForUser(
+ ctx context.Context,
+ userID entities.UserID,
+) error {
ctx, span := repository.tracer.Start(ctx)
defer span.End()
- if err := repository.db.WithContext(ctx).Where("user_id = ?", userID).Delete(&entities.PhoneNotification{}).Error; err != nil {
- msg := fmt.Sprintf("cannot delete all [%T] for user with ID [%s]", &entities.PhoneNotification{}, userID)
- return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ if err := repository.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Delete(&entities.PhoneNotification{}).Error; err != nil {
+ return repository.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ "cannot delete all [%T] for user with ID [%s]",
+ &entities.PhoneNotification{},
+ userID,
+ ),
+ )
}
return nil
}
-// UpdateStatus of an entities.PhoneNotification
-func (repository *gormPhoneNotificationRepository) UpdateStatus(ctx context.Context, notificationID uuid.UUID, status entities.PhoneNotificationStatus) error {
+// UpdateStatus updates the status of a phone notification.
+func (repository *gormPhoneNotificationRepository) UpdateStatus(
+ ctx context.Context,
+ notificationID uuid.UUID,
+ status entities.PhoneNotificationStatus,
+) error {
ctx, span := repository.tracer.Start(ctx)
defer span.End()
@@ -58,71 +75,131 @@ func (repository *gormPhoneNotificationRepository) UpdateStatus(ctx context.Cont
Update("status", status).
Error
if err != nil {
- msg := fmt.Sprintf("cannot update notification [%s] with status [%s]", notificationID, status)
- return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ return repository.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ "cannot update notification [%s] with status [%s]",
+ notificationID,
+ status,
+ ),
+ )
}
return nil
}
-// Schedule a notification to be sent in the future
-func (repository *gormPhoneNotificationRepository) Schedule(ctx context.Context, messagesPerMinute uint, notification *entities.PhoneNotification) error {
+// Schedule stores a phone notification and calculates its final scheduled time.
+// The final time is determined by combining:
+// 1. the next allowed time from the message send schedule
+// 2. the phone send-rate limit derived from the latest scheduled notification
+func (repository *gormPhoneNotificationRepository) Schedule(
+ ctx context.Context,
+ messagesPerMinute uint,
+ schedule *entities.MessageSendSchedule,
+ notification *entities.PhoneNotification,
+) error {
ctx, span := repository.tracer.Start(ctx)
defer span.End()
+ now := time.Now().UTC()
+
if messagesPerMinute == 0 {
+ notification.ScheduledAt = repository.resolveScheduledAt(schedule, now)
return repository.insert(ctx, notification)
}
err := crdbgorm.ExecuteTx(ctx, repository.db, nil, func(tx *gorm.DB) error {
lastNotification := new(entities.PhoneNotification)
+
err := tx.WithContext(ctx).
Where("phone_id = ?", notification.PhoneID).
Order("scheduled_at desc").
First(lastNotification).
Error
if err != nil && !errors.Is(err, gorm.ErrRecordNotFound) {
- msg := fmt.Sprintf("cannot fetch last notification with phone ID [%s]", notification.PhoneID)
- return stacktrace.Propagate(err, msg)
+ return stacktrace.Propagate(
+ err,
+ "cannot fetch last notification with phone ID [%s]",
+ notification.PhoneID,
+ )
}
- notification.ScheduledAt = time.Now().UTC()
+ notification.ScheduledAt = repository.resolveScheduledAt(schedule, now)
+
if err == nil {
- notification.ScheduledAt = repository.maxTime(
- time.Now().UTC(),
- lastNotification.ScheduledAt.Add(time.Duration(60/messagesPerMinute)*time.Second),
+ rateLimitedAt := lastNotification.ScheduledAt.Add(
+ time.Duration(60/messagesPerMinute) * time.Second,
)
+
+ nextCandidate := repository.maxTime(notification.ScheduledAt, rateLimitedAt)
+ notification.ScheduledAt = repository.resolveScheduledAt(schedule, nextCandidate)
}
if err = tx.WithContext(ctx).Create(notification).Error; err != nil {
- msg := fmt.Sprintf("cannot create new notification with id [%s] and schedule [%s]", notification.ID, notification.ScheduledAt.String())
- return stacktrace.Propagate(err, msg)
+ return stacktrace.Propagate(
+ err,
+ "cannot create new notification with id [%s] and schedule [%s]",
+ notification.ID,
+ notification.ScheduledAt.String(),
+ )
}
+
return nil
})
if err != nil {
- msg := fmt.Sprintf("cannot schedule phone notification with ID [%s]", notification.ID)
- return stacktrace.Propagate(err, msg)
+ return repository.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ "cannot schedule phone notification with ID [%s]",
+ notification.ID,
+ ),
+ )
}
return nil
}
+// resolveScheduledAt returns the next time the notification is allowed to be sent.
+// If no schedule is attached, the provided time is returned unchanged in UTC.
+func (repository *gormPhoneNotificationRepository) resolveScheduledAt(
+ schedule *entities.MessageSendSchedule,
+ current time.Time,
+) time.Time {
+ if schedule == nil {
+ return current.UTC()
+ }
+
+ return schedule.ResolveScheduledAt(current)
+}
+
+// maxTime returns the later of the two times.
func (repository *gormPhoneNotificationRepository) maxTime(a, b time.Time) time.Time {
- if a.Unix() > b.Unix() {
+ if a.After(b) {
return a
}
return b
}
-func (repository *gormPhoneNotificationRepository) insert(ctx context.Context, notification *entities.PhoneNotification) error {
+// insert stores a single phone notification.
+func (repository *gormPhoneNotificationRepository) insert(
+ ctx context.Context,
+ notification *entities.PhoneNotification,
+) error {
ctx, span := repository.tracer.Start(ctx)
defer span.End()
- err := repository.db.WithContext(ctx).Create(notification).Error
- if err != nil {
- msg := fmt.Sprintf("cannot store notification with id [%s]", notification.ID)
- return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ if err := repository.db.WithContext(ctx).Create(notification).Error; err != nil {
+ return repository.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ "cannot store notification with id [%s]",
+ notification.ID,
+ ),
+ )
}
+
return nil
}
diff --git a/api/pkg/repositories/gorm_send_schedule_repository.go b/api/pkg/repositories/gorm_send_schedule_repository.go
new file mode 100644
index 00000000..afd09472
--- /dev/null
+++ b/api/pkg/repositories/gorm_send_schedule_repository.go
@@ -0,0 +1,168 @@
+package repositories
+
+import (
+ "context"
+ "errors"
+ "fmt"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+ "github.com/NdoleStudio/httpsms/pkg/telemetry"
+ "github.com/google/uuid"
+ "github.com/palantir/stacktrace"
+ "gorm.io/gorm"
+)
+
+// gormSendScheduleRepository persists and loads entities.MessageSendSchedule using GORM.
+type gormSendScheduleRepository struct {
+ logger telemetry.Logger
+ tracer telemetry.Tracer
+ db *gorm.DB
+}
+
+// NewGormSendScheduleRepository creates a new GORM-backed SendScheduleRepository.
+func NewGormSendScheduleRepository(
+ logger telemetry.Logger,
+ tracer telemetry.Tracer,
+ db *gorm.DB,
+) SendScheduleRepository {
+ return &gormSendScheduleRepository{
+ logger: logger.WithService(fmt.Sprintf("%T", &gormSendScheduleRepository{})),
+ tracer: tracer,
+ db: db,
+ }
+}
+
+// Store saves a new message send schedule.
+func (r *gormSendScheduleRepository) Store(
+ ctx context.Context,
+ schedule *entities.MessageSendSchedule,
+) error {
+ ctx, span := r.tracer.Start(ctx)
+ defer span.End()
+
+ if err := r.db.WithContext(ctx).Create(schedule).Error; err != nil {
+ return r.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(err, "cannot store send schedule [%s]", schedule.ID),
+ )
+ }
+
+ return nil
+}
+
+// Update persists changes to an existing message send schedule.
+func (r *gormSendScheduleRepository) Update(
+ ctx context.Context,
+ schedule *entities.MessageSendSchedule,
+) error {
+ ctx, span := r.tracer.Start(ctx)
+ defer span.End()
+
+ if err := r.db.WithContext(ctx).Save(schedule).Error; err != nil {
+ return r.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(err, "cannot update send schedule [%s]", schedule.ID),
+ )
+ }
+
+ return nil
+}
+
+// Load fetches a message send schedule by user ID and schedule ID.
+func (r *gormSendScheduleRepository) Load(
+ ctx context.Context,
+ userID entities.UserID,
+ scheduleID uuid.UUID,
+) (*entities.MessageSendSchedule, error) {
+ ctx, span := r.tracer.Start(ctx)
+ defer span.End()
+
+ item := new(entities.MessageSendSchedule)
+ err := r.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Where("id = ?", scheduleID).
+ First(item).Error
+ if errors.Is(err, gorm.ErrRecordNotFound) {
+ return nil, r.tracer.WrapErrorSpan(
+ span,
+ stacktrace.PropagateWithCode(
+ err,
+ ErrCodeNotFound,
+ "send schedule [%s] not found",
+ scheduleID,
+ ),
+ )
+ }
+ if err != nil {
+ return nil, r.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(err, "cannot load send schedule [%s]", scheduleID),
+ )
+ }
+
+ return item, nil
+}
+
+// Index lists all message send schedules owned by the given user.
+func (r *gormSendScheduleRepository) Index(
+ ctx context.Context,
+ userID entities.UserID,
+) ([]entities.MessageSendSchedule, error) {
+ ctx, span := r.tracer.Start(ctx)
+ defer span.End()
+
+ items := make([]entities.MessageSendSchedule, 0)
+ if err := r.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Order("created_at ASC").
+ Find(&items).Error; err != nil {
+ return nil, r.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(err, "cannot index send schedules for user [%s]", userID),
+ )
+ }
+
+ return items, nil
+}
+
+// Delete removes a message send schedule owned by the given user.
+func (r *gormSendScheduleRepository) Delete(
+ ctx context.Context,
+ userID entities.UserID,
+ scheduleID uuid.UUID,
+) error {
+ ctx, span := r.tracer.Start(ctx)
+ defer span.End()
+
+ if err := r.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Where("id = ?", scheduleID).
+ Delete(&entities.MessageSendSchedule{}).Error; err != nil {
+ return r.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(err, "cannot delete send schedule [%s]", scheduleID),
+ )
+ }
+
+ return nil
+}
+
+// DeleteAllForUser removes all message send schedules owned by the given user.
+func (r *gormSendScheduleRepository) DeleteAllForUser(
+ ctx context.Context,
+ userID entities.UserID,
+) error {
+ ctx, span := r.tracer.Start(ctx)
+ defer span.End()
+
+ if err := r.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Delete(&entities.MessageSendSchedule{}).Error; err != nil {
+ return r.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(err, "cannot delete send schedules for user [%s]", userID),
+ )
+ }
+
+ return nil
+}
diff --git a/api/pkg/repositories/phone_notification_repository.go b/api/pkg/repositories/phone_notification_repository.go
index 87f78490..9d93f0b3 100644
--- a/api/pkg/repositories/phone_notification_repository.go
+++ b/api/pkg/repositories/phone_notification_repository.go
@@ -11,7 +11,7 @@ import (
// PhoneNotificationRepository loads and persists an entities.PhoneNotification
type PhoneNotificationRepository interface {
// Schedule a new entities.PhoneNotification
- Schedule(ctx context.Context, messagesPerMinute uint, notification *entities.PhoneNotification) error
+ Schedule(ctx context.Context, messagesPerMinute uint, schedule *entities.MessageSendSchedule, notification *entities.PhoneNotification) error
// UpdateStatus of a notification
UpdateStatus(ctx context.Context, notificationID uuid.UUID, status entities.PhoneNotificationStatus) error
diff --git a/api/pkg/repositories/repository.go b/api/pkg/repositories/repository.go
index 4a3e90dc..32ba4337 100644
--- a/api/pkg/repositories/repository.go
+++ b/api/pkg/repositories/repository.go
@@ -1,10 +1,8 @@
package repositories
import (
- "strings"
"time"
- "github.com/avast/retry-go/v5"
"github.com/palantir/stacktrace"
)
@@ -23,21 +21,3 @@ const (
dbOperationDuration = 5 * time.Second
)
-
-// isRetryableError checks if the error is a retryable connection error
-func isRetryableError(err error) bool {
- msg := err.Error()
- return strings.Contains(msg, "bad connection") ||
- strings.Contains(msg, "stream is closed") ||
- strings.Contains(msg, "driver: bad connection")
-}
-
-// executeWithRetry executes a GORM query with retry logic for transient connection errors
-func executeWithRetry(fn func() error) (err error) {
- return retry.New(
- retry.LastErrorOnly(true),
- retry.Attempts(5),
- retry.Delay(100*time.Millisecond),
- retry.RetryIf(isRetryableError),
- ).Do(fn)
-}
diff --git a/api/pkg/repositories/send_schedule_repository.go b/api/pkg/repositories/send_schedule_repository.go
new file mode 100644
index 00000000..57e07ca6
--- /dev/null
+++ b/api/pkg/repositories/send_schedule_repository.go
@@ -0,0 +1,29 @@
+package repositories
+
+import (
+ "context"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+ "github.com/google/uuid"
+)
+
+// SendScheduleRepository loads and persists entities.MessageSendSchedule.
+type SendScheduleRepository interface {
+ // Store persists a new message send schedule.
+ Store(ctx context.Context, schedule *entities.MessageSendSchedule) error
+
+ // Update persists changes to an existing message send schedule.
+ Update(ctx context.Context, schedule *entities.MessageSendSchedule) error
+
+ // Load returns a message send schedule by user ID and schedule ID.
+ Load(ctx context.Context, userID entities.UserID, scheduleID uuid.UUID) (*entities.MessageSendSchedule, error)
+
+ // Index returns all message send schedules owned by a user.
+ Index(ctx context.Context, userID entities.UserID) ([]entities.MessageSendSchedule, error)
+
+ // Delete removes a message send schedule owned by a user.
+ Delete(ctx context.Context, userID entities.UserID, scheduleID uuid.UUID) error
+
+ // DeleteAllForUser removes all message send schedules owned by a user.
+ DeleteAllForUser(ctx context.Context, userID entities.UserID) error
+}
diff --git a/api/pkg/requests/phone_update_request.go b/api/pkg/requests/phone_update_request.go
index f920fad4..bb710024 100644
--- a/api/pkg/requests/phone_update_request.go
+++ b/api/pkg/requests/phone_update_request.go
@@ -4,6 +4,8 @@ import (
"strings"
"time"
+ "github.com/google/uuid"
+
"github.com/nyaruka/phonenumbers"
"github.com/NdoleStudio/httpsms/pkg/entities"
@@ -28,6 +30,8 @@ type PhoneUpsert struct {
// SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot
SIM string `json:"sim" example:"SIM1"`
+
+ ScheduleID *string `json:"schedule_id" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
}
// Sanitize sets defaults to MessageOutstanding
@@ -69,6 +73,13 @@ func (input *PhoneUpsert) ToUpsertParams(user entities.AuthContext, source strin
maxSendAttempts = &input.MaxSendAttempts
}
+ var scheduleID *uuid.UUID
+ if input.ScheduleID != nil && strings.TrimSpace(*input.ScheduleID) != "" {
+ if parsed, err := uuid.Parse(strings.TrimSpace(*input.ScheduleID)); err == nil {
+ scheduleID = &parsed
+ }
+ }
+
return &services.PhoneUpsertParams{
Source: source,
PhoneNumber: phone,
@@ -79,5 +90,6 @@ func (input *PhoneUpsert) ToUpsertParams(user entities.AuthContext, source strin
FcmToken: fcmToken,
UserID: user.ID,
SIM: entities.SIM(input.SIM),
+ ScheduleID: scheduleID,
}
}
diff --git a/api/pkg/requests/send_schedule_store_request.go b/api/pkg/requests/send_schedule_store_request.go
new file mode 100644
index 00000000..8a6a2c3d
--- /dev/null
+++ b/api/pkg/requests/send_schedule_store_request.go
@@ -0,0 +1,48 @@
+package requests
+
+import (
+ "sort"
+ "strings"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+ "github.com/NdoleStudio/httpsms/pkg/services"
+)
+
+type SendScheduleWindow struct {
+ DayOfWeek int `json:"day_of_week"`
+ StartMinute int `json:"start_minute"`
+ EndMinute int `json:"end_minute"`
+}
+
+type SendScheduleStore struct {
+ request
+ Name string `json:"name"`
+ Timezone string `json:"timezone"`
+ IsActive bool `json:"is_active"`
+ Windows []SendScheduleWindow `json:"windows"`
+}
+
+func (input *SendScheduleStore) Sanitize() SendScheduleStore {
+ input.Name = strings.TrimSpace(input.Name)
+ input.Timezone = strings.TrimSpace(input.Timezone)
+ windows := make([]SendScheduleWindow, 0, len(input.Windows))
+ for _, item := range input.Windows {
+ windows = append(windows, SendScheduleWindow{DayOfWeek: item.DayOfWeek, StartMinute: item.StartMinute, EndMinute: item.EndMinute})
+ }
+ sort.SliceStable(windows, func(i, j int) bool {
+ if windows[i].DayOfWeek == windows[j].DayOfWeek {
+ return windows[i].StartMinute < windows[j].StartMinute
+ }
+ return windows[i].DayOfWeek < windows[j].DayOfWeek
+ })
+ input.Windows = windows
+ return *input
+}
+
+func (input *SendScheduleStore) ToParams(user entities.AuthContext) *services.SendScheduleUpsertParams {
+ windows := make([]entities.MessageSendScheduleWindow, 0, len(input.Windows))
+ for _, item := range input.Windows {
+ windows = append(windows, entities.MessageSendScheduleWindow{DayOfWeek: item.DayOfWeek, StartMinute: item.StartMinute, EndMinute: item.EndMinute})
+ }
+ return &services.SendScheduleUpsertParams{UserID: user.ID, Name: input.Name, Timezone: input.Timezone, IsActive: input.IsActive, Windows: windows}
+}
diff --git a/api/pkg/responses/send_schedule_responses.go b/api/pkg/responses/send_schedule_responses.go
new file mode 100644
index 00000000..9834de86
--- /dev/null
+++ b/api/pkg/responses/send_schedule_responses.go
@@ -0,0 +1,13 @@
+package responses
+
+import "github.com/NdoleStudio/httpsms/pkg/entities"
+
+type SendSchedulesResponse struct {
+ response
+ Data []entities.MessageSendSchedule `json:"data"`
+}
+
+type SendScheduleResponse struct {
+ response
+ Data entities.MessageSendSchedule `json:"data"`
+}
diff --git a/api/pkg/services/phone_notification_service.go b/api/pkg/services/phone_notification_service.go
index 7907d6d6..ffafa555 100644
--- a/api/pkg/services/phone_notification_service.go
+++ b/api/pkg/services/phone_notification_service.go
@@ -24,6 +24,7 @@ type PhoneNotificationService struct {
tracer telemetry.Tracer
phoneNotificationRepository repositories.PhoneNotificationRepository
phoneRepository repositories.PhoneRepository
+ sendScheduleRepository repositories.SendScheduleRepository
messagingClient *messaging.Client
eventDispatcher *EventDispatcher
}
@@ -35,14 +36,16 @@ func NewNotificationService(
messagingClient *messaging.Client,
phoneRepository repositories.PhoneRepository,
phoneNotificationRepository repositories.PhoneNotificationRepository,
+ sendScheduleRepository repositories.SendScheduleRepository,
dispatcher *EventDispatcher,
) (s *PhoneNotificationService) {
return &PhoneNotificationService{
- logger: logger.WithService(fmt.Sprintf("%T", s)),
+ logger: logger.WithService(fmt.Sprintf("%T", &PhoneNotificationService{})),
tracer: tracer,
messagingClient: messagingClient,
phoneNotificationRepository: phoneNotificationRepository,
phoneRepository: phoneRepository,
+ sendScheduleRepository: sendScheduleRepository,
eventDispatcher: dispatcher,
}
}
@@ -92,7 +95,13 @@ func (service *PhoneNotificationService) SendHeartbeatFCM(ctx context.Context, p
return nil
}
- ctxLogger.Info(fmt.Sprintf("successfully sent heartbeat FCM [%s] to phone with ID [%s] for user [%s] and monitor [%s]", result, payload.PhoneID, payload.UserID, payload.MonitorID))
+ ctxLogger.Info(fmt.Sprintf(
+ "successfully sent heartbeat FCM [%s] to phone with ID [%s] for user [%s] and monitor [%s]",
+ result,
+ payload.PhoneID,
+ payload.UserID,
+ payload.MonitorID,
+ ))
return nil
}
@@ -134,7 +143,15 @@ func (service *PhoneNotificationService) Send(ctx context.Context, params *Phone
Token: *phone.FcmToken,
})
if err != nil {
- ctxLogger.Warn(stacktrace.Propagate(err, fmt.Sprintf("cannot send FCM to phone with ID [%s] for user with ID [%s] and message [%s]", phone.ID, phone.UserID, params.MessageID)))
+ ctxLogger.Warn(stacktrace.Propagate(
+ err,
+ fmt.Sprintf(
+ "cannot send FCM to phone with ID [%s] for user with ID [%s] and message [%s]",
+ phone.ID,
+ phone.UserID,
+ params.MessageID,
+ ),
+ ))
msg := fmt.Sprintf("cannot send notification for to your phone [%s]. Reinstall the httpSMS app on your Android phone.", phone.PhoneNumber)
return service.handleNotificationFailed(ctx, errors.New(msg), params)
}
@@ -178,7 +195,20 @@ func (service *PhoneNotificationService) Schedule(ctx context.Context, params *P
UpdatedAt: time.Now().UTC(),
}
- if err = service.phoneNotificationRepository.Schedule(ctx, phone.MessagesPerMinute, notification); err != nil {
+ var schedule *entities.MessageSendSchedule
+ if phone.ScheduleID != nil {
+ schedule, err = service.sendScheduleRepository.Load(ctx, params.UserID, *phone.ScheduleID)
+ if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
+ schedule = nil
+ err = nil
+ }
+ if err != nil {
+ msg := fmt.Sprintf("cannot load send schedule [%s] for phone [%s]", *phone.ScheduleID, phone.ID)
+ return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+ }
+
+ if err = service.phoneNotificationRepository.Schedule(ctx, phone.MessagesPerMinute, schedule, notification); err != nil {
msg := fmt.Sprintf("cannot schedule notification for message [%s] to phone [%s]", params.MessageID, phone.ID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
@@ -191,11 +221,20 @@ func (service *PhoneNotificationService) Schedule(ctx context.Context, params *P
return service.tracer.WrapErrorSpan(span, err)
}
- ctxLogger.Info(fmt.Sprintf("message with id [%s] notification scheduled for [%s] with id [%s]", params.MessageID, notification.ScheduledAt, notification.ID))
+ ctxLogger.Info(fmt.Sprintf(
+ "message with id [%s] notification scheduled for [%s] with id [%s]",
+ params.MessageID,
+ notification.ScheduledAt,
+ notification.ID,
+ ))
return nil
}
-func (service *PhoneNotificationService) dispatchMessageNotificationSend(ctx context.Context, source string, notification *entities.PhoneNotification) error {
+func (service *PhoneNotificationService) dispatchMessageNotificationSend(
+ ctx context.Context,
+ source string,
+ notification *entities.PhoneNotification,
+) error {
event, err := service.createMessageNotificationSendEvent(source, &events.MessageNotificationSendPayload{
MessageID: notification.MessageID,
UserID: notification.UserID,
@@ -213,7 +252,11 @@ func (service *PhoneNotificationService) dispatchMessageNotificationSend(ctx con
return nil
}
-func (service *PhoneNotificationService) dispatchMessageNotificationScheduled(ctx context.Context, params *PhoneNotificationScheduleParams, notification *entities.PhoneNotification) error {
+func (service *PhoneNotificationService) dispatchMessageNotificationScheduled(
+ ctx context.Context,
+ params *PhoneNotificationScheduleParams,
+ notification *entities.PhoneNotification,
+) error {
event, err := service.createMessageNotificationScheduledEvent(params.Source, &events.MessageNotificationScheduledPayload{
MessageID: notification.MessageID,
Owner: params.Owner,
@@ -258,7 +301,12 @@ func (service *PhoneNotificationService) handleNotificationFailed(ctx context.Co
return nil
}
-func (service *PhoneNotificationService) handleNotificationSent(ctx context.Context, phone *entities.Phone, result string, params *PhoneNotificationSendParams) error {
+func (service *PhoneNotificationService) handleNotificationSent(
+ ctx context.Context,
+ phone *entities.Phone,
+ result string,
+ params *PhoneNotificationSendParams,
+) error {
ctx, span := service.tracer.Start(ctx)
defer span.End()
@@ -279,15 +327,26 @@ func (service *PhoneNotificationService) handleNotificationSent(ctx context.Cont
return nil
}
-func (service *PhoneNotificationService) createMessageNotificationScheduledEvent(source string, payload *events.MessageNotificationScheduledPayload) (cloudevents.Event, error) {
+func (service *PhoneNotificationService) createMessageNotificationScheduledEvent(
+ source string,
+ payload *events.MessageNotificationScheduledPayload,
+) (cloudevents.Event, error) {
return service.createEvent(events.EventTypeMessageNotificationScheduled, source, payload)
}
-func (service *PhoneNotificationService) createMessageNotificationSendEvent(source string, payload *events.MessageNotificationSendPayload) (cloudevents.Event, error) {
+func (service *PhoneNotificationService) createMessageNotificationSendEvent(
+ source string,
+ payload *events.MessageNotificationSendPayload,
+) (cloudevents.Event, error) {
return service.createEvent(events.EventTypeMessageNotificationSend, source, payload)
}
-func (service *PhoneNotificationService) createMessageNotificationSentEvent(source string, phone *entities.Phone, fcmMessageID string, params *PhoneNotificationSendParams) (cloudevents.Event, error) {
+func (service *PhoneNotificationService) createMessageNotificationSentEvent(
+ source string,
+ phone *entities.Phone,
+ fcmMessageID string,
+ params *PhoneNotificationSendParams,
+) (cloudevents.Event, error) {
event := cloudevents.NewEvent()
event.SetSource(source)
@@ -314,7 +373,11 @@ func (service *PhoneNotificationService) createMessageNotificationSentEvent(sour
return event, nil
}
-func (service *PhoneNotificationService) createMessageNotificationFailedEvent(source string, errorMessage string, params *PhoneNotificationSendParams) (cloudevents.Event, error) {
+func (service *PhoneNotificationService) createMessageNotificationFailedEvent(
+ source string,
+ errorMessage string,
+ params *PhoneNotificationSendParams,
+) (cloudevents.Event, error) {
event := cloudevents.NewEvent()
event.SetSource(source)
@@ -339,7 +402,11 @@ func (service *PhoneNotificationService) createMessageNotificationFailedEvent(so
return event, nil
}
-func (service *PhoneNotificationService) updateStatus(ctx context.Context, notificationID uuid.UUID, status entities.PhoneNotificationStatus) {
+func (service *PhoneNotificationService) updateStatus(
+ ctx context.Context,
+ notificationID uuid.UUID,
+ status entities.PhoneNotificationStatus,
+) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
@@ -347,9 +414,9 @@ func (service *PhoneNotificationService) updateStatus(ctx context.Context, notif
err := service.phoneNotificationRepository.UpdateStatus(ctx, notificationID, status)
if err != nil {
- msg := fmt.Sprintf("cannot update status of notificaiton with id [%s] to [%s]", notificationID, status)
+ msg := fmt.Sprintf("cannot update status of notification with id [%s] to [%s]", notificationID, status)
ctxLogger.Error(stacktrace.Propagate(err, msg))
}
- ctxLogger.Info(fmt.Sprintf("updated status of notificaiton with id [%s] to [%s]", notificationID, status))
+ ctxLogger.Info(fmt.Sprintf("updated status of notification with id [%s] to [%s]", notificationID, status))
}
diff --git a/api/pkg/services/phone_service.go b/api/pkg/services/phone_service.go
index df8e2104..9fa01ab0 100644
--- a/api/pkg/services/phone_service.go
+++ b/api/pkg/services/phone_service.go
@@ -91,6 +91,7 @@ type PhoneUpsertParams struct {
MessageExpirationDuration *time.Duration
MissedCallAutoReply *string
SIM entities.SIM
+ ScheduleID *uuid.UUID
Source string
UserID entities.UserID
}
@@ -111,6 +112,7 @@ func (service *PhoneService) Upsert(ctx context.Context, params *PhoneUpsertPara
UserID: params.UserID,
FcmToken: params.FcmToken,
SIM: params.SIM,
+ ScheduleID: params.ScheduleID,
})
}
@@ -132,6 +134,7 @@ func (service *PhoneService) Upsert(ctx context.Context, params *PhoneUpsertPara
UserID: params.UserID,
FcmToken: params.FcmToken,
SIM: params.SIM,
+ ScheduleID: params.ScheduleID,
})
}
@@ -207,6 +210,7 @@ type PhoneFCMTokenParams struct {
UserID entities.UserID
FcmToken *string
SIM entities.SIM
+ ScheduleID *uuid.UUID
}
// UpsertFCMToken the FCM token for an entities.Phone
@@ -251,6 +255,7 @@ func (service *PhoneService) createPhone(ctx context.Context, params *PhoneFCMTo
MaxSendAttempts: 2,
SIM: params.SIM,
MissedCallAutoReply: nil,
+ ScheduleID: params.ScheduleID,
PhoneNumber: phonenumbers.Format(params.PhoneNumber, phonenumbers.E164),
CreatedAt: time.Now().UTC(),
UpdatedAt: time.Now().UTC(),
@@ -294,6 +299,7 @@ func (service *PhoneService) update(phone *entities.Phone, params *PhoneUpsertPa
}
phone.SIM = params.SIM
+ phone.ScheduleID = params.ScheduleID
return phone
}
diff --git a/api/pkg/services/send_schedule_service.go b/api/pkg/services/send_schedule_service.go
new file mode 100644
index 00000000..5bbddb7d
--- /dev/null
+++ b/api/pkg/services/send_schedule_service.go
@@ -0,0 +1,181 @@
+package services
+
+import (
+ "context"
+ "fmt"
+ "sort"
+ "time"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+ "github.com/NdoleStudio/httpsms/pkg/repositories"
+ "github.com/NdoleStudio/httpsms/pkg/telemetry"
+ "github.com/google/uuid"
+ "github.com/palantir/stacktrace"
+)
+
+// SendScheduleService manages message send schedules for a user.
+type SendScheduleService struct {
+ service
+ logger telemetry.Logger
+ tracer telemetry.Tracer
+ repository repositories.SendScheduleRepository
+}
+
+// NewSendScheduleService creates a new SendScheduleService.
+func NewSendScheduleService(
+ logger telemetry.Logger,
+ tracer telemetry.Tracer,
+ repository repositories.SendScheduleRepository,
+) *SendScheduleService {
+ return &SendScheduleService{
+ logger: logger.WithService(fmt.Sprintf("%T", &SendScheduleService{})),
+ tracer: tracer,
+ repository: repository,
+ }
+}
+
+// SendScheduleUpsertParams contains the fields required to create or update a message send schedule.
+type SendScheduleUpsertParams struct {
+ UserID entities.UserID
+ Name string
+ Timezone string
+ IsActive bool
+ Windows []entities.MessageSendScheduleWindow
+}
+
+// Index returns all message send schedules for a user.
+func (service *SendScheduleService) Index(
+ ctx context.Context,
+ userID entities.UserID,
+) ([]entities.MessageSendSchedule, error) {
+ return service.repository.Index(ctx, userID)
+}
+
+// Load returns a single message send schedule for a user.
+func (service *SendScheduleService) Load(
+ ctx context.Context,
+ userID entities.UserID,
+ scheduleID uuid.UUID,
+) (*entities.MessageSendSchedule, error) {
+ return service.repository.Load(ctx, userID, scheduleID)
+}
+
+// Store creates a new message send schedule.
+func (service *SendScheduleService) Store(
+ ctx context.Context,
+ params *SendScheduleUpsertParams,
+) (*entities.MessageSendSchedule, error) {
+ ctx, span := service.tracer.Start(ctx)
+ defer span.End()
+
+ schedule := &entities.MessageSendSchedule{
+ ID: uuid.New(),
+ UserID: params.UserID,
+ Name: params.Name,
+ Timezone: params.Timezone,
+ IsActive: params.IsActive,
+ Windows: sanitizeWindows(params.Windows),
+ CreatedAt: time.Now().UTC(),
+ UpdatedAt: time.Now().UTC(),
+ }
+
+ if err := service.repository.Store(ctx, schedule); err != nil {
+ return nil, service.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ fmt.Sprintf("cannot store message send schedule [%s]", schedule.ID),
+ ),
+ )
+ }
+
+ return schedule, nil
+}
+
+// Update updates an existing message send schedule.
+func (service *SendScheduleService) Update(
+ ctx context.Context,
+ userID entities.UserID,
+ scheduleID uuid.UUID,
+ params *SendScheduleUpsertParams,
+) (*entities.MessageSendSchedule, error) {
+ ctx, span := service.tracer.Start(ctx)
+ defer span.End()
+
+ schedule, err := service.repository.Load(ctx, userID, scheduleID)
+ if err != nil {
+ return nil, err
+ }
+
+ schedule.Name = params.Name
+ schedule.Timezone = params.Timezone
+ schedule.IsActive = params.IsActive
+ schedule.Windows = sanitizeWindows(params.Windows)
+ schedule.UpdatedAt = time.Now().UTC()
+
+ if err = service.repository.Update(ctx, schedule); err != nil {
+ return nil, service.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ fmt.Sprintf("cannot update message send schedule [%s]", schedule.ID),
+ ),
+ )
+ }
+
+ return schedule, nil
+}
+
+// Delete removes a message send schedule for a user.
+func (service *SendScheduleService) Delete(
+ ctx context.Context,
+ userID entities.UserID,
+ scheduleID uuid.UUID,
+) error {
+ return service.repository.Delete(ctx, userID, scheduleID)
+}
+
+// sanitizeWindows normalizes and sorts schedule windows by day and start minute.
+func sanitizeWindows(
+ windows []entities.MessageSendScheduleWindow,
+) []entities.MessageSendScheduleWindow {
+ result := make([]entities.MessageSendScheduleWindow, 0, len(windows))
+
+ for _, item := range windows {
+ result = append(result, entities.MessageSendScheduleWindow{
+ DayOfWeek: item.DayOfWeek,
+ StartMinute: item.StartMinute,
+ EndMinute: item.EndMinute,
+ })
+ }
+
+ sort.SliceStable(result, func(i, j int) bool {
+ if result[i].DayOfWeek == result[j].DayOfWeek {
+ return result[i].StartMinute < result[j].StartMinute
+ }
+ return result[i].DayOfWeek < result[j].DayOfWeek
+ })
+
+ return result
+}
+
+// DeleteAllForUser removes all message send schedules owned by a user.
+func (service *SendScheduleService) DeleteAllForUser(
+ ctx context.Context,
+ userID entities.UserID,
+) error {
+ ctx, span := service.tracer.Start(ctx)
+ defer span.End()
+
+ if err := service.repository.DeleteAllForUser(ctx, userID); err != nil {
+ return service.tracer.WrapErrorSpan(
+ span,
+ stacktrace.Propagate(
+ err,
+ fmt.Sprintf("cannot delete message send schedules for user [%s]", userID),
+ ),
+ )
+ }
+
+ return nil
+}
diff --git a/api/pkg/validators/phone_handler_validator.go b/api/pkg/validators/phone_handler_validator.go
index 2369214e..f9c78255 100644
--- a/api/pkg/validators/phone_handler_validator.go
+++ b/api/pkg/validators/phone_handler_validator.go
@@ -88,6 +88,15 @@ func (validator *PhoneHandlerValidator) ValidateUpsert(_ context.Context, reques
})
result := v.ValidateStruct()
+ if request.ScheduleID != nil && strings.TrimSpace(*request.ScheduleID) != "" {
+ if uuidErrors := validator.ValidateUUID(strings.TrimSpace(*request.ScheduleID), "schedule_id"); len(uuidErrors) > 0 {
+ for key, values := range uuidErrors {
+ for _, value := range values {
+ result.Add(key, value)
+ }
+ }
+ }
+ }
if len(result) > 0 {
return result
}
diff --git a/api/pkg/validators/send_schedule_handler_validator.go b/api/pkg/validators/send_schedule_handler_validator.go
new file mode 100644
index 00000000..d402fa5c
--- /dev/null
+++ b/api/pkg/validators/send_schedule_handler_validator.go
@@ -0,0 +1,160 @@
+package validators
+
+import (
+ "context"
+ "fmt"
+ "net/url"
+ "sort"
+ "time"
+
+ "github.com/NdoleStudio/httpsms/pkg/requests"
+ "github.com/NdoleStudio/httpsms/pkg/telemetry"
+ "github.com/thedevsaddam/govalidator"
+)
+
+const maxWindowsPerDay = 6
+
+// SendScheduleHandlerValidator validates send schedule HTTP requests.
+type SendScheduleHandlerValidator struct {
+ validator
+ logger telemetry.Logger
+ tracer telemetry.Tracer
+}
+
+// NewSendScheduleHandlerValidator creates a new SendScheduleHandlerValidator.
+func NewSendScheduleHandlerValidator(
+ logger telemetry.Logger,
+ tracer telemetry.Tracer,
+) *SendScheduleHandlerValidator {
+ return &SendScheduleHandlerValidator{
+ logger: logger.WithService(fmt.Sprintf("%T", &SendScheduleHandlerValidator{})),
+ tracer: tracer,
+ }
+}
+
+// ValidateStore validates a send schedule create or update request.
+func (validator *SendScheduleHandlerValidator) ValidateStore(
+ _ context.Context,
+ request requests.SendScheduleStore,
+) url.Values {
+ v := govalidator.New(govalidator.Options{
+ Data: &request,
+ Rules: govalidator.MapData{
+ "name": []string{"required", "min:2", "max:100"},
+ "timezone": []string{"required", "min:2", "max:100"},
+ },
+ })
+
+ result := v.ValidateStruct()
+ validator.validateWindows(result, request.Windows)
+
+ if request.Timezone != "" {
+ if _, err := time.LoadLocation(request.Timezone); err != nil {
+ result.Add("timezone", "timezone must be a valid IANA timezone")
+ }
+ }
+
+ return result
+}
+
+func (validator *SendScheduleHandlerValidator) validateWindows(
+ result url.Values,
+ windows []requests.SendScheduleWindow,
+) {
+ windowsPerDay := make(map[int]int)
+
+ for index, item := range windows {
+ validator.validateDayOfWeek(result, index, item, windowsPerDay)
+ validator.validateStartMinute(result, index, item)
+ validator.validateEndMinute(result, index, item)
+ validator.validateWindowRange(result, index, item)
+ }
+
+ validator.validateOverlappingWindows(result, windows)
+}
+
+func (validator *SendScheduleHandlerValidator) validateDayOfWeek(
+ result url.Values,
+ index int,
+ item requests.SendScheduleWindow,
+ windowsPerDay map[int]int,
+) {
+ if item.DayOfWeek < 0 || item.DayOfWeek > 6 {
+ result.Add("windows", fmt.Sprintf("windows[%d].day_of_week must be between 0 and 6", index))
+ return
+ }
+
+ windowsPerDay[item.DayOfWeek]++
+ if windowsPerDay[item.DayOfWeek] > maxWindowsPerDay {
+ result.Add(
+ "windows",
+ fmt.Sprintf("day_of_week %d cannot have more than %d windows", item.DayOfWeek, maxWindowsPerDay),
+ )
+ }
+}
+
+func (validator *SendScheduleHandlerValidator) validateStartMinute(
+ result url.Values,
+ index int,
+ item requests.SendScheduleWindow,
+) {
+ if item.StartMinute < 0 || item.StartMinute > 1439 {
+ result.Add("windows", fmt.Sprintf("windows[%d].start_minute must be between 0 and 1439", index))
+ }
+}
+
+func (validator *SendScheduleHandlerValidator) validateEndMinute(
+ result url.Values,
+ index int,
+ item requests.SendScheduleWindow,
+) {
+ if item.EndMinute < 1 || item.EndMinute > 1440 {
+ result.Add("windows", fmt.Sprintf("windows[%d].end_minute must be between 1 and 1440", index))
+ }
+}
+
+func (validator *SendScheduleHandlerValidator) validateWindowRange(
+ result url.Values,
+ index int,
+ item requests.SendScheduleWindow,
+) {
+ if item.EndMinute <= item.StartMinute {
+ result.Add("windows", fmt.Sprintf("windows[%d].end_minute must be greater than start_minute", index))
+ }
+}
+
+func (validator *SendScheduleHandlerValidator) validateOverlappingWindows(
+ result url.Values,
+ windows []requests.SendScheduleWindow,
+) {
+ grouped := make(map[int][]requests.SendScheduleWindow)
+
+ for _, item := range windows {
+ if item.DayOfWeek < 0 || item.DayOfWeek > 6 {
+ continue
+ }
+ if item.EndMinute <= item.StartMinute {
+ continue
+ }
+ grouped[item.DayOfWeek] = append(grouped[item.DayOfWeek], item)
+ }
+
+ for dayOfWeek, dayWindows := range grouped {
+ sort.Slice(dayWindows, func(i, j int) bool {
+ return dayWindows[i].StartMinute < dayWindows[j].StartMinute
+ })
+
+ for i := 1; i < len(dayWindows); i++ {
+ previous := dayWindows[i-1]
+ current := dayWindows[i]
+
+ if current.StartMinute < previous.EndMinute {
+ result.Add(
+ "windows",
+ fmt.Sprintf("day_of_week %d contains overlapping windows", dayOfWeek),
+ )
+ break
+ }
+ }
+ }
+}
diff --git a/web/models/api.ts b/web/models/api.ts
index 660e7493..c305c134 100644
--- a/web/models/api.ts
+++ b/web/models/api.ts
@@ -172,6 +172,8 @@ export interface EntitiesPhone {
missed_call_auto_reply?: string
/** @example "+18005550199" */
phone_number: string
+ /** @example "32343a19-da5e-4b1b-a767-3298a73703cb" */
+ schedule_id?: string | null
/** SIM card that received the message */
sim: string
/** @example "2022-06-05T14:26:10.303278+03:00" */
@@ -255,6 +257,62 @@ export interface EntitiesWebhook {
user_id: string
}
+export interface EntitiesSendScheduleWindow {
+ /** @example 1 */
+ day_of_week: number
+ /** @example 1020 */
+ end_minute: number
+ /** @example 540 */
+ start_minute: number
+}
+
+export interface EntitiesSendSchedule {
+ /** @example true */
+ is_active: boolean
+ /** @example "2022-06-05T14:26:02.302718+03:00" */
+ created_at: string
+ /** @example "32343a19-da5e-4b1b-a767-3298a73703cb" */
+ id: string
+ /** @example "Business Hours" */
+ name: string
+ /** @example "Africa/Accra" */
+ timezone: string
+ /** @example "2022-06-05T14:26:10.303278+03:00" */
+ updated_at: string
+ /** @example "WB7DRDWrJZRGbYrv2CKGkqbzvqdC" */
+ user_id: string
+ windows: EntitiesSendScheduleWindow[]
+}
+
+export interface RequestsSendScheduleWindow {
+ day_of_week: number
+ end_minute: number
+ start_minute: number
+}
+
+export interface RequestsSendScheduleStore {
+ is_active: boolean
+ name: string
+ timezone: string
+ windows: RequestsSendScheduleWindow[]
+}
+
+export interface ResponsesSendScheduleResponse {
+ data: EntitiesSendSchedule
+ /** @example "Request handled successfully" */
+ message: string
+ /** @example "success" */
+ status: string
+}
+
+export interface ResponsesSendSchedulesResponse {
+ data: EntitiesSendSchedule[]
+ /** @example "Request handled successfully" */
+ message: string
+ /** @example "success" */
+ status: string
+}
+
export interface RequestsDiscordStore {
incoming_channel_id: string
name: string
diff --git a/web/pages/settings/index.vue b/web/pages/settings/index.vue
index 6d3415d0..ed666bec 100644
--- a/web/pages/settings/index.vue
+++ b/web/pages/settings/index.vue
@@ -50,6 +50,7 @@
@change="updateTimezone"
>
+
API Key
Use your API Key in the x-api-key HTTP Header when
@@ -171,6 +172,18 @@
+
+
Send Schedules
+
+ Manage availability schedules on a dedicated page and attach one
+ schedule to each phone. Outgoing messages will respect both the
+ selected schedule and the configured send rate.
+
+
+ {{ mdiCalendarClock }}
+ Manage Send Schedules
+
+
Webhooks
Webhooks allow us to send events to your server for example when
@@ -244,6 +257,7 @@
>Documentation
+
Discord Integration
@@ -310,6 +324,7 @@
>
Add Discord
+
Phones
List of mobile phones which are registered for sending and
@@ -370,6 +385,7 @@
+
Email Notifications
@@ -415,7 +431,11 @@
{{ mdiContentSave }}
Save Notification Settings
-
+
+
Delete Account
@@ -485,6 +505,7 @@
+
Edit Phone
@@ -549,6 +570,18 @@
label="Max Send Attempts"
>
+
-
+
+
Add a new
@@ -696,7 +734,12 @@
-
+
+
Add a new
@@ -817,6 +860,7 @@ import Vue from 'vue'
import {
mdiArrowLeft,
mdiAccountCircle,
+ mdiCalendarClock,
mdiShieldCheck,
mdiDelete,
mdiContentSave,
@@ -843,6 +887,7 @@ export default Vue.extend({
mdiRefresh,
mdiArrowLeft,
mdiAccountCircle,
+ mdiCalendarClock,
mdiShieldCheck,
mdiDelete,
mdiQrcode,
@@ -889,6 +934,7 @@ export default Vue.extend({
updatingPhone: false,
updatingDiscord: false,
loadingDiscordIntegrations: false,
+ sendSchedules: [],
events: [
'message.phone.received',
'message.phone.sent',
@@ -920,7 +966,11 @@ export default Vue.extend({
return this.$store.getters.getUser.subscription_renews_at != null
},
timezones() {
- return Intl.supportedValuesOf('timeZone')
+ try {
+ return Intl.supportedValuesOf('timeZone')
+ } catch {
+ return []
+ }
},
phoneNumbers() {
return this.$store.getters.getPhones.map((phone) => {
@@ -945,6 +995,7 @@ export default Vue.extend({
])
this.loadWebhooks()
this.loadDiscordIntegrations()
+ this.loadSendSchedules()
this.updateEmailNotifications()
if (this.$route.hash) {
await this.$vuetify.goTo(this.$route.hash)
@@ -1230,6 +1281,17 @@ export default Vue.extend({
})
},
+ loadSendSchedules() {
+ this.$store
+ .dispatch('getSendSchedules')
+ .then((sendSchedules) => {
+ this.sendSchedules = sendSchedules
+ })
+ .catch(() => {
+ this.sendSchedules = []
+ })
+ },
+
loadWebhooks() {
this.loadingWebhooks = true
this.$store
diff --git a/web/pages/settings/send-schedules/index.vue b/web/pages/settings/send-schedules/index.vue
new file mode 100644
index 00000000..d271f7a2
--- /dev/null
+++ b/web/pages/settings/send-schedules/index.vue
@@ -0,0 +1,633 @@
+
+
+
+
+
+ {{ mdiArrowLeft }}
+
+
+ Send Schedules
+
+
+
+
+
+
+
+ Send schedules allow you to set custom time intervals when
+ outgoing messages will be sent. You can create one schedule and
+ attach it to multiple phone numbers from the Settings page.
+
+
+
+
+ {{ mdiPlus }}
+ Add Send Schedule
+
+
+
+
+
+
+
+
+
+
+
+
+ {{ schedule.name }}
+
+
+ {{ isScheduleActive(schedule) ? 'Active' : 'Inactive' }}
+
+
+
+ {{ schedule.timezone }}
+
+
+
+ {{ line }}
+
+
+
+
+
+ {{ mdiSquareEditOutline }}
+ Edit
+
+
+
+
+
+ {{ mdiDelete }}
+ Delete
+
+
+
+
+
+
+
+ No schedules yet. Create your first send schedule.
+
+
+
+
+
+ {{
+ activeSchedule.id ? 'Edit Send Schedule' : 'Add Send Schedule'
+ }}
+
+
+ Cancel
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ {{ message }}
+
+
+
+
+
+
+
+ {{ day.label }}
+
+
+
+
+
+
+
+ {{ mdiPlus }}
+ Add window
+
+
+ Unavailable
+
+
+
+
+
+
+
+
–
+
+
+
+
+
+
+
+ {{ mdiDelete }}
+
+
+
+