> ## Documentation Index
> Fetch the complete documentation index at: https://ownpay.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# List SMS Templates

> Retrieves all SMS parsing templates configured for the brand, sorted by priority and creation date.
These templates define the regex patterns used to match transaction information (like sender address, amount, and reference code) from incoming companion app payloads.




## OpenAPI

````yaml /api/admin_api.yaml get /sms-templates
openapi: 3.1.0
info:
  title: OwnPay Brand Administrative API
  description: >
    The OwnPay Administrative API is used by per-merchant/brand administrators
    to configure and audit their gateway components.

    It exposes endpoints under `/api/admin/v1` to manage regex-based SMS parsing
    templates, inspect and retry failed messages in the outbound SMS
    communication queue, list/revoke paired companion devices, and verify
    white-labeled custom domains.


    ### Authentication

    Administrative endpoints require Bearer authentication using an API key
    generated with the `admin` privilege scope.

    ```http

    Authorization: Bearer <admin_api_key>

    ```

    All actions executed via this API are strictly isolated and scoped to the
    brand/merchant associated with the provided credentials.

    Note that administrative API routes are protected and are **only**
    accessible on the master domain configured via the `APP_DOMAIN` environment
    variable (e.g. `ownpay.org`), and are blocked on custom brand domains.
  version: 1.0.0
servers:
  - url: https://{master_domain}/api/admin/v1
    description: Master administrative API server.
    variables:
      master_domain:
        default: ownpay.org
        description: The APP_DOMAIN host where the administrative panel is accessible.
security:
  - AdminBearerAuth: []
paths:
  /sms-templates:
    get:
      summary: List SMS Templates
      description: >
        Retrieves all SMS parsing templates configured for the brand, sorted by
        priority and creation date.

        These templates define the regex patterns used to match transaction
        information (like sender address, amount, and reference code) from
        incoming companion app payloads.
      operationId: listSmsTemplates
      responses:
        '200':
          description: List of SMS templates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplatesResponse'
components:
  schemas:
    SmsTemplatesResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                example: 3
              merchant_id:
                type: integer
                example: 1
              gateway_slug:
                type: string
                example: bkash-personal
              sender_pattern:
                type: string
                description: Plain pattern matching SMS sender address.
                example: bKash
              amount_regex:
                type: string
                description: Regex pattern containing captures for amount.
                example: received Tk ([0-9,.]+)
              trx_id_regex:
                type: string
                description: Regex pattern containing captures for transaction reference.
                example: TrxID ([A-Z0-9]+)
              sender_regex:
                type: string
                description: Regex pattern containing captures for customer phone.
                example: from ([0-9]+)
              priority:
                type: integer
                example: 1
              status:
                type: string
                enum:
                  - active
                  - inactive
                example: active
              created_at:
                type: string
                format: date-time
                example: '2026-06-23T14:15:45Z'
              updated_at:
                type: string
                format: date-time
                nullable: true
                example: null
  securitySchemes:
    AdminBearerAuth:
      type: http
      scheme: bearer
      description: Enter the Admin scope Bearer API key.

````

## Related topics

- [Admin API Reference - SMS, Domains, and Device Management](/docs/api-reference/admin.md)
- [List Outbound SMS Queue](/docs/api-reference/list-outbound-sms-queue.md)
- [Update SMS Template](/docs/api-reference/update-sms-template.md)
- [SMS Center - Parsing Templates and Auto-Verification](/docs/user-guide/mobile-sms/sms-templates.md)
- [Get Pending Outbound SMS](/docs/api-reference/get-pending-outbound-sms.md)