Introduction
API Documentation
This documentation provides comprehensive information for developers looking to integrate with our SMS messaging API. Before using the API, you must create an account to obtain your credentials (username and password). Here, you'll find everything you need to understand the API's capabilities, including endpoints, request and response formats, authentication methods, and more.
Send SMS Message API
Endpoint
POST /v1/sms/send
Description
This endpoint allows you to send SMS messages to multiple recipients. Users can provide their credentials via URL parameters or form parameters.
Authentication
Credentials
Users must provide the following credentials for authentication:
- Username (string): Your username for authentication.
- Password (string): Your password for authentication.
Credentials can be passed either as URL parameters or form parameters.
Request Parameters
Body Parameters
Parameter | Type | Required | Description |
---|---|---|---|
numbers |
string | Yes | The phone numbers to send the message to. Comma separated. Example: 0701234567, 0712345678 |
message_body |
string | Yes | The content of the message to be sent. Example: "Hello, this is a test message." |
username |
string | Yes | Your username for authentication. Example: "user123" |
password |
string | Yes | Your password for authentication. Example: "pass123" |
Responses
Success Response
200 OK
{ "message": "Message Sent Successfully." }
400 Bad Request
{ "error": "Invalid phone number format." }
401 Unauthorized
{ "error": "Unauthorized." }
Explanation of Sections
- Endpoint: Specifies the URL and method used to access the API.
- Description: Provides a brief overview of what the endpoint does.
- Authentication: Details the credentials needed for access.
- Request Parameters: Lists the body parameters that can be sent with the request, including their types and descriptions.
- Responses: Describes the possible responses, including success and error responses with example JSON outputs.
- Notes: Additional information relevant to the API usage.