---
title: "Send test sms (sendTestSms)"
method: POST
path: "/api/admin/settings/testSms"
tags: ["admin-controller"]
---

# Send test sms (sendTestSms)

`POST /api/admin/settings/testSms`

Attempts to send test sms to the System Administrator User using SMS Settings and phone number provided as a parameters of the request. 

Available for users with 'SYS_ADMIN' authority.

## Request body

- TestSmsRequest — A JSON value representing the Test SMS request.
  - `providerConfiguration` union — The SMS provider configuration
    - AwsSnsSmsProviderConfiguration
      - `type` string, required
      - `accessKeyId` string — The AWS SNS Access Key ID.
      - `secretAccessKey` string — The AWS SNS Access Key.
      - `region` string — The AWS region.
    - SmppSmsProviderConfiguration
      - `type` string, required
      - `protocolVersion` '3.3, 3.4', required — SMPP version
      - `host` string, required — SMPP host
      - `port` integer, required — SMPP port
      - `systemId` string, required — System ID
      - `password` string, required — Password
      - `systemType` string — System type
      - `bindType` 'TX' | 'RX' | 'TRX' — TX - Transmitter, RX - Receiver, TRX - Transciever. By default TX is used
      - `serviceType` string — Service type
      - `sourceAddress` string — Source address
      - `sourceTon` string, byte — Source TON (Type of Number). Needed is source address is set. 5 by default. 0 - Unknown 1 - International 2 - National 3 - Network Specific 4 - Subscriber Number 5 - Alphanumeric 6 - Abbreviated
      - `sourceNpi` string, byte — Source NPI (Numbering Plan Identification). Needed is source address is set. 0 by default. 0 - Unknown 1 - ISDN/telephone numbering plan (E163/E164) 3 - Data numbering plan (X.121) 4 - Telex numbering plan (F.69) 6 - Land Mobile (E.212) =6 8 - National numbering plan 9 - Private numbering plan 10 - ERMES numbering plan (ETSI DE/PS 3 01-3) 13 - Internet (IP) 18 - WAP Client Id (to be defined by WAP Forum)
      - `destinationTon` string, byte — Destination TON (Type of Number). 5 by default. 0 - Unknown 1 - International 2 - National 3 - Network Specific 4 - Subscriber Number 5 - Alphanumeric 6 - Abbreviated
      - `destinationNpi` string, byte — Destination NPI (Numbering Plan Identification). 0 by default. 0 - Unknown 1 - ISDN/telephone numbering plan (E163/E164) 3 - Data numbering plan (X.121) 4 - Telex numbering plan (F.69) 6 - Land Mobile (E.212) =6 8 - National numbering plan 9 - Private numbering plan 10 - ERMES numbering plan (ETSI DE/PS 3 01-3) 13 - Internet (IP) 18 - WAP Client Id (to be defined by WAP Forum)
      - `addressRange` string — Address range
      - `codingScheme` '0-10' | '13-14', byte — 0 - SMSC Default Alphabet (ASCII for short and long code and to GSM for toll-free, used as default) 1 - IA5 (ASCII for short and long code, Latin 9 for toll-free (ISO-8859-9)) 2 - Octet Unspecified (8-bit binary) 3 - Latin 1 (ISO-8859-1) 4 - Octet Unspecified (8-bit binary) 5 - JIS (X 0208-1990) 6 - Cyrillic (ISO-8859-5) 7 - Latin/Hebrew (ISO-8859-8) 8 - UCS2/UTF-16 (ISO/IEC-10646) 9 - Pictogram Encoding 10 - Music Codes (ISO-2022-JP) 13 - Extended Kanji JIS (X 0212-1990) 14 - Korean Graphic Character Set (KS C 5601/KS X 1001)
    - TwilioSmsProviderConfiguration
      - `type` string, required
      - `accountSid` string — Twilio account Sid.
      - `accountToken` string — Twilio account Token.
      - `numberFrom` string — The number/id of a sender.
  - `numberTo` string — The phone number or other identifier to specify as a recipient of the SMS.
  - `message` string — The test message

## Response `200`

OK

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)