14.1.1.24. SMS Gateway endpoints

This endpoint is used to create, modify, list and delete SMS gateway definitions. These gateway definitions are written to the database table “smsgateway” and “smsgatewayoption”.

The code of this module is tested in tests/test_api_smsgateway.py

GET /smsgateway/(gwid)
GET /smsgateway/

returns a json list of the gateway definitions

Or

returns a list of available sms providers with their configuration /smsgateway/providers

POST /smsgateway

This creates a new SMS gateway definition or updates an existing one.

JSON Parameters:

  • name – The unique identifier of the SMS gateway definition

  • module – The providermodule name

  • description – An optional description of the definition

  • option.* – Additional options for the provider module (module specific)

  • header.* – Additional headers for the provider module (module specific)

DELETE /smsgateway/(identifier)

this function deletes an existing smsgateway definition

Parameters:

  • identifier – The name of the sms gateway definition

Return:

json with success or fail

DELETE /smsgateway/option/(gwid)/(key)

this function deletes an option of a gateway definition

Parameters:

  • gwid – The id of the sms gateway definition

Return:

json with success or fail