# KECCEL MESSAGING
Keccel Service Manager is a very simple but powerful SMS Gateway built for developers who just want to send SMS in the
DR Congo at a very affordable cost. Both requests and responses are transmitted in JSON format.
## SENDING AN SMS
Method: POST
URL: https://api.keccel.com/sms/v2/message.asp
| Request Parameter | Description | Example |
| ----------- | --------- | ---------- |
| to | Receiver phone number | 243851234567 |
| message | Message body | Hello world |
| from | Name that will appear on the phone as the sender of the SMS | KECCEL, GUEST |
| token | Your API key that will be provided by Keccel | 84hbYi6TU8Zu |
All parameters are mandatory.
Note: In GUEST or trial modes, the SMS will be displayed as coming from KECCEL. In production, you need to provide an
appropriate name to use as the sender of the SMS, such as the name of your application or your company.
| Response Parameter | Description | Example |
| ----------- | --------- | ---------- |
| status | Status of the message | Rejected, Sent |
| messageID | The ID of the sent message | 123456 (used for Delivery Receipt) |
| description | A string describing the status or error | Invalid token, Message submitted to the network |
Example Request
```json
{
"token":"84hbYi6TU8Zu",
"to":"243851234567",
"from":"GUEST",
"message":"Hello World"
}
```
Response Delivery Report
```json
{
"status": "SENT",
"messageID": "123456",
"description": "Message submitted to the network"
}
```
## DELIVERY REPORTS
This service allows you to receive the delivery status of a previous sent message. There is NO delivery report for rejected
messages. The delivery can be automatically sent to your callback (PUSH) or you can retrieve it (PULL) from our server.
### PUSH: Automatic Delivery
If the Delivery Reports (DLR) are required, you need to provide a callback URL where an automatic HTTP request will be
sent with the previous messageID and the delivery status of the message (DELIVERED or FAILED).
The DLR receipt will be sent to your URL as below:
http(s)://yourcallbackurl?messageID=123456&status=DELIVERED
### PULL: Delivery Check
You can also send a request to our delivery endpoint to check on the delivery status of a previous sent message:
Method: GET
URL: https://api.keccel.com/sms/v2/delivery.asp
| Request Parameter | Description | Example |
| ----------- | --------- | ---------- |
| from | Name that will appear on the phone as the sender of the SMS | KECCEL, GUEST |
| token | Your API key that will be provided by Keccel | 84hbYi6TU8Zu |
| messageid | The ID of the message which status is requested | 123456 |
| Response Parameter | Description | Example |
| ----------- | --------- | ---------- |
| messageid | The messageID value as requested | 123456 |
| status | Status of the message | DELIVERED, FAILED (or Error |
## BALANCE CHECK
This request is used to get the amount of the remaining SMS credits and the expiration date of a designated account.
Method: GET
URL: https://api.keccel.com/sms/v2/balance.asp
| Request Parameter | Description | Example |
| ----------- | --------- | ---------- |
| from | Name that will appear on the phone as the sender of the SMS | KECCEL, GUEST |
| token | Your API key that will be provided by Keccel | 84hbYi6TU8Zu |
| Response Parameter | Description | Example |
| ----------- | --------- | ---------- |
| balance | Number of remaining credits | 645 |
| expiration | Expiration. No SMS will be sent after this date and time | 31-Dec-2021 06:46:17 |
| status | Status of the account | Active, inactive |
Raw data
{
"_id": null,
"home_page": "https://github.com/TralahM/pykeccelsms",
"name": "pykeccelsms",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tralah M Brian",
"author_email": "briantralah@gmail.com",
"download_url": "",
"platform": null,
"description": "# KECCEL MESSAGING\nKeccel Service Manager is a very simple but powerful SMS Gateway built for developers who just want to send SMS in the\nDR Congo at a very affordable cost. Both requests and responses are transmitted in JSON format.\n\n## SENDING AN SMS\nMethod: POST\n\nURL: https://api.keccel.com/sms/v2/message.asp\n\n| Request Parameter | Description | Example |\n| ----------- | --------- | ---------- |\n| to | Receiver phone number | 243851234567 |\n| message | Message body | Hello world |\n| from | Name that will appear on the phone as the sender of the SMS | KECCEL, GUEST |\n| token | Your API key that will be provided by Keccel | 84hbYi6TU8Zu |\n\nAll parameters are mandatory.\n\nNote: In GUEST or trial modes, the SMS will be displayed as coming from KECCEL. In production, you need to provide an\nappropriate name to use as the sender of the SMS, such as the name of your application or your company.\n\n| Response Parameter | Description | Example |\n| ----------- | --------- | ---------- |\n| status | Status of the message | Rejected, Sent |\n| messageID | The ID of the sent message | 123456 (used for Delivery Receipt) |\n| description | A string describing the status or error | Invalid token, Message submitted to the network |\n\nExample Request\n\n```json\n{\n \"token\":\"84hbYi6TU8Zu\",\n \"to\":\"243851234567\",\n \"from\":\"GUEST\",\n \"message\":\"Hello World\"\n}\n```\n\nResponse Delivery Report\n\n```json\n{\n \"status\": \"SENT\",\n \"messageID\": \"123456\",\n \"description\": \"Message submitted to the network\"\n}\n```\n\n## DELIVERY REPORTS\nThis service allows you to receive the delivery status of a previous sent message. There is NO delivery report for rejected\nmessages. The delivery can be automatically sent to your callback (PUSH) or you can retrieve it (PULL) from our server.\n\n### PUSH: Automatic Delivery\nIf the Delivery Reports (DLR) are required, you need to provide a callback URL where an automatic HTTP request will be\nsent with the previous messageID and the delivery status of the message (DELIVERED or FAILED).\nThe DLR receipt will be sent to your URL as below:\nhttp(s)://yourcallbackurl?messageID=123456&status=DELIVERED\n\n### PULL: Delivery Check\nYou can also send a request to our delivery endpoint to check on the delivery status of a previous sent message:\nMethod: GET\n\nURL: https://api.keccel.com/sms/v2/delivery.asp\n\n| Request Parameter | Description | Example |\n| ----------- | --------- | ---------- |\n| from | Name that will appear on the phone as the sender of the SMS | KECCEL, GUEST |\n| token | Your API key that will be provided by Keccel | 84hbYi6TU8Zu |\n| messageid | The ID of the message which status is requested | 123456 |\n\n| Response Parameter | Description | Example |\n| ----------- | --------- | ---------- |\n| messageid | The messageID value as requested | 123456 |\n| status | Status of the message | DELIVERED, FAILED (or Error |\n\n## BALANCE CHECK\nThis request is used to get the amount of the remaining SMS credits and the expiration date of a designated account.\nMethod: GET\n\nURL: https://api.keccel.com/sms/v2/balance.asp\n\n| Request Parameter | Description | Example |\n| ----------- | --------- | ---------- |\n| from | Name that will appear on the phone as the sender of the SMS | KECCEL, GUEST |\n| token | Your API key that will be provided by Keccel | 84hbYi6TU8Zu |\n\n\n| Response Parameter | Description | Example |\n| ----------- | --------- | ---------- |\n| balance | Number of remaining credits | 645 |\n| expiration | Expiration. No SMS will be sent after this date and time | 31-Dec-2021 06:46:17 |\n| status | Status of the account | Active, inactive |\n",
"bugtrack_url": null,
"license": "GPLV3",
"summary": "A Python SDK for the Keccel Messaging API for sms in the DRC.",
"version": "0.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b041b4057393e7fcc5e96e124e3315b99a0cf5cbf839afa5200a8b3a4e7ce65b",
"md5": "b21b165fa35a839b1f5af1ec35e42121",
"sha256": "a481c98130433af1a32055e4deb1c37be208df12ff9e5ec7ba174a9f1e003029"
},
"downloads": -1,
"filename": "pykeccelsms-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b21b165fa35a839b1f5af1ec35e42121",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4232,
"upload_time": "2023-01-03T22:08:48",
"upload_time_iso_8601": "2023-01-03T22:08:48.678826Z",
"url": "https://files.pythonhosted.org/packages/b0/41/b4057393e7fcc5e96e124e3315b99a0cf5cbf839afa5200a8b3a4e7ce65b/pykeccelsms-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-03 22:08:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "TralahM",
"github_project": "pykeccelsms",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pykeccelsms"
}
JSON
