Send and receive SMS messages using your Android phone programmatically via a simple HTTP API
Regenerate swagger after merging upstream main
giresse1964c351adbd0e
diff --git a/api/docs/docs.go b/api/docs/docs.goindex 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.jsonindex 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": "[email protected]",- "email": "[email protected]"- },- "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": "[email protected]",+ "email": "[email protected]"},- "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": "[email protected]"- },- "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": "[email protected]"- },- "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": "[email protected]"+ },+ "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": "[email protected]"+ },+ "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 filediff --git a/api/docs/swagger.yaml b/api/docs/swagger.yamlindex f5563f2a..118671d8 100644--- a/api/docs/swagger.yaml+++ b/api/docs/swagger.yaml@@ -30,15 +30,15 @@ definitions:example: WB7DRDWrJZRGbYrv2CKGkqbzvqdCtype: stringrequired:- - 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_idtype: objectentities.Discord:properties:@@ -64,13 +64,13 @@ definitions:example: WB7DRDWrJZRGbYrv2CKGkqbzvqdCtype: stringrequired:- - 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_idtype: objectentities.Heartbeat:properties:@@ -93,19 +93,19 @@ definitions:example: 344c10ftype: stringrequired:- - charging- - id- - owner- - timestamp- - user_id- - version+ - charging+ - id+ - owner+ - timestamp+ - user_id+ - versiontype: objectentities.Message:properties:attachments:example:- - https://example.com/image.jpg- - https://example.com/video.mp4+ - https://example.com/image.jpg+ - https://example.com/video.mp4items:type: stringtype: array@@ -167,8 +167,7 @@ definitions:example: 0type: integersend_time:- description:- SendDuration is the number of nanoseconds from when the request+ description: SendDuration is the number of nanoseconds from when the requestwas received until when the mobile phone send the messageexample: 133414type: integer@@ -177,7 +176,7 @@ definitions:type: stringsim: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: WB7DRDWrJZRGbYrv2CKGkqbzvqdCtype: stringrequired:- - 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_minutetype: objectentities.MessageThread:properties:@@ -253,18 +305,18 @@ definitions:example: WB7DRDWrJZRGbYrv2CKGkqbzvqdCtype: stringrequired:- - 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_idtype: objectentities.Phone:properties:@@ -278,14 +330,12 @@ definitions:example: 32343a19-da5e-4b1b-a767-3298a73703cbtype: stringmax_send_attempts:- description:- MaxSendAttempts determines how many times to retry sending an+ description: MaxSendAttempts determines how many times to retry sending anSMS messageexample: 2type: integermessage_expiration_seconds:- description:- MessageExpirationSeconds is the duration in seconds after sending+ description: MessageExpirationSeconds is the duration in seconds after sendinga message when it is considered to be expired.type: integermessages_per_minute:@@ -297,8 +347,11 @@ definitions:phone_number:example: "+18005550199"type: string+ schedule_id:+ example: 32343a19-da5e-4b1b-a767-3298a73703cb+ type: stringsim:- $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: WB7DRDWrJZRGbYrv2CKGkqbzvqdCtype: stringrequired:- - 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_idtype: objectentities.PhoneAPIKey:properties:@@ -332,15 +386,15 @@ definitions:type: stringphone_ids:example:- - 32343a19-da5e-4b1b-a767-3298a73703cb- - 32343a19-da5e-4b1b-a767-3298a73703cc+ - 32343a19-da5e-4b1b-a767-3298a73703cb+ - 32343a19-da5e-4b1b-a767-3298a73703ccitems:type: stringtype: arrayphone_numbers:example:- - "+18005550199"- - "+18005550100"+ - "+18005550199"+ - "+18005550100"items:type: stringtype: array@@ -354,50 +408,50 @@ definitions:example: WB7DRDWrJZRGbYrv2CKGkqbzvqdCtype: stringrequired:- - 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_idtype: objectentities.SIM:enum:- - SIM1- - SIM2+ - SIM1+ - SIM2type: stringx-enum-varnames:- - SIM1- - SIM2+ - SIM1+ - SIM2entities.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-yearlytype: stringx-enum-varnames:- - SubscriptionNameFree- - SubscriptionNameProMonthly- - SubscriptionNameProYearly- - SubscriptionNameUltraMonthly- - SubscriptionNameUltraYearly- - SubscriptionNameProLifetime- - SubscriptionName20KMonthly- - SubscriptionName100KMonthly- - SubscriptionName50KMonthly- - SubscriptionName200KMonthly- - SubscriptionName20KYearly+ - SubscriptionNameFree+ - SubscriptionNameProMonthly+ - SubscriptionNameProYearly+ - SubscriptionNameUltraMonthly+ - SubscriptionNameUltraYearly+ - SubscriptionNameProLifetime+ - SubscriptionName20KMonthly+ - SubscriptionName100KMonthly+ - SubscriptionName50KMonthly+ - SubscriptionName200KMonthly+ - SubscriptionName20KYearlyentities.User:properties:active_phone_id:@@ -435,7 +489,7 @@ definitions:type: stringsubscription_name:allOf:- - $ref: "#/definitions/entities.SubscriptionName"+ - $ref: '#/definitions/entities.SubscriptionName'example: freesubscription_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: stringrequired:- - api_key- - created_at- - 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+ - id+ - notification_heartbeat_enabled+ - notification_message_status_enabled+ - notification_newsletter_enabled+ - notification_webhook_enabled+ - subscription_id+ - subscription_name+ - timezone+ - updated_attype: objectentities.Webhook:properties:@@ -470,7 +524,7 @@ definitions:type: stringevents:example:- - message.phone.received+ - message.phone.receiveditems:type: stringtype: array@@ -479,8 +533,8 @@ definitions:type: stringphone_numbers:example:- - "+18005550199"- - "+18005550100"+ - "+18005550199"+ - "+18005550100"items:type: stringtype: array@@ -497,14 +551,14 @@ definitions:example: WB7DRDWrJZRGbYrv2CKGkqbzvqdCtype: stringrequired:- - 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_idtype: objectrequests.DiscordStore:properties:@@ -515,9 +569,9 @@ definitions:server_id:type: stringrequired:- - incoming_channel_id- - name- - server_id+ - incoming_channel_id+ - name+ - server_idtype: objectrequests.DiscordUpdate:properties:@@ -528,9 +582,9 @@ definitions:server_id:type: stringrequired:- - incoming_channel_id- - name- - server_id+ - incoming_channel_id+ - name+ - server_idtype: objectrequests.HeartbeatStore:properties:@@ -541,8 +595,8 @@ definitions:type: stringtype: arrayrequired:- - charging- - phone_numbers+ - charging+ - phone_numberstype: objectrequests.MessageAttachment:properties:@@ -559,15 +613,14 @@ definitions:example: photo.jpgtype: stringrequired:- - content- - content_type- - name+ - content+ - content_type+ - nametype: objectrequests.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 MMSitems:type: string@@ -576,8 +629,7 @@ definitions:example: This is a sample text messagetype: stringencrypted:- 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 appexample: falsetype: boolean@@ -585,22 +637,21 @@ definitions:example: "+18005550199"type: stringrequest_id:- description:- RequestID is an optional parameter used to track a request from+ description: RequestID is an optional parameter used to track a request fromthe client's perspectiveexample: 153554b5-ae44-44a0-8f4f-7bbac5657ad4type: stringto:example:- - "+18005550100"- - "+18005550100"+ - "+18005550100"+ - "+18005550100"items:type: stringtype: arrayrequired:- - content- - from- - to+ - content+ - from+ - totype: objectrequests.MessageCallMissed:properties:@@ -617,10 +668,10 @@ definitions:example: "+18005550100"type: stringrequired:- - from- - sim- - timestamp- - to+ - from+ - sim+ - timestamp+ - totype: objectrequests.MessageEvent:properties:@@ -636,31 +687,28 @@ definitions:description: Reason is the exact error message in case the event is an errortype: stringtimestamp:- description:- Timestamp is the time when the event was emitted, Please send+ description: Timestamp is the time when the event was emitted, Please sendthe timestamp in UTC with as much precision as possibleexample: "2022-06-05T14:26:09.527976+03:00"type: stringrequired:- - event_name- - reason- - timestamp+ - event_name+ - reason+ - timestamptype: objectrequests.MessageReceive:properties:attachments:- description:- Attachments is the list of MMS attachments received with the+ description: Attachments is the list of MMS attachments received with themessageitems:- $ref: "#/definitions/requests.MessageAttachment"+ $ref: '#/definitions/requests.MessageAttachment'type: arraycontent:example: This is a sample text message received on a phonetype: stringencrypted:- 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 appexample: falsetype: boolean@@ -669,12 +717,11 @@ definitions:type: stringsim:allOf:- - $ref: "#/definitions/entities.SIM"+ - $ref: '#/definitions/entities.SIM'description: SIM card that received the messageexample: SIM1timestamp:- description:- Timestamp is the time when the event was emitted, Please send+ description: Timestamp is the time when the event was emitted, Please sendthe timestamp in UTC with as much precision as possibleexample: "2022-06-05T14:26:09.527976+03:00"type: string@@ -682,22 +729,21 @@ definitions:example: "+18005550100"type: stringrequired:- - content- - encrypted- - from- - sim- - timestamp- - to+ - content+ - encrypted+ - from+ - sim+ - timestamp+ - totype: objectrequests.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 MMSexample:- - https://example.com/image.jpg- - https://example.com/video.mp4+ - https://example.com/image.jpg+ - https://example.com/video.mp4items:type: stringtype: array@@ -705,8 +751,7 @@ definitions:example: This is a sample text messagetype: stringencrypted:- description:- Encrypted is an optional parameter used to determine if the content+ description: Encrypted is an optional parameter used to determine if the contentis end-to-end encrypted. Make sure to set the encryption key on the httpSMSmobile appexample: false@@ -715,14 +760,12 @@ definitions:example: "+18005550199"type: stringrequest_id:- description:- RequestID is an optional parameter used to track a request from+ description: RequestID is an optional parameter used to track a request fromthe client's perspectiveexample: 153554b5-ae44-44a0-8f4f-7bbac5657ad4type: stringsend_at:- description:- SendAt is an optional parameter used to schedule a message to+ description: SendAt is an optional parameter used to schedule a message tobe sent in the future. The time is considered to be in your profile's localtimezone and you can queue messages for up to 20 days (480 hours) in thefuture.@@ -732,9 +775,9 @@ definitions:example: "+18005550100"type: stringrequired:- - content- - from- - to+ - content+ - from+ - totype: objectrequests.MessageThreadUpdate:properties:@@ -742,7 +785,7 @@ definitions:example: truetype: booleanrequired:- - is_archived+ - is_archivedtype: objectrequests.PhoneAPIKeyStoreRequest:properties:@@ -750,7 +793,7 @@ definitions:example: My Phone API Keytype: stringrequired:- - name+ - nametype: objectrequests.PhoneFCMToken:properties:@@ -758,18 +801,17 @@ definitions:example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd.....type: stringphone_number:- example: "[+18005550199]"+ example: '[+18005550199]'type: stringsim:- 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 than1 SIM slotexample: SIM1type: stringrequired:- - fcm_token- - phone_number- - sim+ - fcm_token+ - phone_number+ - simtype: objectrequests.PhoneUpsert:properties:@@ -777,14 +819,12 @@ definitions:example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd.....type: stringmax_send_attempts:- description:- MaxSendAttempts is the number of attempts when sending an SMS+ description: MaxSendAttempts is the number of attempts when sending an SMSmessage to handle the case where the phone is offline.example: 2type: integermessage_expiration_seconds:- description:- MessageExpirationSeconds is the duration in seconds after sending+ description: MessageExpirationSeconds is the duration in seconds after sendinga message when it is considered to be expired.example: 12345type: integer@@ -797,20 +837,54 @@ definitions:phone_number:example: "+18005550199"type: string+ schedule_id:+ example: 32343a19-da5e-4b1b-a767-3298a73703cb+ type: stringsim:- 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 than1 SIM slotexample: SIM1type: stringrequired:- - 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_minutetype: objectrequests.UserNotificationUpdate:properties:@@ -827,10 +901,10 @@ definitions:example: truetype: booleanrequired:- - heartbeat_enabled- - message_status_enabled- - newsletter_enabled- - webhook_enabled+ - heartbeat_enabled+ - message_status_enabled+ - newsletter_enabled+ - webhook_enabledtype: objectrequests.UserPaymentInvoice:properties:@@ -856,13 +930,13 @@ definitions:example: "9800"type: stringrequired:- - address- - city- - country- - name- - notes- - state- - zip_code+ - address+ - city+ - country+ - name+ - notes+ - state+ - zip_codetype: objectrequests.UserUpdate:properties:@@ -873,8 +947,8 @@ definitions:example: Europe/Helsinkitype: stringrequired:- - active_phone_id- - timezone+ - active_phone_id+ - timezonetype: objectrequests.WebhookStore:properties:@@ -884,8 +958,8 @@ definitions:type: arrayphone_numbers:example:- - "+18005550100"- - "+18005550100"+ - "+18005550100"+ - "+18005550100"items:type: stringtype: array@@ -894,10 +968,10 @@ definitions:url:type: stringrequired:- - events- - phone_numbers- - signing_key- - url+ - events+ - phone_numbers+ - signing_key+ - urltype: objectrequests.WebhookUpdate:properties:@@ -907,8 +981,8 @@ definitions:type: arrayphone_numbers:example:- - "+18005550100"- - "+18005550100"+ - "+18005550100"+ - "+18005550100"items:type: stringtype: array@@ -917,10 +991,10 @@ definitions:url:type: stringrequired:- - events- - phone_numbers- - signing_key- - url+ - events+ - phone_numbers+ - signing_key+ - urltype: objectresponses.BadRequest:properties:@@ -934,14 +1008,14 @@ definitions:example: errortype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.BillingUsageResponse:properties:data:- $ref: "#/definitions/entities.BillingUsage"+ $ref: '#/definitions/entities.BillingUsage'message:example: Request handled successfullytype: string@@ -949,15 +1023,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.BillingUsagesResponse:properties:data:items:- $ref: "#/definitions/entities.BillingUsage"+ $ref: '#/definitions/entities.BillingUsage'type: arraymessage:example: Request handled successfully@@ -966,14 +1040,14 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.DiscordResponse:properties:data:- $ref: "#/definitions/entities.Discord"+ $ref: '#/definitions/entities.Discord'message:example: Request handled successfullytype: string@@ -981,15 +1055,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.DiscordsResponse:properties:data:items:- $ref: "#/definitions/entities.Discord"+ $ref: '#/definitions/entities.Discord'type: arraymessage:example: Request handled successfully@@ -998,14 +1072,14 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.HeartbeatResponse:properties:data:- $ref: "#/definitions/entities.Heartbeat"+ $ref: '#/definitions/entities.Heartbeat'message:example: Request handled successfullytype: string@@ -1013,15 +1087,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.HeartbeatsResponse:properties:data:items:- $ref: "#/definitions/entities.Heartbeat"+ $ref: '#/definitions/entities.Heartbeat'type: arraymessage:example: Request handled successfully@@ -1030,9 +1104,9 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.InternalServerError:properties:@@ -1043,13 +1117,13 @@ definitions:example: errortype: stringrequired:- - message- - status+ - message+ - statustype: objectresponses.MessageResponse:properties:data:- $ref: "#/definitions/entities.Message"+ $ref: '#/definitions/entities.Message'message:example: Request handled successfullytype: string@@ -1057,15 +1131,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.MessageThreadsResponse:properties:data:items:- $ref: "#/definitions/entities.MessageThread"+ $ref: '#/definitions/entities.MessageThread'type: arraymessage:example: Request handled successfully@@ -1074,15 +1148,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.MessagesResponse:properties:data:items:- $ref: "#/definitions/entities.Message"+ $ref: '#/definitions/entities.Message'type: arraymessage:example: Request handled successfully@@ -1091,9 +1165,9 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.NoContent:properties:@@ -1104,8 +1178,8 @@ definitions:example: successtype: stringrequired:- - message- - status+ - message+ - statustype: objectresponses.NotFound:properties:@@ -1116,8 +1190,8 @@ definitions:example: errortype: stringrequired:- - message- - status+ - message+ - statustype: objectresponses.OkString:properties:@@ -1130,14 +1204,14 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.PhoneAPIKeyResponse:properties:data:- $ref: "#/definitions/entities.PhoneAPIKey"+ $ref: '#/definitions/entities.PhoneAPIKey'message:example: Request handled successfullytype: string@@ -1145,15 +1219,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.PhoneAPIKeysResponse:properties:data:items:- $ref: "#/definitions/entities.PhoneAPIKey"+ $ref: '#/definitions/entities.PhoneAPIKey'type: arraymessage:example: Request handled successfully@@ -1162,14 +1236,14 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.PhoneResponse:properties:data:- $ref: "#/definitions/entities.Phone"+ $ref: '#/definitions/entities.Phone'message:example: Request handled successfullytype: string@@ -1177,15 +1251,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.PhonesResponse:properties:data:items:- $ref: "#/definitions/entities.Phone"+ $ref: '#/definitions/entities.Phone'type: arraymessage:example: Request handled successfully@@ -1194,9 +1268,24 @@ definitions:example: successtype: stringrequired:- - 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+ - statustype: objectresponses.Unauthorized:properties:@@ -1210,9 +1299,9 @@ definitions:example: errortype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.UnprocessableEntity:properties:@@ -1229,14 +1318,14 @@ definitions:example: errortype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.UserResponse:properties:data:- $ref: "#/definitions/entities.User"+ $ref: '#/definitions/entities.User'message:example: Request handled successfullytype: string@@ -1244,9 +1333,9 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.UserSubscriptionPaymentsResponse:properties:@@ -1309,42 +1398,42 @@ definitions:updated_at:type: stringrequired:- - 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_attype: objectid:type: stringtype:type: stringrequired:- - attributes- - id- - type+ - attributes+ - id+ - typetype: objecttype: arraymessage:@@ -1354,14 +1443,14 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.WebhookResponse:properties:data:- $ref: "#/definitions/entities.Webhook"+ $ref: '#/definitions/entities.Webhook'message:example: Request handled successfullytype: string@@ -1369,15 +1458,15 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objectresponses.WebhooksResponse:properties:data:items:- $ref: "#/definitions/entities.Webhook"+ $ref: '#/definitions/entities.Webhook'type: arraymessage:example: Request handled successfully@@ -1386,17 +1475,16 @@ definitions:example: successtype: stringrequired:- - data- - message- - status+ - data+ - message+ - statustype: objecthost: api.httpsms.cominfo:contact:email: [email protected]name: [email protected]- 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 simpleprogrammable 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 thecurrent monthproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.BillingUsageResponse"+ $ref: '#/definitions/responses.BillingUsageResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $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 userin 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.BillingUsagesResponse"+ $ref: '#/definitions/responses.BillingUsagesResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $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: fileproduces:- - application/json+ - application/jsonresponses:"202":description: Acceptedschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Store bulk SMS filetags:- - BulkSMS+ - BulkSMS/discord-integrations:get:consumes:- - application/json+ - application/jsondescription: Get the discord integrations of a userparameters:- - 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.DiscordsResponse"+ $ref: '#/definitions/responses.DiscordsResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get discord integrations of a usertags:- - DiscordIntegration+ - DiscordIntegrationpost:consumes:- - application/json+ - application/jsondescription: Store a discord integration for the authenticated userparameters:- - 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/jsonresponses:"201":description: Createdschema:- $ref: "#/definitions/responses.DiscordResponse"+ $ref: '#/definitions/responses.DiscordResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Store discord integrationtags:- - DiscordIntegration+ - DiscordIntegration/discord-integrations/{discordID}:delete:consumes:- - application/json+ - application/jsondescription: Delete a discord integration for a userparameters:- - 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Delete discord integrationtags:- - Webhooks+ - Webhooksput:consumes:- - application/json+ - application/jsondescription: Update a discord integration for the currently authenticated userparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.DiscordResponse"+ $ref: '#/definitions/responses.DiscordResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Update a discord integrationtags:- - DiscordIntegration+ - DiscordIntegration/discord/event:post:consumes:- - application/json+ - application/jsondescription: Publish a discord event to the registered listenersproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'summary: Consume a discord eventtags:- - 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.HeartbeatsResponse"+ $ref: '#/definitions/responses.HeartbeatsResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get heartbeats of an owner phone numbertags:- - Heartbeats+ - Heartbeatspost: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 stillactiveparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.HeartbeatResponse"+ $ref: '#/definitions/responses.HeartbeatResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Register heartbeat of an owner phone numbertags:- - Heartbeats+ - Heartbeats/integration/3cx/messages:post:consumes:- - application/json+ - application/jsondescription: Sends an SMS message from the 3CX platformproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'summary: Sends a 3CX SMS messagetags:- - 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessageThreadsResponse"+ $ref: '#/definitions/responses.MessageThreadsResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get message threads for a phone numbertags:- - 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 allthe 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Delete a message thread from the database.tags:- - MessageThreads+ - MessageThreadsput:consumes:- - application/json+ - application/jsondescription: Updates the details of a message threadparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.PhoneResponse"+ $ref: '#/definitions/responses.PhoneResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Update a message threadtags:- - 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. Itwill 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessagesResponse"+ $ref: '#/definitions/responses.MessagesResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get messages which are sent between 2 phone numberstags:- - 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 contentfrom 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Delete a message from the database.tags:- - Messages+ - Messagesget:consumes:- - application/json+ - application/jsondescription: 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.MessageResponse"+ $ref: '#/definitions/responses.MessageResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessageResponse"+ $ref: '#/definitions/responses.MessageResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Upsert an event for a message on the mobile phonetags:- - Messages+ - Messages/messages/bulk-send:post:consumes:- - application/json+ - application/jsondescription: Add bulk SMS messages to be sent by the android phoneparameters:- - 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/jsonresponses:"200":description: OKschema:items:- $ref: "#/definitions/responses.MessagesResponse"+ $ref: '#/definitions/responses.MessagesResponse'type: array"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Send bulk SMS messagestags:- - 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 registera 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessageResponse"+ $ref: '#/definitions/responses.MessageResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Register a missed call event on the mobile phonetags:- - Messages+ - Messages/messages/outstanding:get:consumes:- - application/json+ - application/jsondescription: Get an outstanding message to be sent by an android phoneparameters:- - 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: stringproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessageResponse"+ $ref: '#/definitions/responses.MessageResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get an outstanding messagetags:- - Messages+ - Messages/messages/receive:post:consumes:- - application/json+ - application/jsondescription: Add a new message received from a mobile phoneparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessageResponse"+ $ref: '#/definitions/responses.MessageResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Receive a new SMS message from a mobile phonetags:- - 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 criteriaincluding missed callsparameters:- - 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessagesResponse"+ $ref: '#/definitions/responses.MessagesResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Search all messages of a usertags:- - Messages+ - Messages/messages/send:post:consumes:- - application/json+ - application/jsondescription: Add a new SMS message to be sent by your Android phoneparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.MessageResponse"+ $ref: '#/definitions/responses.MessageResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Send an SMS messagetags:- - 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 httpSMSapplicationparameters:- - 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.PhoneAPIKeysResponse"+ $ref: '#/definitions/responses.PhoneAPIKeysResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get the phone API keys of a usertags:- - PhoneAPIKeys+ - PhoneAPIKeyspost: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 thehttpSMS app on your Android phoneparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.PhoneAPIKeyResponse"+ $ref: '#/definitions/responses.PhoneAPIKeyResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Store phone API keytags:- - 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 forauthentication 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $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 Androidphone 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $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 smsapplicationparameters:- - 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.PhonesResponse"+ $ref: '#/definitions/responses.PhonesResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get phones of a usertags:- - Phones+ - Phonesput: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 numberdoes 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.PhoneResponse"+ $ref: '#/definitions/responses.PhoneResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Upsert Phonetags:- - Phones+ - Phones/phones/{phoneID}:delete:consumes:- - application/json+ - application/jsondescription: Delete a phone that has been sored in the databaseparameters:- - 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Delete Phonetags:- - 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 numberdoes 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.PhoneResponse"+ $ref: '#/definitions/responses.PhoneResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Upserts the FCM token of a phonetags:- - 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/jsondescription: Rotate the user's API key in case the current API Key is compromisedparameters:- - 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: stringproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.UserResponse"+ $ref: '#/definitions/responses.UserResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Rotate the user's API Keytags:- - Users+ - Users/users/{userID}/notifications:put:consumes:- - application/json+ - application/jsondescription: Update the email notification settings for a userparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.UserResponse"+ $ref: '#/definitions/responses.UserResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Update notification settingstags:- - 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 theirdata.produces:- - application/json+ - application/jsonresponses:"201":description: Createdschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Delete a usertags:- - Users+ - Usersget:consumes:- - application/json+ - application/jsondescription: Get details of the currently authenticated userproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.UserResponse"+ $ref: '#/definitions/responses.UserResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get current usertags:- - Users+ - Usersput:consumes:- - application/json+ - application/jsondescription: Updates the details of the currently authenticated userparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.PhoneResponse"+ $ref: '#/definitions/responses.PhoneResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Update a usertags:- - Users+ - Users/users/subscription:delete:description: Cancel the subscription of the authenticated user.produces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Cancel the user's subscriptiontags:- - Users+ - Users/users/subscription-update-url:get:description: Fetches the subscription URL of the authenticated user.produces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.OkString"+ $ref: '#/definitions/responses.OkString'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Currently authenticated user subscription update URLtags:- - 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 paymentwith 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: stringproduces:- - application/pdf+ - application/pdfresponses:"200":description: OK@@ -3117,86 +3331,85 @@ paths:"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Generate a subscription payment invoicetags:- - 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 ofa subscription, typically there is one at the time of purchase and then onefor each renewal.produces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.UserSubscriptionPaymentsResponse"+ $ref: '#/definitions/responses.UserSubscriptionPaymentsResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $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 componentsparameters:- - 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: stringproduces:- - application/octet-stream+ - application/octet-streamresponses:"200":description: OK@@ -3205,189 +3418,189 @@ paths:"404":description: Not Foundschema:- $ref: "#/definitions/responses.NotFound"+ $ref: '#/definitions/responses.NotFound'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'summary: Download a message attachmenttags:- - Attachments+ - Attachments/webhooks:get:consumes:- - application/json+ - application/jsondescription: Get the webhooks of a userparameters:- - 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: integerproduces:- - application/json+ - application/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.WebhooksResponse"+ $ref: '#/definitions/responses.WebhooksResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Get webhooks of a usertags:- - Webhooks+ - Webhookspost:consumes:- - application/json+ - application/jsondescription: Store a webhook for the authenticated userparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.WebhookResponse"+ $ref: '#/definitions/responses.WebhookResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Store a webhooktags:- - Webhooks+ - Webhooks/webhooks/{webhookID}:delete:consumes:- - application/json+ - application/jsondescription: Delete a webhook for a userparameters:- - 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: stringproduces:- - application/json+ - application/jsonresponses:"204":description: No Contentschema:- $ref: "#/definitions/responses.NoContent"+ $ref: '#/definitions/responses.NoContent'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Delete webhooktags:- - Webhooks+ - Webhooksput:consumes:- - application/json+ - application/jsondescription: Update a webhook for the currently authenticated userparameters:- - 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/jsonresponses:"200":description: OKschema:- $ref: "#/definitions/responses.WebhookResponse"+ $ref: '#/definitions/responses.WebhookResponse'"400":description: Bad Requestschema:- $ref: "#/definitions/responses.BadRequest"+ $ref: '#/definitions/responses.BadRequest'"401":description: Unauthorizedschema:- $ref: "#/definitions/responses.Unauthorized"+ $ref: '#/definitions/responses.Unauthorized'"422":description: Unprocessable Entityschema:- $ref: "#/definitions/responses.UnprocessableEntity"+ $ref: '#/definitions/responses.UnprocessableEntity'"500":description: Internal Server Errorschema:- $ref: "#/definitions/responses.InternalServerError"+ $ref: '#/definitions/responses.InternalServerError'security:- - ApiKeyAuth: []+ - ApiKeyAuth: []summary: Update a webhooktags:- - Webhooks+ - Webhooksschemes:- - https+- httpssecurityDefinitions:ApiKeyAuth:in: header