---
updatedAt: 2026-06-29T11:55:25.000Z
agentTools:
  projectIndex: https://docs.biot-med.com/llms.txt
---

# Send sms

Send sms

When using AWS as the sms provider you are limited to 1 message per second by default. This can be changed

This API requires **NOTIFICATION_SEND_SMS** permission(s).



# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "BioT Notification Service",
    "description": "APIs document (version: 5.7.0)",
    "version": "5.7.0"
  },
  "servers": [
    {
      "url": "/notification"
    }
  ],
  "paths": {
    "/v1/sms/send": {
      "post": {
        "tags": [
          "SMS API"
        ],
        "summary": "Send sms",
        "description": "Send sms\n\nWhen using AWS as the sms provider you are limited to 1 message per second by default. This can be changed\n\nThis API requires **NOTIFICATION_SEND_SMS** permission(s).\n\n",
        "operationId": "sendSms",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SendSmsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SendSmsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "example": "EXAMPLE_CODE_ENTITY_NOT_FOUND"
          },
          "message": {
            "type": "string",
            "example": "Entity with id [00000000-0000-0000-0000-000000000000] not found"
          },
          "serviceName": {
            "type": "string",
            "example": "Device Service"
          },
          "traceId": {
            "type": "string",
            "example": "a07a7e532f3541d8"
          },
          "environment": {
            "type": "string",
            "example": "develop"
          },
          "details": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "SendSmsRequest": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string",
            "maxLength": 15,
            "minLength": 5,
            "pattern": "[+]?[0-9]+"
          }
        },
        "required": [
          "message",
          "phoneNumber"
        ]
      },
      "SendSmsResponse": {
        "type": "object",
        "properties": {
          "messageId": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```