UtilitiesWi-Fi

testSiteWlanSmsGlobal

POST
/api/v1/utils/test_smsglobal

Allows validation of Global sms gateway credentials.

In case of success, a text message confirming successful setup should be received. In case of error, smsglobal 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 SMSGlobal SMS gateway credentials

smsglobal_api_key*string

SMSGlobal API key used to send the test SMS

smsglobal_api_secret*string

SMSGlobal API secret used to send the test SMS

Formatpassword
smsglobal_sender?string

Optional sender's number or sender ID. If not provided, uses the default number associated with the account

to*string

Phone number of the recipient of SMS with country code

Response Body

curl -X POST "https://example.com/api/v1/utils/test_smsglobal" \  -H "Content-Type: application/json" \  -d '{    "smsglobal_api_key": "123456",    "smsglobal_api_secret": "abcdef",    "smsglobal_sender": "61400000002",    "to": "+911122334455"  }'
Empty