Welcome to the API documentation for the itGuide Self-Care public APIs. This documentation will provide you with details on how to access and utilize the available endpoints to manage user information and send SMS messages. All responses from these APIs will be in JSON format.
-
New API
Endpoint
A brief description of the new API endpoint.
Base URL:
https://selfcare.itguidebd.com/public_api/
Endpoint:
smsApi?type=someType
Method: GET/ POST
URL:
base_url/smsApi?type=someType&apiKey=your_api_key
Parameters:
type
: masking, nonMasking, balanceapiKey
: Your API key (string)
https://selfcare.itguidebd.com/public_api/smsApi?type=someType&apiKey=xxxxxxxxxxxx
-
SMS
API Masking
Send an SMS message using masking.
Endpoint:
smsApi?type=masking
Method: POST
URL:
base_url/smsApi?type=masking&apiKey=your_api_key&mobileNo=recipient_number&smsContent=message_content
Parameters:
apiKey
: Your API key (string)mobileNo
: Recipient's mobile number (string)smsContent
: Content of the SMS message (string)
https://selfcare.itguidebd.com/public_api/smsApi?type=masking&apiKey=xxxxxxxxxxxx&mobileNo=xxxxxxxx&smsContent=xxxxxxxxxx
-
SMS API
Non-Masking
Send an SMS message without masking.
Endpoint:
smsApi?type=nonMasking
Method: POST
URL:
base_url/smsApi?type=nonMasking&apiKey=your_api_key&mobileNo=recipient_number&smsContent=message_content
Parameters:
apiKey
: Your API key (string)mobileNo
: Recipient's mobile number (string)smsContent
: Content of the SMS message (string)
https://selfcare.itguidebd.com/public_api/smsApi?type=nonMasking&apiKey=xxxxxxxxxxxx&mobileNo=xxxxxxxx&smsContent=xxxxxxxxxx
-
SMS API
Balance Check
Retrieve SMS balance information.
Endpoint:
smsApi?type=balance
Method: GET
URL:
base_url/smsApi?type=balance&apiKey=your_api_key
Parameters:
apiKey
: Your API key (string)
https://selfcare.itguidebd.com/public_api/smsApi?type=balance&apiKey=xxxxxxxxxxxx
-
Response
Format
All responses from the APIs will be in JSON format.
Example Response:
{ "status": "success", "message": "SMS sent successfully." }
{ "status": "success", "message": "Balance retrieved successfully.", "masking": "450", "non-masking": "500" }
Error Handling
In case of errors, the API will return a response in the following format:
{ "status": "error", "message": "An error occurred while processing your request." }
{ "status": "error", "message": "An error occurred while checking the balance." }
Please make sure to handle potential errors appropriately based on the response status and message.
* For more detailed information, you can visit the itGuideAPI GitHub Repository.
* If you have any questions or encounter any issues, please don't hesitate to reach out to our support team at info@itguidebd.com.