UtilitiesWi-Fi

testSiteWlanTelstraSetup

POST
/api/v1/utils/test_telstra

Allows validation of Telstra sms gateway credentials.

In case of success, a text message confirming successful setup should be received. In case of error, telstra error message are returned.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Request Body

application/json

Request body for validating Telstra SMS gateway credentials

telstra_client_id*string

Telstra client identifier used to send the test SMS

telstra_client_secret*string

Telstra client secret used to send the test SMS

Formatpassword
to*string

Phone number of the recipient of SMS with country code

Response Body

curl -X POST "https://example.com/api/v1/utils/test_telstra" \  -H "Content-Type: application/json" \  -d '{    "telstra_client_id": "123456",    "telstra_client_secret": "abcdef",    "to": "+911122334455"  }'
Empty