Back to API

SMS API โ€” SDK & Exports

v1.0 ยท 2 endpoints

OpenAPI 3.0 Specification
Download JSON
{
    "openapi": "3.0.3",
    "info": {
        "title": "SMS API",
        "description": "Send SMS messages worldwide with delivery tracking and smart routing.",
        "version": "1.0"
    },
    "servers": [
        {
            "url": "https://api.aikdata.com/v1/sms"
        }
    ],
    "paths": {
        "/send": {
            "post": {
                "operationId": "postSendSms",
                "summary": "Send an SMS message",
                "tags": [
                    "Messages"
                ],
                "requestBody": {
                    "required": false,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "to": {
                                        "type": "string",
                                        "example": "+15551234567"
                                    },
                                    "body": {
                                        "type": "string",
                                        "example": "Your verification code is 123456"
                                    },
                                    "from": {
                                        "type": "string",
                                        "example": "AikData"
                                    }
                                }
                            }
                        }
                    }
                },
                "security": [
                    {
                        "bearerAuth": []
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful response",
                        "content": {
                            "application/json": {
                                "example": {
                                    "id": "msg_abc123",
                                    "to": "+15551234567",
                                    "status": "queued"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Unauthorized"
                    }
                }
            }
        },
        "/messages/{id}": {
            "get": {
                "operationId": "getGetMessageStatus",
                "summary": "Get delivery status of a message",
                "tags": [
                    "Messages"
                ],
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Message identifier returned by Send SMS"
                    }
                ],
                "security": [
                    {
                        "bearerAuth": []
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful response",
                        "content": {
                            "application/json": {
                                "example": {
                                    "id": "msg_abc123",
                                    "status": "delivered",
                                    "delivered_at": "2026-03-12T10:00:05Z"
                                }
                            }
                        }
                    },
                    "401": {
                        "description": "Unauthorized"
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "bearerAuth": {
                "type": "http",
                "scheme": "bearer",
                "bearerFormat": "JWT"
            }
        }
    }
}