terragontech/config-ms

By terragontech

•Updated over 7 years ago

Short Code Configuration Microservice

Image

817

Overview Tags

terragontech/config-ms repository overview

⁠Terragon kannel Config Service

⁠The Config Service properly route messages to different application configured on our VAS network operator,

⁠Get API running

python app.py

⁠Get Background running

python q_route.py

⁠Routes

Item	Value
Base	/
Create New Config	/config/create
List Configs	/config/list
Update Config	/config/update/{config_id}
Drop Config	/config/drop/{config_id}
Add Short Code	/config/add/shortcode/{config_id}
Remove Short Code	/config/remove/shortcode/{config_id}
Add Keyword	/config/add/keyword/{config_id}
Remove Keyword	/config/remove/keyword/{config_id}
Add Operator	/config/add/operator/{config_id}
Remove Operator	/config/remove/operator/{config_id}
Add Prefix	/config/add/prefix/{config_id}
Remove Prefix	/config/remove/prefix/{config_id}
update Feedback	/config/feedback/{config_id}
update app_url	/config/appurl/{config_id}

⁠Create New Config


POST {base_url}/config/create

Request parameters:

Parameter	Type	Mandatory	Description
app_url	string	+	Url of intended application to receive the request
operator	string	+	operator attached to the config
keyword	string	-	Keyword attached to the config, set value to defaults if default config
prefix	string	-	prefix attached to the config, this is used for sharing shortcode
shortcode	string	+	Short code attached to config
feedback	integer	-	set to 1 if this config requires users response, default is 0

Sample Response:

{
    "message": "Config successfully created",
    "code": 0,
    "response": {},
    "error": false
}

⁠List Configs


GET {base_url}/config/list

Request parameters:

Parameter	Type	Description
keyword	string	search by keyword
operator	string	search by operator
shortcode	string	search by shortcode

Sample Response:

{
    "message": "Config successfully fetched",
    "code": 200,
    "response": {
        "configs": {
            "total": 2,
            "list": [
                {
                    "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
                    "operator": [
                        "etisalat"
                    ],
                    "config_id": "823456462782",
                    "shortcode": [
                        "30047"
                    ],
                    "keyword": [
                        "stop",
                        "help",
                        "info"
                    ],
                    "feeback":0
                },
                {
                    "app_url": "google.com",
                    "operator": [
                        "etisalat"
                    ],
                    "config_id": "343929085746",
                    "shortcode": [
                        "30047"
                    ],
                    "keyword": [
                        "default"
                    ],
                    "feeback":1
                }
            ]
        }
    },
    "error": false
}

⁠Update Config


PUT /config/update/{config_id}

Request parameters:

Parameter	Type	Mandatory	Description
app_url	string	+	Url of intended application to receive the request
operator	string	+	operator attached to the config
keyword	string		Keyword attached to the config, set value to defaults if default config
shortcode	string	+	Short code attached to config.

Request Json:


{
	"app_url":"http://etisalat.terragonbase.com/api/kannel/request/",
	"operator":["etisalat"],
	"keyword":["stop","help","info"]
}

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Drop Config


DELETE {base_url}/config/drop/{config_id}

Sample Response:

{
    "message": "Config successfully dropped",
    "code": 0,
    "response": {},
    "error": false
}

⁠Add Keyword


PUT {base_url}/config/add/keyword/{config_id}?keyword=help

Request parameters:

Parameter	Type	Mandatory	Description
keyword	string	+	keyword to add to the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Add Shortcode


PUT {base_url}/config/add/shortcode/{config_id}?operator=mtn

Request parameters:

Parameter	Type	Mandatory	Description
operator	string	+	operator to add to the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Add Operator


PUT {base_url}/config/add/operator/{config_id}?operator=mtn

Request parameters:

Parameter	Type	Mandatory	Description
operator	string	+	operator to add to the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Add Prefix


PUT {base_url}/config/add/prefix/{config_id}?keyword=stayon

Request parameters:

Parameter	Type	Mandatory	Description
keyword	string	+	prefix to add to the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "prefix": [
                "stayon"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Remove Keyword


PUT {base_url}/config/remove/shortcode/{config_id}?keyword=help

Request parameters:

Parameter	Type	Mandatory	Description
keyword	string	+	keyword to be remove from the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Remove Operator


PUT {base_url}/config/remove/shortcode/{config_id}?operator=mtn

Request parameters:

Parameter	Type	Mandatory	Description
operator	string	+	operator to be remove from the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Remove Short Code


PUT {base_url}/config/remove/shortcode/{config_id}?code=1115

Request parameters:

Parameter	Type	Mandatory	Description
code	string	+	short code to to be remove from the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Remove Prefix


PUT {base_url}/config/remove/prefix/{config_id}?keyword=stayon

Request parameters:

Parameter	Type	Mandatory	Description
keyword	string	+	keyword to be remove from the config

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "prefix": [
            ],
            "feeback":0
        }
    },
    "error": false
}

⁠Update Feedback


PUT {base_url}/config/feedback/{config_id}?feedback=1

Request parameters:

Parameter	Type	Mandatory	Description
feedback	integer	+	set to 1 or 0

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ],
            "feeback":1
        }
    },
    "error": false
}

⁠Update Application Url


PUT {base_url}/config/appurl/{config_id}?url=http://sampleurl.com

Request parameters:

Parameter	Type	Mandatory	Description
url	string	+	application url

Sample Response:

{
    "message": "Config successfully updated",
    "code": 200,
    "response": {
        "config": {
            "app_url": "http://etisalat.terragonbase.com/api/kannel/request/",
            "operator": [
                "etisalat"
            ],
            "config_id": "823456462782",
            "shortcode": [
                "30047",
                "1115"
            ],
            "keyword": [
                "stop",
                "help",
                "info"
            ]
        }
    },
    "error": false
}

⁠Incoming Request

GET {base_url}/request/incoming?msisdn={msisdn}&operator={operator}&message={message}&shortcode={shortcode}

Request parameters Received:

Parameter	Type	Mandatory	Description
msisdn	string	+	msisdn sending the request
operator	string	+	operator receiving the request
message	string	+	message sent by the user
shortcode	string	+	Short code receiving the request
time	string		time the request was sent in date-string.

Request Sent to Application:

Parameter	Type	Mandatory	Description
msisdn	string	+	msisdn sending the request
operator	string	+	operator receiving the request
message	string	+	message sent by the user
shortcode	string	+	Short code receiving the request
time	string		time the request was sent in date-string.
session_id	string	+	session_id for tracking conversation.

See API documentation in Postman collection. https://www.getpostman.com/collections/92dffc4bb1f81974a23d⁠

⁠Environment Variables to set

Item	Value
APP_PORT	Port for app to run on
ELASTICSEARCH_HOST	Elasticsearch host
ELASTICSEARCH_PORT	Elasticsearch Port Number
REDIS_HOST	Redis host
REDIS_PORT	Redis Port Number
REDIS_PASS	Redis password Number
REDIS_DB	Redis db
RABBITMQ_HOST	Rabbitmq host
RABBITMQ_PORT	Rabbitmq Port Number
RABBITMQ_USERNAME	Rabbitmq username
RABBITMQ_PASSWORD	Rabbitmq password

Tag summary

Recent tags

Content type

Image

Digest

Size

86.2 MB

Last updated

over 7 years ago

docker pull terragontech/config-ms