{ "openapi": "3.0.1", "info": { "title": "SMS Marketing Message Checker: STOP & 10DLC", "description": "Check SMS and MMS marketing texts before you send or register a 10DLC campaign: segment count and GSM-7 vs Unicode, STOP opt-out wording, opt-in confirmation elements, public URL shorteners, cannabis/CBD, SHAFT, high-risk finance, phishing-like wording, merge-field errors and 8am-9pm quiet hours.", "version": "0.1", "x-build-id": "PcYNyNSgdcbV9nOxy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ultimatemc~sms-marketing-message-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ultimatemc-sms-marketing-message-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/ultimatemc~sms-marketing-message-checker/runs": { "post": { "operationId": "runs-sync-ultimatemc-sms-marketing-message-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/ultimatemc~sms-marketing-message-checker/run-sync": { "post": { "operationId": "run-sync-ultimatemc-sms-marketing-message-checker", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "messages": { "title": "Messages", "type": "array", "description": "Array of message texts, or objects with \"text\" and optional \"id\", \"messageType\" (marketing, optInConfirmation, transactional), \"brand\", \"sendTime\" (ISO time in the recipient's time zone) or \"sendHourLocal\". The prefilled example shows common rejections next to a clean message." }, "messageType": { "title": "Default message type", "enum": [ "marketing", "optInConfirmation", "transactional" ], "type": "string", "description": "Used for messages without their own messageType. Opt-in confirmations are also checked for HELP, frequency and rates wording; transactional messages skip the opt-out and quiet-hours checks.", "default": "marketing" }, "brand": { "title": "Brand name (optional)", "type": "string", "description": "If set, each message is checked for this sender name." }, "sendHourLocal": { "title": "Planned send hour, recipient's local time (optional)", "minimum": 0, "maximum": 23, "type": "integer", "description": "0-23. Marketing messages planned before 8 or from 21 (9 p.m.) are flagged under the federal TCPA time window." }, "isFirstMessage": { "title": "These are first messages to new subscribers", "type": "boolean", "description": "Raises a missing opt-out instruction to high severity.", "default": false }, "datasetId": { "title": "Dataset ID (optional)", "type": "string", "description": "Apify dataset with messages, for example exported campaign texts. Fields text, message, body or content are detected automatically; override them with Field map." }, "fieldMap": { "title": "Field map (optional)", "type": "object", "description": "Override field names; dotted paths work for nested fields. Example: {\"text\": \"body\", \"id\": \"campaignId\"}." }, "onlyFlagged": { "title": "Only save rows with findings", "type": "boolean", "description": "Skip messages with no findings (you are only charged for saved rows).", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Maximum number of messages to check in this run.", "default": 5000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }