{ "openapi": "3.0.3", "info": { "title": "SMSGic - Public API", "description": "SMSGic public API documentation.\n\nUse **Native messages v2** for new transactional SMS integrations. Requests are persisted as API Messages, recipient-level status is reconciled with EDR, and billing is finalized only after router\/EDR completion.\n\nUse **Vendor bridges** when migrating from Twilio-style or Infobip-style payloads. Bridge endpoints keep vendor-shaped request bodies at the edge and normalize them into the SMSGic API Message flow internally.\n\nThe **Legacy campaign API** remains available for backwards compatibility and campaign-style sends. New one-off API sends should not create campaign records unless a client explicitly needs campaign behavior.\n\nLocal SMSGic status codes complement provider\/SMPP statuses: clients should treat local rejection and validation codes as final platform-side decisions, while provider statuses describe downstream delivery state.", "version": "1.0.0", "x-scalar-links": [ { "name": "Customer portal", "url": "https:\/\/portal.smsgic.com" }, { "name": "Postman collection", "url": "https:\/\/api.smsgic.com\/api\/postman.json" }, { "name": "Migrate from v1", "url": "https:\/\/api.smsgic.com\/api\/guides\/v1-migration" }, { "name": "Migrate from Twilio", "url": "https:\/\/api.smsgic.com\/api\/guides\/twilio-migration" }, { "name": "Migrate from Infobip", "url": "https:\/\/api.smsgic.com\/api\/guides\/infobip-migration" } ] }, "servers": [ { "url": "https:\/\/api.smsgic.com" } ], "tags": [ { "name": "Account", "description": "" }, { "name": "Bridges", "description": "", "x-displayName": "Vendor bridges" }, { "name": "Native messages v2", "description": "", "x-displayName": "Native messages" }, { "name": "SMS sending", "description": "", "x-displayName": "Legacy campaigns" } ], "components": { "securitySchemes": { "default": { "type": "http", "scheme": "bearer", "description": "You can use token, created from https:\/\/portal.smsgic.com\/apis<\/a>" } } }, "security": [ { "default": [] } ], "x-tagGroups": [ { "name": "Native API", "tags": [ "Native messages v2", "Account" ] }, { "name": "Vendor bridges", "tags": [ "Bridges" ] }, { "name": "Legacy campaign API", "tags": [ "SMS sending" ] } ], "paths": { "\/api\/smsgic\/v1\/public\/balance": { "get": { "summary": "Get account balance.", "operationId": "getAccountBalance", "description": "This endpoint allows you to retrieve your account balance.", "parameters": [], "responses": { "200": { "description": "", "content": { "text\/plain": { "schema": { "type": "string", "example": "{\n \"balance\": \"450.00\",\n \"sign\": \"\u00a3\",\n \"code\": \"GBP\",\n}" } } } }, "401": { "description": ".Auth token invalid", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } } } } } }, "tags": [ "Account" ] } }, "\/api\/smsgic\/v1\/public\/senders": { "get": { "summary": "Get account senders.", "operationId": "getAccountSenders", "description": "This endpoint allows you to retrieve your account senders.", "parameters": [], "responses": { "200": { "description": "", "content": { "text\/plain": { "schema": { "type": "string", "example": "{\n \"senders\": [\n {\n \"id\": 45,\n \"sender\": \"MegaShop\",\n },\n {\n \"id\": 46,\n \"sender\": \"DSTLCKDM\",\n },\n {\n \"id\": 136,\n \"sender\": \"MEGA\",\n },\n ]\n}" } } } }, "401": { "description": ".Auth token invalid", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } } } } } }, "tags": [ "Account" ] } }, "\/api\/smsgic\/v1\/public\/rates": { "get": { "summary": "Get account rates with currency.", "operationId": "getAccountRatesWithCurrency", "description": "This endpoint allows you to retrieve your account rates. Rates are filtered if use params.", "parameters": [], "responses": { "200": { "description": "", "content": { "text\/plain": { "schema": { "type": "string", "example": "{\n \"rates\": [\n {\n \"mcc\": \"218\",\n \"mnc\": \"90\",\n \"country\": \"Latvia\",\n \"rate\": 0.4397,\n },\n {\n \"mcc\": \"218\",\n \"mnc\": null,\n \"country\": \"Latvia\",\n \"rate\": 0.4397,\n },\n {\n \"mcc\": \"218\",\n \"mnc\": \"05\",\n \"country\": \"Latvia\",\n \"rate\": 0.4397\n },\n {\n \"mcc\": \"218\",\n \"mnc\": \"03\",\n \"country\": \"Latvia\",\n \"rate\": 0.4397,\n },\n ]\n}" } } } }, "401": { "description": ".Auth token invalid", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } } } } } }, "tags": [ "Account" ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "type": "object", "properties": { "mcc": { "type": "string", "description": "This field is required when mnc<\/code> is present. Must match the regex \/^\\d{3}$\/.", "example": "743" }, "mnc": { "type": "string", "description": "Must match the regex \/^\\d{0,3}|'null'$\/.", "example": "551", "nullable": true }, "country": { "type": "string", "description": "Part of country title for search.", "example": "Latvia" }, "country_id": { "type": "integer", "description": "Valid Id of country in smsgic.com for search.", "example": 1 } } } } } } } }, "\/api\/bridges\/twilio\/v1\/messages": { "post": { "summary": "Create a Twilio-compatible bridge message.", "operationId": "createATwilioCompatibleBridgeMessage", "description": "", "parameters": [], "responses": {}, "tags": [ "Bridges" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "Body": { "type": "string", "description": "SMS body text.", "example": "Hello from bridge" }, "To": { "type": "string", "description": "Recipient phone number.", "example": "+15550010" }, "From": { "type": "string", "description": "Approved sender name.", "example": "INFO" }, "SendAt": { "type": "string", "description": "Optional schedule in `Y-m-d H:i:s`.", "example": "2026-06-23 12:00:00" }, "notify": { "type": "boolean", "description": "Optional email notification flag.", "example": false } }, "required": [ "Body", "To", "From" ] } } } }, "x-scalar-stability": "stable", "x-badges": [ { "name": "Bridge", "position": "before", "color": "#2563eb" } ] } }, "\/api\/bridges\/infobip\/v1\/sms\/messages": { "post": { "summary": "Create an Infobip-compatible bridge message batch.", "operationId": "createAnInfobipCompatibleBridgeMessageBatch", "description": "", "parameters": [], "responses": {}, "tags": [ "Bridges" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "description": "Batch of messages in Infobip-compatible shape.", "example": "eaque", "items": { "type": "string" } } }, "required": [ "messages" ] } } } }, "x-scalar-stability": "stable", "x-badges": [ { "name": "Bridge", "position": "before", "color": "#2563eb" } ] } }, "\/api\/smsgic\/v2\/messages": { "post": { "summary": "Create a native transactional SMS request.", "operationId": "createANativeTransactionalSMSRequest", "description": "This endpoint creates a dispatch record without creating legacy SMS campaign entities.\nRepeat the same request with the same `Idempotency-Key` header to safely replay it.", "parameters": [ { "in": "header", "name": "Idempotency-Key", "description": "", "example": "string Optional idempotency key for safe retries. Example: msg-20260622-001", "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "example": { "request_id": "49e60cdb-68d7-4fdb-920c-c7d06f6dd8d8", "message_id": 1, "service_type": "default", "idempotency_key": "msg-20260622-001", "acceptance_state": "accepted", "billing_state": "awaiting_edr", "charge_source": "edr", "billing_transaction_id": null, "text": "Hello from SMSgic", "scheduled_at": null, "accepted_at": "2026-06-22T10:20:30.000000Z", "completed_at": null, "billed_at": null, "created_at": "2026-06-22T10:20:30.000000Z", "estimated_cost": { "amount": "1.0000", "currency": { "code": "EUR", "sign": "\u20ac" } }, "final_cost": null, "recipients": [ { "recipient_id": 1, "to": "15550001", "status": "edr_pending", "acceptance_state": "accepted", "billing_state": "awaiting_edr", "local_status_code": 1204, "status_reason": null, "sms_count": 1, "billable": null, "edr_status": null, "provider_message_ids": [ "sms-1" ], "estimated_cost": { "amount": "1.0000", "currency": { "code": "EUR", "sign": "\u20ac" } }, "final_cost": null, "created_at": "2026-06-22T10:20:30.000000Z", "message_created_at": "2026-06-22T10:20:30.000000Z", "finalized_at": null } ] }, "properties": { "request_id": { "type": "string", "example": "49e60cdb-68d7-4fdb-920c-c7d06f6dd8d8" }, "message_id": { "type": "integer", "example": 1 }, "service_type": { "type": "string", "example": "default" }, "idempotency_key": { "type": "string", "example": "msg-20260622-001" }, "acceptance_state": { "type": "string", "example": "accepted" }, "billing_state": { "type": "string", "example": "awaiting_edr" }, "charge_source": { "type": "string", "example": "edr" }, "billing_transaction_id": { "type": "string", "example": null, "nullable": true }, "text": { "type": "string", "example": "Hello from SMSgic" }, "scheduled_at": { "type": "string", "example": null, "nullable": true }, "accepted_at": { "type": "string", "example": "2026-06-22T10:20:30.000000Z" }, "completed_at": { "type": "string", "example": null, "nullable": true }, "billed_at": { "type": "string", "example": null, "nullable": true }, "created_at": { "type": "string", "example": "2026-06-22T10:20:30.000000Z" }, "estimated_cost": { "type": "object", "properties": { "amount": { "type": "string", "example": "1.0000" }, "currency": { "type": "object", "properties": { "code": { "type": "string", "example": "EUR" }, "sign": { "type": "string", "example": "\u20ac" } } } } }, "final_cost": { "type": "string", "example": null, "nullable": true }, "recipients": { "type": "array", "example": [ { "recipient_id": 1, "to": "15550001", "status": "edr_pending", "acceptance_state": "accepted", "billing_state": "awaiting_edr", "local_status_code": 1204, "status_reason": null, "sms_count": 1, "billable": null, "edr_status": null, "provider_message_ids": [ "sms-1" ], "estimated_cost": { "amount": "1.0000", "currency": { "code": "EUR", "sign": "\u20ac" } }, "final_cost": null, "created_at": "2026-06-22T10:20:30.000000Z", "message_created_at": "2026-06-22T10:20:30.000000Z", "finalized_at": null } ], "items": { "type": "object", "properties": { "recipient_id": { "type": "integer", "example": 1 }, "to": { "type": "string", "example": "15550001" }, "status": { "type": "string", "example": "edr_pending" }, "acceptance_state": { "type": "string", "example": "accepted" }, "billing_state": { "type": "string", "example": "awaiting_edr" }, "local_status_code": { "type": "integer", "example": 1204 }, "status_reason": { "type": "string", "example": null, "nullable": true }, "sms_count": { "type": "integer", "example": 1 }, "billable": { "type": "string", "example": null, "nullable": true }, "edr_status": { "type": "string", "example": null, "nullable": true }, "provider_message_ids": { "type": "array", "example": [ "sms-1" ], "items": { "type": "string" } }, "estimated_cost": { "type": "object", "properties": { "amount": { "type": "string", "example": "1.0000" }, "currency": { "type": "object", "properties": { "code": { "type": "string", "example": "EUR" }, "sign": { "type": "string", "example": "\u20ac" } } } } }, "final_cost": { "type": "string", "example": null, "nullable": true }, "created_at": { "type": "string", "example": "2026-06-22T10:20:30.000000Z" }, "message_created_at": { "type": "string", "example": "2026-06-22T10:20:30.000000Z" }, "finalized_at": { "type": "string", "example": null, "nullable": true } } } } } } } } } }, "tags": [ "Native messages v2" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "SMS text.", "example": "Hello from SMSgic" }, "recipients": { "type": "array", "description": "Recipient phone numbers.", "example": [ "+15550001", "+15550002" ], "items": { "type": "string" } }, "sender": { "type": "string", "description": "Approved sender name.", "example": "INFO" }, "scheduled_at": { "type": "string", "description": "Optional schedule in `Y-m-d H:i:s`.", "example": "2026-06-22 12:00:00" }, "notify": { "type": "boolean", "description": "Optional email notification flag.", "example": false } }, "required": [ "message", "recipients", "sender" ] } } } }, "x-scalar-stability": "stable", "x-badges": [ { "name": "Recommended", "position": "before", "color": "#16a34a" } ] } }, "\/api\/smsgic\/v2\/messages\/{id}": { "get": { "summary": "Read the current state of a native transactional SMS request.", "operationId": "readTheCurrentStateOfANativeTransactionalSMSRequest", "description": "", "parameters": [], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "example": { "request_id": "49e60cdb-68d7-4fdb-920c-c7d06f6dd8d8", "message_id": 1, "service_type": "default", "idempotency_key": "msg-20260622-001", "acceptance_state": "accepted", "billing_state": "awaiting_edr", "charge_source": "edr", "billing_transaction_id": null, "text": "Hello from SMSgic", "scheduled_at": null, "accepted_at": "2026-06-22T10:20:30.000000Z", "completed_at": null, "created_at": "2026-06-22T10:20:30.000000Z", "recipients": [] }, "properties": { "request_id": { "type": "string", "example": "49e60cdb-68d7-4fdb-920c-c7d06f6dd8d8" }, "message_id": { "type": "integer", "example": 1 }, "service_type": { "type": "string", "example": "default" }, "idempotency_key": { "type": "string", "example": "msg-20260622-001" }, "acceptance_state": { "type": "string", "example": "accepted" }, "billing_state": { "type": "string", "example": "awaiting_edr" }, "charge_source": { "type": "string", "example": "edr" }, "billing_transaction_id": { "type": "string", "example": null, "nullable": true }, "text": { "type": "string", "example": "Hello from SMSgic" }, "scheduled_at": { "type": "string", "example": null, "nullable": true }, "accepted_at": { "type": "string", "example": "2026-06-22T10:20:30.000000Z" }, "completed_at": { "type": "string", "example": null, "nullable": true }, "created_at": { "type": "string", "example": "2026-06-22T10:20:30.000000Z" }, "recipients": { "type": "array", "example": [] } } } } } } }, "tags": [ "Native messages v2" ], "x-scalar-stability": "stable", "x-badges": [ { "name": "Recommended", "position": "before", "color": "#16a34a" } ] }, "parameters": [ { "in": "path", "name": "id", "description": "The ID of the message.", "example": "voluptatem", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "message", "description": "Dispatch identifier.", "example": 1, "required": true, "schema": { "type": "integer" } } ] }, "\/api\/smsgic\/v1\/public\/status": { "get": { "summary": "Get SMS API status", "operationId": "getSMSAPIStatus", "description": "API exposes an endpoint for checking the service status.", "parameters": [], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "string" }, "example": [ "OK" ] } } } } }, "tags": [ "SMS sending" ], "security": [] } }, "\/api\/smsgic\/v1\/public\/sendings\/calculate": { "post": { "summary": "Calculate SMS messaging.", "operationId": "calculateSMSMessaging", "description": "This endpoint allows you to receive the calculate of SMS messaging.\nThe method supports 3000 requests per minute.\nThere are no software restrictions on the quantity of phone numbers", "parameters": [], "responses": { "200": { "description": "default", "content": { "text\/plain": { "schema": { "type": "string", "example": "{\n \"calculate\": {\n \"info\": {\n \"sms_count\": 3,\n \"total\": 1.35,\n \"tax\": 0,\n },\n \"destinations\": [\n {\n \"numbers\": [\n {\n \"phone_number\": 45879921,\n \"destination\": \"Denmark Telenor\",\n \"sms\": 1,\n \"rate\": 0.45,\n \"total\": 0.45,\n },\n ],\n \"destination\": \"Denmark Telenor\",\n \"sms_count\": 1,\n \"price\": 0.45,\n \"total\": 0.45,\n },\n {\n \"numbers\": [\n {\n \"phone_number\": 6523478945,\n \"destination\": \"Singapore \",\n \"sms\": 1,\n \"rate\": 0.45,\n \"total\": 0.45,\n },\n ],\n \"destination\": \"Singapore \",\n \"sms_count\": 1,\n \"price\": 0.45,\n \"total\": 0.45,\n },\n {\n \"numbers\": [\n {\n \"phone_number\": 7554684221,\n \"destination\": \"Russia \",\n \"sms\": 1,\n \"rate\": 0.45,\n \"total\": 0.45,\n },\n ],\n \"destination\": \"Russia \",\n \"sms_count\": 1,\n \"price\": 0.45,\n \"total\": 0.45,\n }\n ]\n }\n}" } } } }, "401": { "description": ".Auth token invalid", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "oneOf": [ { "description": ".message not sent", "type": "object", "example": { "message": "Please send `message` post parameter with text for SMS", "errors": { "message": [ "Please send `message` post parameter with text for SMS" ] } }, "properties": { "message": { "type": "string", "example": "Please send `message` post parameter with text for SMS" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `message` post parameter with text for SMS" ], "items": { "type": "string" } } } } } }, { "description": ".recipients not sent", "type": "object", "example": { "message": "Please send `recipients` post parameter with recipient`s number", "errors": { "recipients": [ "Please send `recipients` post parameter with recipient`s number" ] } }, "properties": { "message": { "type": "string", "example": "Please send `recipients` post parameter with recipient`s number" }, "errors": { "type": "object", "properties": { "recipients": { "type": "array", "example": [ "Please send `recipients` post parameter with recipient`s number" ], "items": { "type": "string" } } } } } }, { "description": ".data not sent", "type": "object", "example": { "message": "The given data was invalid.", "errors": { "message": [ "Please send `message` post parameter with text for SMS" ], "recipients": [ "Please send `recipients` post parameter with recipient`s number" ] } }, "properties": { "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `message` post parameter with text for SMS" ], "items": { "type": "string" } }, "recipients": { "type": "array", "example": [ "Please send `recipients` post parameter with recipient`s number" ], "items": { "type": "string" } } } } } } ] } } } } }, "tags": [ "SMS sending" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Text of sending SMS.", "example": "message" }, "recipients": { "type": "array", "description": "Must match the regex \/^\\d{8,20}$\/.", "example": [ "7526588419032072847" ], "items": { "type": "string" } } }, "required": [ "message", "recipients" ] } } } }, "deprecated": true, "x-scalar-stability": "deprecated", "x-badges": [ { "name": "Legacy", "position": "before", "color": "#f59e0b" } ] } }, "\/api\/smsgic\/v1\/public\/sendings": { "get": { "summary": "Get your account SMS messages.", "operationId": "getYourAccountSMSMessages", "description": "This endpoint allows you to retrieve your account SMS messages.", "parameters": [], "responses": { "200": { "description": "", "content": { "text\/plain": { "schema": { "type": "string", "example": "{\n \"sendings\": [\n {\n \"id\": 301,\n \"text\": \"Test Message\",\n \"created_at\": \"2023-04-11T15:46:26.000000Z\",\n \"scheduled_at\": \"2023-04-11 15:46:26\",\n \"status\": \"Pending\",\n \"total_sms\": 1,\n },\n {\n \"id\": 452,\n \"text\": \"SEND SMS FOR ME\",\n \"created_at\": \"2023-06-06T12:39:35.000000Z\",\n \"scheduled_at\": \"2023-06-06 12:39:35\",\n \"status\": \"Pending\",\n \"total_sms\": 2,\n },\n {\n \"id\": 457,\n \"text\": \"ANOTHER text of SMS\",\n \"created_at\": \"2023-06-06T13:41:57.000000Z\",\n \"scheduled_at\": \"2023-06-06 13:41:57\",\n \"status\": \"Pending\",\n \"total_sms\": 2,\n },\n ]\n}" } } } }, "401": { "description": ".Auth token invalid", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } } } } } }, "tags": [ "SMS sending" ], "deprecated": true, "x-scalar-stability": "deprecated", "x-badges": [ { "name": "Legacy", "position": "before", "color": "#f59e0b" } ] }, "post": { "summary": "Start SMS messaging", "operationId": "startSMSMessaging", "description": "This endpoint allows you create SMS messaging. Your account must have balance enough.", "parameters": [], "responses": { "200": { "description": "", "content": { "text\/plain": { "schema": { "oneOf": [ { "description": "default", "type": "string", "example": "{\n \"message\": \"SMS campaign created\",\n \"sending_id\": 458,\n}" }, { "description": "infobip", "type": "string", "example": "{\n \"messages\": [\n {\n \"messageId\": \"1\",\n \"status\": \"Pending\",\n \"to\": \"41793026727\",\n }\n ]\n}" }, { "description": "twilio", "type": "string", "example": "{\n \"body\": \"Hi there\",\n \"date_created\": \"2023-08-18 14:09:27\",\n \"date_sent\": \"2023-08-18 14:09:27\",\n \"date_updated\": \"2023-08-18 14:09:27\",\n \"from\": \"INFO\",\n \"price\": \"0.75\",\n \"price_unit\": \"usd\",\n \"status\": \"Pending\",\n \"to\": \"+15558675310\",\n \"sid\": \"1\",\n}" }, { "description": "trumpia", "type": "string", "example": "{\n \"message_id\": \"1\",\n}" } ] } } } }, "401": { "description": "", "content": { "application\/json": { "schema": { "oneOf": [ { "description": "default.Auth token invalid", "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } }, { "description": "infobip.Auth token invalid", "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } }, { "description": "twilio.Auth token invalid", "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } }, { "description": "messente.Auth token invalid", "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } }, { "description": "trumpia.Auth token invalid", "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } } ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "oneOf": [ { "description": "default.Message not sent", "type": "object", "example": { "message": "Please send `message` post parameter with text for SMS", "errors": { "message": [ "Please send `message` post parameter with text for SMS" ] } }, "properties": { "message": { "type": "string", "example": "Please send `message` post parameter with text for SMS" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `message` post parameter with text for SMS" ], "items": { "type": "string" } } } } } }, { "description": "default.Recipients not sent", "type": "object", "example": { "message": "Please send `recipients` post parameter with recipient`s number", "errors": { "message": [ "Please send `recipients` post parameter with recipient`s number" ] } }, "properties": { "message": { "type": "string", "example": "Please send `recipients` post parameter with recipient`s number" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `recipients` post parameter with recipient`s number" ], "items": { "type": "string" } } } } } }, { "description": "default.Sender not sent", "type": "object", "example": { "message": "Please send `sender` post parameter with name of SMS sender", "errors": { "message": [ "Please send `sender` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `sender` post parameter with name of SMS sender" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `sender` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } }, { "description": "infobip.Type not sent", "type": "object", "example": { "message": "Please send `message` post parameter with text for SMS (and 2 more errors)", "errors": { "message": [ "Please send `message` post parameter with text for SMS" ], "recipients": [ "Please send `recipients` post parameter with recipient`s number" ], "sender": [ "Please send `sender` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `message` post parameter with text for SMS (and 2 more errors)" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `message` post parameter with text for SMS" ], "items": { "type": "string" } }, "recipients": { "type": "array", "example": [ "Please send `recipients` post parameter with recipient`s number" ], "items": { "type": "string" } }, "sender": { "type": "array", "example": [ "Please send `sender` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } }, { "description": "infobip.Destination not sent", "type": "object", "example": { "message": "Please send `destinations` post parameter with recipient`s number", "errors": { "messages.0.destinations": [ "Please send `destinations` post parameter with recipient`s number" ] } }, "properties": { "message": { "type": "string", "example": "Please send `destinations` post parameter with recipient`s number" }, "errors": { "type": "object", "properties": { "messages.0.destinations": { "type": "array", "example": [ "Please send `destinations` post parameter with recipient`s number" ], "items": { "type": "string" } } } } } }, { "description": "infobip.From not sent", "type": "object", "example": { "message": "Please send `from` post parameter with name of SMS sender", "errors": { "messages.0.from": [ "Please send `from` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `from` post parameter with name of SMS sender" }, "errors": { "type": "object", "properties": { "messages.0.from": { "type": "array", "example": [ "Please send `from` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } }, { "description": "infobip.Text not sent", "type": "object", "example": { "message": "Please send `text` post parameter with text for SMS", "errors": { "messages.0.text": [ "Please send `text` post parameter with text for SMS" ] } }, "properties": { "message": { "type": "string", "example": "Please send `text` post parameter with text for SMS" }, "errors": { "type": "object", "properties": { "messages.0.text": { "type": "array", "example": [ "Please send `text` post parameter with text for SMS" ], "items": { "type": "string" } } } } } }, { "description": "twilio.Type not sent", "type": "object", "example": { "message": "Please send `message` post parameter with text for SMS (and 2 more errors)", "errors": { "message": [ "Please send `message` post parameter with text for SMS" ], "recipients": [ "Please send `recipients` post parameter with recipient`s number" ], "sender": [ "Please send `sender` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `message` post parameter with text for SMS (and 2 more errors)" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `message` post parameter with text for SMS" ], "items": { "type": "string" } }, "recipients": { "type": "array", "example": [ "Please send `recipients` post parameter with recipient`s number" ], "items": { "type": "string" } }, "sender": { "type": "array", "example": [ "Please send `sender` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } }, { "description": "twilio.Body not sent", "type": "object", "example": { "message": "Please send `Body` post parameter with text for SMS", "errors": { "Body": [ "Please send `Body` post parameter with text for SMS" ] } }, "properties": { "message": { "type": "string", "example": "Please send `Body` post parameter with text for SMS" }, "errors": { "type": "object", "properties": { "Body": { "type": "array", "example": [ "Please send `Body` post parameter with text for SMS" ], "items": { "type": "string" } } } } } }, { "description": "twilio.To not sent", "type": "object", "example": { "message": "The to field is required.", "errors": { "To": [ "The to field is required." ] } }, "properties": { "message": { "type": "string", "example": "The to field is required." }, "errors": { "type": "object", "properties": { "To": { "type": "array", "example": [ "The to field is required." ], "items": { "type": "string" } } } } } }, { "description": "twilio.From not sent", "type": "object", "example": { "message": "Please send `From` post parameter with name of SMS sender", "errors": { "From": [ "Please send `From` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `From` post parameter with name of SMS sender" }, "errors": { "type": "object", "properties": { "From": { "type": "array", "example": [ "Please send `From` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } }, { "description": "messente.Type not sent", "type": "object", "example": { "message": "Please send `message` post parameter with text for SMS (and 2 more errors)", "errors": { "message": [ "Please send `message` post parameter with text for SMS" ], "recipients": [ "Please send `recipients` post parameter with recipient`s number" ], "sender": [ "Please send `sender` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `message` post parameter with text for SMS (and 2 more errors)" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `message` post parameter with text for SMS" ], "items": { "type": "string" } }, "recipients": { "type": "array", "example": [ "Please send `recipients` post parameter with recipient`s number" ], "items": { "type": "string" } }, "sender": { "type": "array", "example": [ "Please send `sender` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } }, { "description": "messente.Text not sent", "type": "object", "example": { "message": "Please send `text` post parameter with text for SMS", "errors": { "text": [ "Please send `text` post parameter with text for SMS" ] } }, "properties": { "message": { "type": "string", "example": "Please send `text` post parameter with text for SMS" }, "errors": { "type": "object", "properties": { "text": { "type": "array", "example": [ "Please send `text` post parameter with text for SMS" ], "items": { "type": "string" } } } } } }, { "description": "messente.To not sent", "type": "object", "example": { "message": "The to field is required.", "errors": { "to": [ "The to field is required." ] } }, "properties": { "message": { "type": "string", "example": "The to field is required." }, "errors": { "type": "object", "properties": { "to": { "type": "array", "example": [ "The to field is required." ], "items": { "type": "string" } } } } } }, { "description": "messente.From not sent", "type": "object", "example": { "message": "Please send `from` post parameter with name of SMS sender", "errors": { "from": [ "Please send `from` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `from` post parameter with name of SMS sender" }, "errors": { "type": "object", "properties": { "from": { "type": "array", "example": [ "Please send `from` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } }, { "description": "trumpia.Type not sent", "type": "object", "example": { "message": "Please send `message` post parameter with text for SMS", "errors": { "message": [ "Please send `message` post parameter with text for SMS" ] } }, "properties": { "message": { "type": "string", "example": "Please send `message` post parameter with text for SMS" }, "errors": { "type": "object", "properties": { "message": { "type": "array", "example": [ "Please send `message` post parameter with text for SMS" ], "items": { "type": "string" } } } } } }, { "description": "trumpia.Sms message not sent", "type": "object", "example": { "message": "Please send `sms.message` post parameter with text for SMS", "errors": { "sms.message": [ "Please send `sms.message` post parameter with text for SMS" ] } }, "properties": { "message": { "type": "string", "example": "Please send `sms.message` post parameter with text for SMS" }, "errors": { "type": "object", "properties": { "sms.message": { "type": "array", "example": [ "Please send `sms.message` post parameter with text for SMS" ], "items": { "type": "string" } } } } } }, { "description": "trumpia.Recipients value not sent", "type": "object", "example": { "message": "The recipients.value field is required.", "recipients.value": { "sms.message": [ "The recipients.value field is required." ] } }, "properties": { "message": { "type": "string", "example": "The recipients.value field is required." }, "recipients.value": { "type": "object", "properties": { "sms.message": { "type": "array", "example": [ "The recipients.value field is required." ], "items": { "type": "string" } } } } } }, { "description": "trumpia.Sender not sent", "type": "object", "example": { "message": "Please send `sender` post parameter with name of SMS sender", "recipients.value": { "sender": [ "Please send `sender` post parameter with name of SMS sender" ] } }, "properties": { "message": { "type": "string", "example": "Please send `sender` post parameter with name of SMS sender" }, "recipients.value": { "type": "object", "properties": { "sender": { "type": "array", "example": [ "Please send `sender` post parameter with name of SMS sender" ], "items": { "type": "string" } } } } } } ] } } } } }, "tags": [ "SMS sending" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Possible options: default, infobip, twilio, messente, trumpia.", "example": "default", "nullable": true }, "message": { "type": "string|default", "description": "Text of sending SMS.", "example": "message" }, "recipients|default": { "type": "string[]|default", "description": "Array of phone numbers for send SMS. Must match the regex\n\/^\\d{8,20}$\/.", "example": [ "951490713339111991" ] }, "sender|default": { "type": "string|default", "description": "Title of default or your account sender approved.", "example": "INFO" }, "scheduled_at": { "type": "date|default", "description": "Schedule SMS sending at time. Must be a valid date in the format Y-m-d H:i:s.", "example": "2023-08-22 09:03:42" }, "notify|default": { "type": "boolean|default", "description": "Should send SMS Campaign confirmation via email. Defaults false.", "example": true }, "messages": { "type": "object[]|infobip", "description": "An array of message objects.", "example": [ { "destinations": [ { "to": "951490713339111991" } ], "from": "INFO", "text": "message", "notify": true } ] }, "Body": { "type": "string|twilio", "description": "Text of sending SMS.", "example": "message" }, "To": { "type": "string|twilio", "description": "Phone number for send SMS. Must match the regex \/^\\d{8,20}$\/.", "example": "951490713339111991" }, "From": { "type": "string|twilio", "description": "Title of default or your account sender approved.", "example": "INFO" }, "SendAt": { "type": "date|twilio", "description": "Schedule SMS sending at time. Must be a valid date in the format Y-m-d H:i:s.", "example": "2023-08-22 09:03:42" }, "notify|twilio": { "type": "boolean|twilio", "description": "Should send SMS Campaign confirmation via email. Defaults false.", "example": true }, "text": { "type": "string|messente", "description": "Text of sending SMS.", "example": "message" }, "to": { "type": "string|messente", "description": "Phone number for send SMS. Must match the regex \/^\\d{8,20}$\/.", "example": "951490713339111991" }, "from": { "type": "string|messente", "description": "Title of default or your account sender approved.", "example": "INFO" }, "time_to_send": { "type": "numeric|messente", "description": "Schedule SMS sending at time. Must be numeric Unix timestamp i.e. 1417190104.", "example": "1417190104" }, "notify|messente": { "type": "boolean|messente", "description": "Should send SMS Campaign confirmation via email. Defaults false.", "example": true }, "sms": { "type": "object|trumpia", "description": "SMS object.", "example": { "message": "message" } }, "recipients": { "type": "object|trumpia", "description": "Recipients object.", "example": { "value": "987987987980, 987987987981" } }, "sender": { "type": "string|trumpia", "description": "Title of default or your account sender approved.", "example": "INFO" }, "send_date": { "type": "date|trumpia", "description": "Schedule SMS sending at time. Must be a valid date in the format Y-m-d H:i:s.", "example": "2023-08-22 09:03:42" }, "notify|trumpia": { "type": "boolean|trumpia", "description": "Should send SMS Campaign confirmation via email. Defaults false.", "example": true } }, "required": [ "message", "recipients|default", "sender|default", "messages", "Body", "To", "From", "text", "from", "sms", "recipients", "sender" ] } } } }, "deprecated": true, "x-scalar-stability": "deprecated", "x-badges": [ { "name": "Legacy", "position": "before", "color": "#f59e0b" } ] } }, "\/api\/smsgic\/v1\/public\/sendings\/{id}": { "get": { "summary": "Get your account SMS messaging status.", "operationId": "getYourAccountSMSMessagingStatus", "description": "This endpoint allows you to retrieve your account SMS messages status.", "parameters": [], "responses": { "200": { "description": "", "content": { "text\/plain": { "schema": { "type": "string", "example": "{\n \"sending\": {\n \"id\": 301,\n \"status\": \"Draft\",\n \"updated_at\": \"2023-04-11T15:46:26.000000Z\",\n \"scheduled_at\": \"2023-04-11 15:46:26\",\n }\n}" } } } }, "401": { "description": ".Auth token invalid", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthenticated." }, "properties": { "message": { "type": "string", "example": "Unauthenticated." } } } } } }, "404": { "description": ".SMS Sending not found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "No query results for model 301" }, "properties": { "message": { "type": "string", "example": "No query results for model 301" } } } } } } }, "tags": [ "SMS sending" ], "deprecated": true, "x-scalar-stability": "deprecated", "x-badges": [ { "name": "Legacy", "position": "before", "color": "#f59e0b" } ] }, "parameters": [ { "in": "path", "name": "id", "description": "The ID of the sending.", "example": 301, "required": true, "schema": { "type": "integer" } } ] } } }