Cyta Web SMS Api Client

An API client for Cyta Web SMS in PHP
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

A simple api client for PHP applications where you can easily call a function to send sms through the Cyta Web SMS Platform and receive it's status code

Sample Interface

(back to top)

Built With

• PHP

(back to top)

Getting Started

Obtaining Web Sms Api Keys

Login to MyCyta and visit https://www.cyta.com.cy/web-sms-api/. Enable the api and copy username and secret key. Then open configuration.php in client and enter details

$websmsapi_config = array(
    "version" => "1.0",
    "username" => "ENTER_USERNAME_HERE", //Enter Cyta Web Sms Sender Username
    "apiKey" => "xxxxxxxxxxxxxxxxx", // Enter Cyta Web Sms Sender Api Key 
    "language" => "el"
);

(back to top)

Usage

Include the client

require 'CLIENT_LOCATION/cytawebsmsapi-client/client/client.php';

Call the cytawebsms_create_request function and define recipients(array) & message(string)

cytawebsms_create_request($recipients, $message);

The client will return an array in this format e.g. success example

array(
        "api_success" => true,
        "status_message" => "Send Sms success",
        "status_code" => "0",
        "lot" => "XXXXXXXXXX"
);

For more examples, please refer to the Documentation

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Dimitris T - [email protected]

Project Link: https://github.com/dimitrist19/cytawebsmsapi-client

(back to top)