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

# Get full SMS provider configuration

> Returns every supported SMS provider with its current configuration and enabled state for the org. Requires SUPERADMIN — the body includes raw credentials (Twilio/Sinch/TextGrid keys), so the route is gated. Each entry reports `isConfigured` (credentials present) and `isEnabled` (configured AND not explicitly disabled).



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/sms/providers/config
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/sms/providers/config:
    get:
      tags:
        - SMS
      summary: Get full SMS provider configuration
      description: >-
        Returns every supported SMS provider with its current configuration and
        enabled state for the org. Requires SUPERADMIN — the body includes raw
        credentials (Twilio/Sinch/TextGrid keys), so the route is gated. Each
        entry reports `isConfigured` (credentials present) and `isEnabled`
        (configured AND not explicitly disabled).
      operationId: get_sms_providers_config
      parameters:
        - in: query
          name: organizationId
          required: false
          schema:
            type: string
          description: SUPERADMIN-only override of the target organization.
      responses:
        '200':
          description: SMS provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsProviderConfigResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsErrorResponse'
        '403':
          description: Forbidden (requires SUPERADMIN)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsErrorResponse'
        '500':
          description: Failed to get SMS provider configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    SmsProviderConfigResponse:
      type: object
      description: Response from `GET /api/sms/providers/config`.
      properties:
        activeProvider:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/SmsProviderName'
          description: >-
            Currently-active provider for the org. May be `null` even when
            providers are configured but none has been promoted.
        providers:
          type: array
          items:
            $ref: '#/components/schemas/SmsProviderConfigEntry'
          description: >-
            One entry per supported provider — `twilio`, `sinch`, `textgrid` —
            regardless of whether it is configured. Frontends iterate this list
            to render the settings UI.
      required:
        - providers
      additionalProperties: true
      example:
        activeProvider: twilio
        providers:
          - provider: twilio
            isEnabled: true
            isConfigured: true
            twilioAccountSid: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
            twilioAuthToken: ••••••••••••••••••••••••••••••••
            twilioMessagingServiceSid: MGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          - provider: sinch
            isEnabled: false
            isConfigured: false
          - provider: textgrid
            isEnabled: false
            isConfigured: false
    SmsErrorResponse:
      type: object
      description: Error envelope for `/api/sms/*` endpoints (provider configuration).
      properties:
        error:
          type: string
        message:
          type: string
        success:
          type: boolean
          enum:
            - false
      required:
        - error
      additionalProperties: true
      example:
        error: Provider configuration not found
    SmsProviderName:
      type: string
      enum:
        - twilio
        - sinch
        - textgrid
      description: >-
        Supported SMS providers. `twilio` and `textgrid` use the
        Twilio-compatible REST API; `sinch` uses Sinch Conversation API for SMS
        and a separate MMS service.
      example: twilio
    SmsProviderConfigEntry:
      type: object
      description: >-
        Per-provider configuration row returned by `GET
        /api/sms/providers/config`. Credential fields are present only for
        providers that are configured; absent fields mean the credential was
        never saved (NOT that it is empty-string).
      properties:
        provider:
          $ref: '#/components/schemas/SmsProviderName'
        isEnabled:
          type: boolean
          description: >-
            `true` when the provider has credentials and has not been explicitly
            disabled. Effectively `isConfigured && !disabled`.
        isConfigured:
          type: boolean
          description: >-
            `true` when at least the required credentials for this provider are
            present.
        twilioAccountSid:
          type: string
          description: Twilio Account SID (e.g. `ACxxxxxxxx...`).
        twilioAuthToken:
          type: string
          description: Twilio Auth Token.
        twilioMessagingServiceSid:
          type: string
          description: >-
            Twilio Messaging Service SID (e.g. `MGxxxxxxxx...`). Optional but
            recommended.
        sinchServicePlanId:
          type: string
          description: Sinch Service Plan ID used for SMS.
        sinchApiToken:
          type: string
          description: Sinch SMS API token.
        sinchMmsApiKey:
          type: string
          description: Sinch MMS API key (separate from SMS credentials).
        sinchMmsServiceId:
          type: string
          description: Sinch MMS service identifier.
        textGridAccountSid:
          type: string
          description: TextGrid Account SID.
        textGridAuthToken:
          type: string
          description: TextGrid Auth Token.
      required:
        - provider
        - isEnabled
        - isConfigured
      additionalProperties: true
      example:
        provider: twilio
        isEnabled: true
        isConfigured: true
        twilioAccountSid: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        twilioAuthToken: ••••••••••••••••••••••••••••••••
        twilioMessagingServiceSid: MGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````