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

# Get Sms Config

> Get the SmsConfig settings for Customer Service sms providers.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-CustomerServiceAgent.json post /api/v1/Agents/CustomerService/GetSmsConfig
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - CustomerServiceAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/CustomerService/GetSmsConfig:
    post:
      tags:
        - CustomerService_Agent
      summary: Get Sms Config
      description: |-
        Get the SmsConfig settings for Customer Service sms providers.

        NsApiSlow threshold: 5000 ms.
      operationId: v1CustomerServiceAgent_GetSmsConfig
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.SmsConfig'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.SmsConfig'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.SmsConfig'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.SmsConfig'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.SmsConfig'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.SmsConfig'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.SmsConfig:
      description: "Sms settings for Customer Service sms providers.\r\n<para />\r\nCarrier object for SmsConfig.\r\nServices for the SmsConfig Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ICustomerServiceAgent\">CustomerService Agent</see>."
      type: object
      properties:
        DefaultSmsCountry:
          description: Phone prefix, will default to the current users HomeCountryId.
          type: string
        NetServerSmsProvider:
          description: >-
            Name of the selected provider, i.e. CM, Compaya SMS (cpsms.dk),
            Intelecom SMS, PSWinCom SMS, SMS Teknik or TXTLocal.
          type: string
        NsPluginSender:
          description: >-
            The sender of the SMS messages. This text will appear on the
            recipient's mobile phone.
          type: string
        NsPluginConfig:
          description: >-
            Configuration settings provided by the SMS provider. Typically
            contains newline-delimited settings such as username and password.
          type: object
          additionalProperties:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.CustomerService GetSmsConfigRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CustomerService_GetSmsConfigRequest.md)
- [NSCustomerServiceAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSCustomerServiceAgent.md)
- [SuperOffice.WebApi.Agents.ICustomerServiceAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ICustomerServiceAgent.md)
- [SuperOffice.WebApi.Agents.CustomerServiceAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.CustomerServiceAgent.md)
- [NSSmsConfig](/en/automation/crmscript/reference/CRMScript.NetServer.NSSmsConfig.md)
- [Configure outgoing SMS connector](/en/marketing/sms/it/set-up.md)