> ## Documentation Index > Fetch the complete documentation index at: https://docsv4.mile.app/llms.txt > Use this file to discover all available pages before exploring further. # Test SMS gateway > Checks gateway settings without saving them: validates them, then sends a test SMS to `testRecipient`. Settings you leave out fall back to the stored gateway. No SMS credit is used. The call always answers 200; read `data.status` (`connected` or `invalid`) and `data.lastValidationError`. Rules for the gateway settings: - `endpoint` must be a public `http`/`https` URL (no localhost or private addresses). - `{recipient}` and `{message}` must both appear in the endpoint or in a body parameter value. No other `{placeholder}` is allowed. - Header names and body keys must be unique. - Values marked `secret` are stored encrypted and shown as `••••`. Send `••••` or an empty value to keep the stored secret. - `successMatch` (optional) is `{jsonPath, equals}`: the send counts as accepted only when the provider response has that value. > [!warning] > This call sends a **real SMS** to `testRecipient` through your gateway to verify it. Nothing is saved if the provider rejects it. Limited to 6 requests per minute per user. Requires permission `edit/appIntegration`. ## OpenAPI ````yaml /openapi/public/openapi-setting.json post /sms-gateway/test openapi: 3.0.0 info: title: API - Setting version: 3.0.0 description: API Documentation - RESTful API for field operations management. servers: - url: https://apiweb.mile.app/api/v3 security: - bearerAuth: [] tags: - name: User description: >- User data includes information contained within a user account, such as details that define a user's hub access and role within the system. Hub access determines the locations or areas of the application a user can access or the specific actions they can perform. User attributes consist of the user ID, name, email, and status. The app provides five predefined user roles, and you can create custom roles based on your organization's needs. The predefined roles are **Owner, Admin, Planner, and Field user**. A user can only hold one role at a time but can be granted access to multiple hubs. - name: Team description: >- This API allows you to manage teams. It serves as a tool to effectively manage and restrict user task assignments within your organization. **To see the details of team object, please follow [this link](#tag/team_model)** - name: Role description: >- This API enables you to retrieve a list of predefined roles and any custom roles associated with your account. By making a GET request to this API, you can obtain information about the available roles within the system. The predefined roles refer to a set of role types that are already defined by the system. In this particular case, the predefined roles include Finance, Owner, Planner, Admin, and Field User. Additionally, the API may also return any custom roles that have been created within your account. **To see the details of role object, please follow [this link](#tag/role_model)** - name: Hub description: >- In our system, a Hub is a fundamental entity within an organization, serving as the central point for managing various operational components. It acts as the parent structure for a wide range of resources and functionalities, including tasks, visits, users, vehicles, routing results, routing configurations, and data sources. **To see the details of hub object, please follow [this link](#tag/hub_model)** ## Conceptual Understanding of Hubs - **User Perspective:** For users, a Hub represents their headquarters or primary working area. It is where they carry out their daily activities and manage their tasks effectively. Each user interacts with the Hub to access resources and perform operations specific to their roles. - **Task Perspective:** From the perspective of task management, the Hub signifies the working area for tasks. It is the location where tasks are initiated, monitored, and completed. The Hub facilitates organization and efficiency in task execution. - **Routing Perspective:** In the context of routing and logistics, a Hub serves as a critical location for vehicles. It is where vehicles begin their routes, return after completing their journeys, and may make strategic stops along the way. The routing module relies on the Hub to optimize vehicle assignments and manage routes effectively. - name: App Integration description: >- This API allows you to manage Integration of enterprise app. Currently available for Azure. **To see the details of integration object, please follow [this link](#tag/app_integration_model)** - name: Plugin description: >- The Plugin API allows developers to create and manage custom add-ons within the app. Plugins enable dynamic functionality through JavaScript resources and custom icons, allowing organizations to extend platform capabilities with custom features and integrations. **To see the details of plugin object, please follow [this link](#tag/plugin_model)** - name: Organization description: >- Organization management endpoints for configuring organization-level settings and preferences. - name: Addon description: Addon endpoints - name: Custom Module description: >- A "custom module" is like a personalized menu option in MileApp. It's something you can create and customize to make it easy to access specific features or content. - name: Password Policy description: >- Password Policy endpoints for configuring password requirements and security policies for your organization. - name: Trash description: >- Trash lists items that were deleted from your organization, so you can see what was removed and when. paths: /sms-gateway/test: post: tags: - App Integration summary: Test SMS gateway description: >- Checks gateway settings without saving them: validates them, then sends a test SMS to `testRecipient`. Settings you leave out fall back to the stored gateway. No SMS credit is used. The call always answers 200; read `data.status` (`connected` or `invalid`) and `data.lastValidationError`. Rules for the gateway settings: - `endpoint` must be a public `http`/`https` URL (no localhost or private addresses). - `{recipient}` and `{message}` must both appear in the endpoint or in a body parameter value. No other `{placeholder}` is allowed. - Header names and body keys must be unique. - Values marked `secret` are stored encrypted and shown as `••••`. Send `••••` or an empty value to keep the stored secret. - `successMatch` (optional) is `{jsonPath, equals}`: the send counts as accepted only when the provider response has that value. > [!warning] > This call sends a **real SMS** to `testRecipient` through your gateway to verify it. Nothing is saved if the provider rejects it. Limited to 6 requests per minute per user. Requires permission `edit/appIntegration`. operationId: testSmsGateway requestBody: $ref: '#/components/requestBodies/SmsGatewayUpdateRequest' responses: '200': description: Success content: application/json: schema: type: object properties: status: type: boolean description: Status of response. data: description: Test result. type: object additionalProperties: true example: status: true data: status: invalid lastValidationError: Phone number format is invalid — please correct it. failedCode: smsgw-014 '429': description: Too many requests content: application/json: schema: type: object properties: status: type: boolean description: Shows if the request was successful. message: type: string description: A short message explaining what went wrong. example: status: false message: Bad request - invalid parameters provided. '500': description: Server error content: application/json: schema: type: object properties: status: type: boolean description: Shows if the request was successful. message: type: string description: A short message explaining what went wrong. example: status: false message: Internal server error, please contact support@mile.app. deprecated: false security: - bearerAuth: [] components: requestBodies: SmsGatewayUpdateRequest: content: application/json: schema: $ref: '#/components/schemas/SmsGatewayUpdateRequest' required: true schemas: SmsGatewayUpdateRequest: type: object properties: label: type: string maxLength: 200 description: |- Name for this gateway. **Example:** `Main SMS provider` endpoint: type: string maxLength: 2000 description: |- Provider URL. May contain `{recipient}` and `{message}`. **Example:** `https://sms.example.com/api/send` httpMethod: type: string enum: - POST - GET description: |- HTTP method used to call the provider. **Example:** `POST` headers: type: array items: $ref: '#/components/schemas/SmsGatewayRow' description: Request headers. bodyParams: type: array items: $ref: '#/components/schemas/SmsGatewayRow' description: Body parameters (query parameters for `GET`). successMatch: type: object properties: jsonPath: type: string equals: {} description: |- Optional check on the provider response. **Example:** `{"jsonPath": "status", "equals": "queued"}` isActive: type: boolean description: >- Whether the gateway is used for sending. Defaults to `true` on create. testRecipient: type: string description: >- Phone number that receives the verification SMS, international format with 7-15 digits. **Example:** `+6281234567890` example: label: Main SMS provider endpoint: https://sms.example.com/api/send httpMethod: POST headers: {} bodyParams: - key: to value: '{recipient}' - key: text value: '{message}' successMatch: jsonPath: status equals: queued testRecipient: '+6281234567890' SmsGatewayRow: type: object required: - key properties: key: type: string maxLength: 200 description: Header name or parameter key. value: type: string description: Value. May contain `{recipient}` or `{message}`. secret: type: boolean description: Store encrypted and mask in responses. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Use a valid Bearer token to authenticate. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.